community.docker.docker_volume – Управление томами Docker

Примечание

Этот плагин входит в коллекцию community.docker (версия 1.1.0).

Для его установки используйте: ansible-galaxy collection install community.docker.

Для использования в плейбуке укажите: community.docker.docker_volume.

Описание
Требования
Параметры
Примечания
Примеры
Значения возврата

Описание

Создание/удаление томов Docker.
В значительной степени выполняет ту же функцию, что и подкоманда «docker volume» CLI.

Требования

Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.

Docker SDK для Python: Обратите внимание, что модуль Python docker-py был заменен на docker (см. здесь для подробностей). Для Python 2.6 необходимо использовать docker-py. В противном случае рекомендуется установить модуль Python docker. Обратите внимание, что оба модуля не должны устанавливаться одновременно. Также обратите внимание, что при установке обоих модулей и удалении одного из них другой может перестать работать, и потребуется его повторная установка.
Docker SDK для Python >= 1.10.0 (используйте docker-py для Python 2.6)
Сервер Docker >= 1.9.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_version строка	По умолчанию: "auto"	Версия API Docker, работающего на хосте Docker. По умолчанию используется последняя версия API, поддерживаемая Docker SDK для Python и демоном Docker. Если значение не указано в задаче, используется значение переменной окружения `DOCKER_API_VERSION`. Если переменная окружения не задана, используется значение по умолчанию. алиасы: docker_api_version
ca_cert путь		Используйте сертификат CA при проверке сервера, указав путь к файлу сертификата CA. Если значение не указано в задаче, и переменная окружения `DOCKER_CERT_PATH` задана, используется файл `ca.pem` из каталога, указанного в переменной окружения `DOCKER_CERT_PATH`. алиасы: tls_ca_cert, cacert_path
client_cert путь		Путь к файлу сертификата TLS клиента. Если значение не указано в задаче, и переменная окружения `DOCKER_CERT_PATH` задана, используется файл `cert.pem` из каталога, указанного в переменной окружения `DOCKER_CERT_PATH`. алиасы: tls_client_cert, cert_path
client_key путь		Путь к файлу ключа TLS клиента. Если значение не указано в задаче, и переменная окружения `DOCKER_CERT_PATH` задана, используется файл `key.pem` из каталога, указанного в переменной окружения `DOCKER_CERT_PATH`. алиасы: tls_client_key, key_path
debug логический	Варианты: нет ← да	Режим отладки
docker_host строка	По умолчанию: "unix://var/run/docker.sock"	URL или путь к сокету Unix, используемый для подключения к API Docker. Для подключения к удалённому хосту, укажите строку TCP-соединения. Например, `tcp://192.0.2.23:2376`. Если для шифрования соединения используется TLS, модуль автоматически заменит `tcp` в URL соединения на `https`. Если значение не указано в задаче, используется значение переменной окружения `DOCKER_HOST`. Если переменная окружения не задана, используется значение по умолчанию. алиасы: docker_url
driver строка	По умолчанию: "local"	Укажите тип тома. Docker предоставляет драйвер `local`, но также можно использовать драйверы сторонних разработчиков.
driver_options словарь		Словарь параметров настроек тома. Обратитесь к документации Docker для допустимых параметров и значений: https://docs.docker.com/engine/reference/commandline/volume_create/#driver-specific-options
labels словарь		Словарь пар ключ/значение меток для задания тома
recreate строка	Варианты: всегда никогда ← измененные-параметры	Управляет тем, когда том будет пересоздан, когда состояние state равно `present`. Обратите внимание, что пересоздание существующего тома приведёт к потере всех данных в существующем томе! Том будет удалён, и будет создан новый том с тем же именем. Значение `always` принудительно пересоздаёт том. Значение `never` гарантирует, что том не будет пересоздан. Значение `options-changed` гарантирует пересоздание тома, если он уже существует, и драйвер, параметры драйвера или метки отличаются.
ssl_version строка		Укажите допустимое числовое значение версии SSL. Значение по умолчанию определяется модулем ssl.py. Если значение не указано в задаче, используется значение переменной окружения `DOCKER_SSL_VERSION`.
state строка	Варианты: отсутствует существует ←	`absent` удаляет том. `present` создаёт том, если он ещё не существует.
timeout целое число	По умолчанию: 60	Максимальное время в секундах ожидания ответа от API. Если значение не указано в задаче, используется значение переменной окружения `DOCKER_TIMEOUT` вместо него. Если переменная окружения не задана, используется значение по умолчанию.
tls логический	Варианты: нет ← да	Обеспечение безопасности соединения с API с помощью TLS без проверки подлинности сервера Docker. Обратите внимание, что если validate_certs также установлено в `yes`, это значение будет иметь приоритет. Если значение не указано в задаче, используется значение переменной окружения `DOCKER_TLS` вместо него. Если переменная окружения не задана, используется значение по умолчанию.
tls_hostname строка	По умолчанию: "localhost"	При проверке подлинности сервера Docker укажите ожидаемое имя сервера. Если значение не указано в задаче, используется значение переменной окружения `DOCKER_TLS_HOSTNAME` вместо него. Если переменная окружения не задана, используется значение по умолчанию.
validate_certs логический	Варианты: нет ← да	Обеспечение безопасности соединения с API с помощью TLS и проверка подлинности сервера Docker. Если значение не указано в задаче, используется значение переменной окружения `DOCKER_TLS_VERIFY` вместо него. Если переменная окружения не задана, используется значение по умолчанию. алиасы: tls_verify
volume_name строка / требуется		Имя тома, над которым необходимо выполнить операцию. алиасы: name

Примечания

Примечание

Подключение к демону Docker, предоставление параметров с каждой задачей или определение переменных окружения. Вы можете определить DOCKER_HOST, DOCKER_TLS_HOSTNAME, DOCKER_API_VERSION, DOCKER_CERT_PATH, DOCKER_SSL_VERSION, DOCKER_TLS, DOCKER_TLS_VERIFY и DOCKER_TIMEOUT. Если вы используете docker machine, запустите предоставленный в продукте скрипт, который устанавливает среду. Он установит эти переменные за вас. Подробнее см. https://docs.docker.com/machine/reference/env/.
При подключении к демону Docker с TLS, возможно, потребуется установить дополнительные пакеты Python. Для Docker SDK для Python версии 2.4 или более поздней это можно сделать, установив docker[tls] с помощью ansible.builtin.pip.
Обратите внимание, что Docker SDK для Python позволяет указать путь к конфигурации Docker только для очень немногих функций. В целом, он будет использовать $HOME/.docker/config.json, если переменная окружения DOCKER_CONFIG не указана, и использовать $DOCKER_CONFIG/config.json в противном случае.
Этот модуль использует Docker SDK для Python для взаимодействия с демоном Docker.

Примеры

- name: Create a volume
  community.docker.docker_volume:
    name: volume_one

- name: Remove a volume
  community.docker.docker_volume:
    name: volume_one
    state: absent

- name: Create a volume with options
  community.docker.docker_volume:
    name: volume_two
    driver_options:
      type: btrfs
      device: /dev/sda2

Значения возврата

Общие значения возвращаемых данных описаны здесь, ниже приведены поля, уникальные для данного модуля:

Ключ	Возвращаемое	Описание
volume словарь	успех	Результаты проверки объема для затронутого объема.

Авторы

Alex Grönholm (@agronholm)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/docker/docker_volume_module.html