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

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: community.docker.docker_plugin.

Добавлено в community.docker 1.3.0

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

Краткое описание

Этот модуль позволяет устанавливать, удалять, включать и отключать плагины Docker.
Выполняет практически те же функции, что и подкоманда CLI docker plugin.

Требования

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

Docker API >= 1.25
paramiko (при использовании SSH с use_ssh_client=false)
pyOpenSSL (при использовании TLS)
pywin32 (при использовании именованных каналов в 32-разрядной Windows)
requests

Параметры

Параметр	Комментарии
alias string добавлено в community.docker 1.8.0	Локальное имя плагина.
api_version псевдонимы: docker_api_version string	Версия Docker API, используемая на узле Docker. По умолчанию используется последняя версия API, поддерживаемая этой коллекцией и демоном Docker. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `DOCKER_API_VERSION`. Если переменная окружения не задана, будет использоваться значение по умолчанию. По умолчанию: `"auto"`
ca_path псевдонимы: ca_cert, tls_ca_cert, cacert_path path	Для проверки сервера используйте сертификат центра сертификации, указав путь к файлу сертификата. Если значение не указано в задаче, а переменная окружения `DOCKER_CERT_PATH` задана, будет использоваться файл `ca.pem` из каталога, указанного в переменной окружения `DOCKER_CERT_PATH`. Ранее этот параметр назывался `ca_cert`, а в community.docker 3.6.0 был переименован в `ca_path`. Старое имя добавлено как псевдоним и по-прежнему доступно.
client_cert псевдонимы: tls_client_cert, cert_path path	Путь к файлу TLS-сертификата клиента. Если значение не указано в задаче, а переменная окружения `DOCKER_CERT_PATH` задана, будет использоваться файл `cert.pem` из каталога, указанного в переменной окружения `DOCKER_CERT_PATH`.
client_key псевдонимы: tls_client_key, key_path path	Путь к файлу ключа TLS клиента. Если значение не указано в задаче, а переменная окружения `DOCKER_CERT_PATH` задана, будет использоваться файл `key.pem` из каталога, указанного в переменной окружения `DOCKER_CERT_PATH`.
debug boolean	Режим отладки Варианты: `false` ← (по умолчанию) `true`
docker_host псевдонимы: docker_url string	URL или путь к сокету Unix, используемый для подключения к Docker API. Для подключения к удалённому узлу укажите строку TCP-подключения. Например, `tcp://192.0.2.23:2376`. Если соединение шифруется с помощью TLS, модуль автоматически заменит `tcp` в URL подключения на `https`. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `DOCKER_HOST`. Если переменная окружения не задана, будет использоваться значение по умолчанию. По умолчанию: `"unix:///var/run/docker.sock"`
enable_timeout integer	Время ожидания в секундах. По умолчанию: `0`
force_remove boolean	Удалять плагин, даже если он включён. Варианты: `false` ← (по умолчанию) `true`
plugin_name string / обязательный	Имя плагина, с которым нужно выполнить операцию.
plugin_options dictionary	Словарь параметров плагина. По умолчанию: `{}`
state string	`absent` удалить плагин. `present` установить плагин, если он ещё не существует. `enable` включить плагин. `disable` отключить плагин. Варианты: `"absent"` `"present"` ← (по умолчанию) `"enable"` `"disable"`
timeout integer	Максимальное время ожидания ответа от API в секундах. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `DOCKER_TIMEOUT`. Если переменная окружения не задана, будет использоваться значение по умолчанию. По умолчанию: `60`
tls boolean	Защитить соединение с API с помощью TLS без проверки подлинности сервера узла Docker. Обратите внимание: если `validate_certs` также задано как `true`, этот параметр имеет приоритет. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `DOCKER_TLS`. Если переменная окружения не задана, будет использоваться значение по умолчанию. Варианты: `false` ← (по умолчанию) `true`
tls_hostname string	При проверке подлинности сервера узла Docker укажите ожидаемое имя сервера. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `DOCKER_TLS_HOSTNAME`. Если переменная окружения не задана, будет использоваться значение по умолчанию. Обратите внимание, что в предыдущих версиях этот параметр имел значение по умолчанию `localhost`. Оно было удалено в community.docker 3.0.0.
use_ssh_client boolean добавлено в community.docker 1.5.0	Для SSH-подключений использовать инструмент командной строки `ssh` вместо paramiko. Варианты: `false` ← (по умолчанию) `true`
validate_certs псевдонимы: tls_verify boolean	Защитить соединение с API с помощью TLS и проверить подлинность сервера узла Docker. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `DOCKER_TLS_VERIFY`. Если переменная окружения не задана, будет использоваться значение по умолчанию. Варианты: `false` ← (по умолчанию) `true`

Атрибуты

Атрибут	Поддержка	Описание
action_group	Группы действий: community.docker.docker, docker	Используйте `group/docker` или `group/community.docker.docker` в `module_defaults`, чтобы задать значения по умолчанию для этого модуля.
check_mode	Поддержка: полная	Может работать в режиме `check_mode` и возвращать прогноз изменения состояния, не изменяя целевой узел.
diff_mode	Поддержка: полная	В режиме diff возвращает сведения об изменениях (или о возможных изменениях в `check_mode`).
idempotent	Поддержка: полная	При повторном запуске подряд вне режима проверки с теми же аргументами второй вызов сообщает об отсутствии изменений. Предполагается, что система, которой управляет модуль или состояние которой он проверяет, не изменилась существенным образом.

Примечания

Примечание

Флаг CLI --grant-all-permissions в этом модуле по умолчанию включён.
Подключиться к демону Docker можно, указав параметры в каждой задаче или задав переменные окружения. Можно задать DOCKER_HOST, DOCKER_TLS_HOSTNAME, DOCKER_API_VERSION, DOCKER_CERT_PATH, DOCKER_TLS, DOCKER_TLS_VERIFY и DOCKER_TIMEOUT. Если вы используете Docker Machine, запустите поставляемый с продуктом скрипт настройки окружения. Он задаст эти переменные. Дополнительные сведения см. на странице https://docs.docker.com/machine/reference/env/.
Этот модуль не использует Docker SDK для Python для взаимодействия с демоном Docker. Вместо этого он использует код, производный от Docker SDK или Python и включённый в эту коллекцию.

Примеры

---
- name: Install a plugin
  community.docker.docker_plugin:
    plugin_name: plugin_one
    state: present

- name: Remove a plugin
  community.docker.docker_plugin:
    plugin_name: plugin_one
    state: absent

- name: Enable the plugin
  community.docker.docker_plugin:
    plugin_name: plugin_one
    state: enable

- name: Disable the plugin
  community.docker.docker_plugin:
    plugin_name: plugin_one
    state: disable

- name: Install a plugin with options
  community.docker.docker_plugin:
    plugin_name: weaveworks/net-plugin:latest_release
    plugin_options:
      IPALLOC_RANGE: "10.32.0.0/12"
      WEAVE_PASSWORD: "PASSWORD"

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

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

Ключ	Описание
actions list / elements=string	Список действий, выполненных при запуске задачи. Возвращается: если `state` не равно `absent`
plugin dictionary	Результаты проверки затронутого плагина. Возвращается: при успешном выполнении Пример: `{}`

Авторы

Sakar Mehra (@sakar97)
Vladimir Porshkevich (@porshkevich)

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

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