docker_volume - Управление Docker-томами

Новое в версии 2.4.

Обзор
- Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
Техническое обслуживание
- Автор

Обзор

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

Требования

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

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_version	Значение по умолчанию: "auto"	Версия Docker API, работающая на хосте Docker. По умолчанию используется последняя версия API, поддерживаемая docker-py. Если значение не указано в задаче, будет использовано значение переменной среды `DOCKER_API_VERSION`. Если переменная среды не установлена, будет использовано значение по умолчанию. псевдонимы: docker_api_version
cacert_path		Используйте сертификат CA при проверке сервера, указав путь к файлу сертификата CA. Если значение не указано в задаче и переменная среды `DOCKER_CERT_PATH` установлена, будет использован файл `ca.pem` из каталога, указанного в переменной среды `DOCKER_CERT_PATH`. псевдонимы: tls_ca_cert
cert_path		Путь к файлу TLS-сертификата клиента. Если значение не указано в задаче и переменная среды `DOCKER_CERT_PATH` установлена, будет использован файл `cert.pem` из каталога, указанного в переменной среды `DOCKER_CERT_PATH`. псевдонимы: tls_client_cert
debug bool	Варианты: нет ← да	Режим отладки
docker_host	Значение по умолчанию: "unix://var/run/docker.sock"	URL или путь к Unix-сокету, используемый для подключения к Docker API. Для подключения к удалённому хосту укажите строку 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
force bool	Варианты: нет ← да	Состояние `present` приводит к удалению и повторному созданию тома, если том уже существует и драйвер, параметры драйвера или метки отличаются. Это приведёт к потере любых данных в существующем томе.
key_path		Путь к файлу TLS-ключа клиента. Если значение не указано в задаче и переменная среды `DOCKER_CERT_PATH` установлена, будет использован файл `key.pem` из каталога, указанного в переменной среды `DOCKER_CERT_PATH`. псевдонимы: tls_client_key
labels		Список меток для задания тома
name необходимо		Имя тома для обработки. псевдонимы: volume_name
ssl_version		Укажите действительный номер версии SSL. Значение по умолчанию определяется модулем ssl.py. Если значение не указано в задаче, будет использовано значение переменной среды `DOCKER_SSL_VERSION`.
state	Варианты: отсутствует присутствует ←	`absent` удаляет том. `present` создаёт том, если он ещё не существует.
timeout	Значение по умолчанию: 60	Максимальное время в секундах ожидания ответа от API. Если значение не указано в задаче, будет использовано значение переменной среды `DOCKER_TIMEOUT`. Если переменная среды не установлена, будет использовано значение по умолчанию.
tls bool	Варианты: нет ← да	Обеспечение безопасности соединения с API с помощью TLS без проверки подлинности хоста Docker. Если значение не указано в задаче, будет использовано значение переменной среды `DOCKER_TLS`. Если переменная среды не установлена, будет использовано значение по умолчанию.
tls_hostname	Значение по умолчанию: "localhost"	При проверке подлинности хоста Docker укажите ожидаемое имя сервера. Если значение не указано в задаче, будет использовано значение переменной среды `DOCKER_TLS_HOSTNAME`. Если переменная среды не установлена, будет использовано значение по умолчанию.
tls_verify bool	Варианты: нет ← да	Обеспечение безопасности соединения с API с помощью TLS и проверка подлинности хоста Docker. Если значение не указано в задаче, будет использовано значение переменной среды `DOCKER_TLS_VERIFY`. Если переменная среды не установлена, будет использовано значение по умолчанию.

Примечания

Примечание

Подключитесь к демону 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://docker-py.readthedocs.org/en/stable/machine/.

Примеры

- name: Create a volume
  docker_volume:
    name: volume_one

- name: Remove a volume
  docker_volume:
    name: volume_one
    state: absent

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

Возвращаемые значения

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

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

Статус

Этот модуль помечен как предварительный просмотр, что означает, что он не гарантирует обратную совместимость интерфейса.

Техническое обслуживание

Этот модуль помечен как сообщество, что означает, что его поддерживает сообщество Ansible. Дополнительную информацию см. в Поддержка и обслуживание модулей.

Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.

Автор

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.6/modules/docker_volume_module.html