Spec-Zone.ru › Ansible

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

Примечание

Этот модуль входит в коллекцию community.docker (версия 3.13.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.docker. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробной информации.

Для использования в плейбуке укажите: community.docker.docker_volume.

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

Описание

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

Требования

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

  • Docker API >= 1.25
  • backports.ssl_match_hostname (при использовании TLS в Python 2)
  • paramiko (при использовании SSH с use_ssh_client=false)
  • pyOpenSSL (при использовании TLS)
  • pywin32 (при использовании именованных каналов на Windows 32)
  • requests

Параметры

Параметр

Комментарии

api_version

aliases: docker_api_version

строка

Версия Docker API, работающая на хосте Docker.

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

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

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

ca_path

aliases: ca_cert, tls_ca_cert, cacert_path

путь

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

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

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

client_cert

aliases: tls_client_cert, cert_path

путь

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

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

client_key

aliases: tls_client_key, key_path

путь

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

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

debug

логический

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

Варианты:

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

docker_host

aliases: 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"

ssl_version

строка

Укажите допустимое значение версии SSL. Значение по умолчанию определяется модулем SSL Python.

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

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-транспортов используйте инструмент ssh CLI вместо 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

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

Возвращает подробности о том, что изменилось (или, возможно, требует изменения в check_mode), когда используется режим diff.

Примечания

Примечание

  • Подключиться к демону 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 SDK для Python для связи с демоном Docker. Он использует код, полученный из Docker SDK или Python, который включён в эту коллекцию.

Примеры

- 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)

Ссылки на коллекцию

  • Система отслеживания ошибок
  • Репозиторий (источники)
  • Задайте вопрос (Docker)
  • Задайте вопрос (Docker Compose)
  • Задайте вопрос (Docker Swarm)
  • Отправить отчет об ошибке
  • Запросить функцию
  • Общение

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API