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

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

Описание
Требования (к хосту, на котором выполняется модуль)
Параметры
Примеры
Возвращаемые значения
Примечания
- Статус

Описание

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

Требования (к хосту, на котором выполняется модуль)

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

Параметры

параметр	обязательный	значение по умолчанию	допустимые значения	комментарии
api_version	нет	значение по умолчанию, предоставленное docker-py		Версия Docker API, работающая на Docker хосте. По умолчанию используется последняя версия API, поддерживаемая docker-py. псевдонимы: docker_api_version
cacert_path	нет			Используйте сертификат CA при проверке подлинности сервера, указав путь к файлу сертификата CA. псевдонимы: tls_ca_cert
cert_path	нет			Путь к файлу TLS-сертификата клиента. псевдонимы: tls_client_cert
docker_host	нет	unix://var/run/docker.sock		URL или путь к Unix-сокету для подключения к Docker API. Для подключения к удаленному хосту укажите строку 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	нет			Путь к файлу TLS-ключа клиента. псевдонимы: tls_client_key
labels	нет			Список меток для тома
name	да			Имя тома, над которым необходимо выполнить операцию. псевдонимы: volume_name
ssl_version	нет	1.0		Укажите корректное значение версии SSL. Значение по умолчанию определяется docker-py, в настоящее время 1.0.
state	нет	present	absent present	`absent` удаляет том. `present` создаёт том, если он ещё не существует.
timeout	нет	60		Максимальное время ожидания ответа от API в секундах.
tls	нет			Защитить подключение к API с помощью TLS, не проверяя подлинность хоста Docker.
tls_hostname	нет	localhost		При проверке подлинности хоста Docker укажите ожидаемое имя сервера.
tls_verify	нет			Защитить подключение к API с помощью TLS и проверить подлинность хоста Docker.

Примеры

- 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	{}

Примечания

Примечание

Подключиться к демону 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/.

Статус

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

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

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