Модуль community.docker.docker_volume — управление томами Docker

api_version

псевдонимы: docker_api_version

строка

Версия Docker API, работающего на узле Docker.

По умолчанию используется последняя версия API, поддерживаемая этой коллекцией и демоном Docker.

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

По умолчанию: "auto"

ca_path

псевдонимы: ca_cert, tls_ca_cert, cacert_path

путь

При проверке сервера используйте сертификат CA, указав путь к файлу сертификата CA.

Если значение не указано в задаче, а переменная окружения DOCKER_CERT_PATH задана, будет использован файл ca.pem из каталога, указанного в переменной окружения DOCKER_CERT_PATH.

Ранее этот параметр назывался ca_cert; в community.docker 3.6.0 он был переименован в ca_path. Старое имя добавлено как псевдоним и по-прежнему может использоваться.

client_cert

псевдонимы: tls_client_cert, cert_path

путь

Путь к файлу TLS-сертификата клиента.

Если значение не указано в задаче, а переменная окружения DOCKER_CERT_PATH задана, будет использован файл cert.pem из каталога, указанного в переменной окружения DOCKER_CERT_PATH.

client_key

псевдонимы: tls_client_key, key_path

путь

Путь к файлу TLS-ключа клиента.

Если значение не указано в задаче, а переменная окружения DOCKER_CERT_PATH задана, будет использован файл key.pem из каталога, указанного в переменной окружения DOCKER_CERT_PATH.

debug

логический

Режим отладки

Варианты:

• false ← (по умолчанию)
• true

docker_host

псевдонимы: docker_url

строка

URL или путь к сокету Unix, используемый для подключения к Docker API. Для подключения к удалённому узлу укажите строку TCP-подключения. Например, tcp://192.0.2.23:2376. Если для шифрования соединения используется TLS, модуль автоматически заменит tcp в URL подключения на https.

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

По умолчанию: "unix:///var/run/docker.sock"

driver

строка

Укажите тип тома. Docker предоставляет драйвер local, но также можно использовать сторонние драйверы.

По умолчанию: "local"

driver_options

словарь

Словарь настроек тома. Допустимые параметры и значения см. в документации Docker: https://docs.docker.com/engine/reference/commandline/volume_create/#driver-specific-options.

По умолчанию: {}

labels

словарь

Словарь пар ключ/значение меток, назначаемых тому.

recreate

строка

Определяет, когда том будет пересоздан при state=present. Обратите внимание: пересоздание существующего тома приведёт к потере всех данных в существующем томе! Том будет удалён, а затем создан новый том с тем же именем.

Значение always указывает всегда пересоздавать том.

Значение never гарантирует, что том не будет пересоздан.

Значение options-changed гарантирует, что том будет пересоздан, если он уже существует, а драйвер, параметры драйвера или метки отличаются.

Варианты:

• "always"
• "never" ← (по умолчанию)
• "options-changed"

state

строка

absent удаляет том.

present создаёт том, если он ещё не существует.

Варианты:

• "absent"
• "present" ← (по умолчанию)

timeout

целое число

Максимальное время ожидания ответа от API в секундах.

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

По умолчанию: 60

tls

логический

Защитите соединение с API с помощью TLS без проверки подлинности сервера узла Docker. Обратите внимание: если для validate_certs также задано значение true, этот параметр имеет приоритет.

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

Варианты:

• false ← (по умолчанию)
• true

tls_hostname

строка

При проверке подлинности сервера узла Docker укажите ожидаемое имя сервера.

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

Обратите внимание, что в более ранних версиях значением этого параметра по умолчанию было localhost. Оно было удалено в community.docker 3.0.0.

use_ssh_client

логический

добавлено в community.docker 1.5.0

Для SSH-транспорта используйте инструмент CLI ssh вместо paramiko.

Варианты:

• false ← (по умолчанию)
• true

validate_certs

псевдонимы: tls_verify

логический

Защитите соединение с API с помощью TLS и проверяйте подлинность сервера узла Docker.

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

Варианты:

• false ← (по умолчанию)
• true

volume_name

псевдонимы: name

строка / обязательный

Имя тома, с которым выполняются операции.

action_group

Группы действий: community.docker.docker, docker

Используйте group/docker или group/community.docker.docker в module_defaults, чтобы задать значения по умолчанию для этого модуля.

check_mode

Поддержка: полная

Может выполняться в режиме check_mode и возвращать прогноз изменения состояния без изменения целевого узла.

diff_mode

Поддержка: полная

В режиме diff будут возвращены сведения об изменениях (или о возможных изменениях в check_mode).

idempotent

Поддержка: частичная

Если recreate=always, модуль не является идемпотентным.

При повторном запуске с теми же аргументами вне режима проверки модуль сообщает об отсутствии изменений.

Предполагается, что система, управляемая или опрашиваемая модулем, не изменилась существенным образом.

volume

словарь

Результаты проверки затронутого тома.

Возвращается: success

Пример: {}