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

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

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

Обзор

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

Требования

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

python >= 2.6
docker-py >= 1.10.0
Сервер Docker >= 1.9.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_version	Значение по умолчанию: значение по умолчанию, предоставляемое docker-py	Версия API Docker, работающего на хосте Docker. По умолчанию используется последняя версия API, поддерживаемая docker-py. Псевдонимы: docker_api_version
cacert_path	Значение по умолчанию: None	Использование сертификата CA при проверке подлинности сервера путем указания пути к файлу сертификата CA. Псевдонимы: tls_ca_cert
cert_path	Значение по умолчанию: None	Путь к файлу TLS-сертификата клиента. Псевдонимы: tls_client_cert
docker_host	Значение по умолчанию: unix://var/run/docker.sock	URL или путь к Unix-сокету, используемые для подключения к API Docker. Для подключения к удаленному хосту укажите строку TCP-соединения. Например, 'tcp://192.0.2.23:2376'. Если для шифрования соединения используется TLS, модуль автоматически заменит 'tcp' в URL соединения на 'https'. Псевдонимы: docker_url
driver	Значение по умолчанию: local	Укажите тип тома. Docker предоставляет драйвер `local`, но также могут использоваться драйверы сторонних разработчиков.
driver_options		Словарь настроек тома. Обратитесь к документации Docker за допустимыми параметрами и значениями: https://docs.docker.com/engine/reference/commandline/volume_create/#driver-specific-options
force	Варианты: нет ← да	При состоянии `present` том будет удален и пересоздан, если том уже существует, а драйвер, параметры драйвера или метки отличаются. Это приведет к потере любых данных в существующем томе.
key_path	Значение по умолчанию: None	Путь к файлу ключа TLS клиента. Псевдонимы: tls_client_key
labels		Список меток для установки для тома
name обязательно		Имя тома, с которым нужно работать. Псевдонимы: volume_name
ssl_version	Значение по умолчанию: 1.0	Укажите допустимый номер версии SSL. Значение по умолчанию определяется docker-py, в настоящее время 1.0.
state	Варианты: отсутствует есть ←	`absent` удаляет том. `present` создает том, если он еще не существует.
timeout	Значение по умолчанию: 60	Максимальное время в секундах ожидания ответа от API.
tls	Значение по умолчанию: нет	Защитить соединение с API с помощью TLS без проверки подлинности сервера Docker.
tls_hostname	Значение по умолчанию: localhost	При проверке подлинности сервера Docker укажите ожидаемое имя сервера.
tls_verify	Значение по умолчанию: нет	Защитить соединение с API с помощью TLS и проверить подлинность сервера Docker.

Примечания

Примечание

Подключиться к демону 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 словарь	успешно	Результаты проверки тома для затронутого тома.

Статус

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

Автор

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