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

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

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

Описание

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

Требования

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

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 логическое	Варианты: нет ← да	Режим отладки
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` приводит к удалению и повторному созданию тома, если том уже существует, а драйвер, параметры драйвера или метки отличаются. Это приведет к потере любых данных в существующем томе.
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 логическое	Варианты: нет ← да	Обеспечить безопасность соединения с API с помощью TLS без проверки подлинности Docker хост-сервера. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `DOCKER_TLS`. Если переменная окружения не задана, будет использовано значение по умолчанию.
tls_hostname -	Значение по умолчанию: "localhost"	При проверке подлинности Docker хост-сервера укажите ожидаемое имя сервера. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `DOCKER_TLS_HOSTNAME`. Если переменная окружения не задана, будет использовано значение по умолчанию.
tls_verify логическое	Варианты: нет ← да	Обеспечить безопасность соединения с 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.io/en/stable/machine/.
При подключении к 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

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

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

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

Статус

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