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

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

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

Описание

Создание/удаление 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
force логический тип	Варианты: нет ← да	При состоянии `present` том будет удален и пересоздан, если том уже существует, и драйвер, параметры драйвера или метки отличаются. Это приведёт к потере любых данных в существующем томе. Устарело. Будет удалено в Ansible 2.12. Для того же поведения, что и установка force в `yes`, установите recreate в `options-changed`.
labels словарь		Словарь меток ключ/значение для установки для тома
recreate строка добавлено в 2.8	Варианты: всегда никогда ← измененные-параметры	Управляет тем, когда том будет пересоздан, когда состояние равно `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] с помощью pip.
Обратите внимание, что Docker SDK для Python позволяет указать путь к конфигурации Docker только для очень немногих функций. В общем случае будет использовано значение $HOME/.docker/config.json, если переменная окружения DOCKER_CONFIG не указана, и $DOCKER_CONFIG/config.json в противном случае.

Примеры

- 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

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

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

Ключ	Возвращаемое значение	Описание
volume словарь	успех	Результаты проверки тома для затронутого тома. Обратите внимание, что факты являются частью зарегистрированных переменных с Ansible 2.8. По соображениям совместимости, факты также доступны непосредственно как `docker_volume`. Обратите внимание, что возвращаемый факт будет удален в Ansible 2.12.

Статус

Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
Этот модуль поддерживается сообществом 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.9/modules/docker_volume_module.html