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

Примечание

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

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

Для использования в книге задач, укажите: community.docker.docker_volume.

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

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

Требования

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

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_version строка	Значение по умолчанию: "auto"	Версия Docker API, работающего на хосте 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 для подключения к 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
labels словарь		Словарь меток ключ/значение для установки для тома
recreate строка	Варианты: всегда никогда ← изменены-параметры	Управляет тем, когда том будет пересоздан, когда состояние равно `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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/docker/docker_volume_module.html