Модуль community.docker.docker_node — Управление узлом Docker Swarm

Примечание

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

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

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

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

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

Описание

Управляет узлами Docker через менеджер Swarm.
Этот модуль позволяет изменять роль узла, его доступность и изменять, добавлять или удалять метки узла.

Требования

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

API Docker >= 1.25
Docker SDK для Python: Обратите внимание, что модуль Python docker-py был заменён на docker (подробнее см. здесь). Обратите внимание, что оба модуля не должны устанавливаться одновременно. Также обратите внимание, что при установке и последующем удалении одного из модулей, другой может перестать работать, и потребуется его повторная установка.
Docker SDK для Python >= 2.4.0

Параметры

Параметр	Комментарии
api_version псевдонимы: docker_api_version строка	Версия API Docker, работающая на хосте Docker. По умолчанию используется последняя версия API, поддерживаемая Docker SDK для Python и демоном Docker. Если значение не указано в задаче, используется значение переменной среды `DOCKER_API_VERSION`. Если переменная среды не задана, используется значение по умолчанию. По умолчанию: `"auto"`
availability строка	Доступность узла для назначения. Если не указано, доступность узла не меняется. Варианты: `"active"` `"pause"` `"drain"`
ca_path псевдонимы: 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 псевдонимы: 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-сокету для подключения к API Docker. Для подключения к удалённому хосту укажите строку TCP-соединения. Например, `tcp://192.0.2.23:2376`. Если для шифрования соединения используется TLS, модуль автоматически заменит `tcp` в URL-адресе соединения на `https`. Если значение не указано в задаче, используется значение переменной среды `DOCKER_HOST`. Если переменная среды не задана, используется значение по умолчанию. По умолчанию: `"unix:///var/run/docker.sock"`
hostname строка / обязательно	Имя хоста или ID узла, зарегистрированного в Swarm. Если более одного узла зарегистрировано с одинаковым именем хоста, необходимо использовать ID, в противном случае модуль завершится ошибкой.
labels словарь	Пользовательские метаданные ключ/значение, которые будут назначены как атрибут узла. Операции с метками в этом модуле применяются к узлу Docker Swarm, указанному `hostname`. Используйте модуль community.docker.docker_swarm для добавления/изменения/удаления меток кластера Swarm. Фактическое состояние меток, назначенных узлу, после завершения работы модуля зависит от значений параметров `labels_state` и `labels_to_remove`. См. описание ниже.
labels_state строка	Определяет операцию над метками, назначенными узлу, и метками, указанными в параметре `labels`. Установите значение `merge`, чтобы объединить метки, указанные в `labels`, с уже назначенными метками узла. Если метки не назначены, то будут добавлены перечисленные метки. Для уже назначенных меток будет обновлено их значение. Метки, не указанные в `labels`, останутся неизменными. Если `labels` пусто, то никаких изменений не будет. Установите значение `replace`, чтобы заменить все назначенные метки на предоставленные. Если `labels` пусто, все метки, назначенные узлу, будут удалены. Варианты: `"merge"` ← (по умолчанию) `"replace"`
labels_to_remove список / элементы=строка	Список меток, которые будут удалены из конфигурации узла. Список должен содержать только имена меток, а не их значения. Если метка, указанная в списке, не назначена узлу, запись игнорируется. Если метка присутствует как в `labels_to_remove`, так и в `labels`, то значение, указанное в `labels`, остаётся назначенным узлу. Если `labels_state=replace` и `labels` не указаны или пусты, все метки, назначенные узлу, удаляются, и `labels_to_remove` игнорируется.
role строка	Роль узла для назначения. Если не указано, роль узла не меняется. Варианты: `"manager"` `"worker"`

ssl_version string	Укажите допустимый номер версии SSL. Значение по умолчанию определяется модулем SSL Python. Если значение не указано в задании, будет использовано значение переменной среды `DOCKER_SSL_VERSION`. Примечание: этот параметр больше не поддерживается для Docker SDK для Python 7.0.0+. Указание его с Docker SDK для Python 7.0.0 или более поздней версии приведет к ошибке.
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. Примечание: этот параметр больше не поддерживается для Docker SDK для Python 7.0.0+. Указание его с Docker SDK для Python 7.0.0 или более поздней версии приведет к ошибке.
use_ssh_client boolean добавлен в community.docker 1.5.0	Для SSH-транспортов используйте инструмент `ssh` CLI вместо paramiko. Требуется Docker SDK для Python 4.4.0 или более поздней версии. Возможные значения: `false` ← (по умолчанию) `true`
validate_certs aliases: 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	Поддержка: отсутствует	Возвращает подробности о том, что изменилось (или, возможно, должно быть изменено в `check_mode`), при работе в режиме сравнения.

Примечания

Примечание

Подключитесь к демону 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] с помощью ansible.builtin.pip.
Обратите внимание, что Docker SDK для Python позволяет указывать путь к конфигурации Docker только для очень немногих функций. В общем случае он будет использовать $HOME/.docker/config.json если переменная среды DOCKER_CONFIG не указана, и использовать $DOCKER_CONFIG/config.json в противном случае.
Этот модуль использует Docker SDK для Python для связи с демоном Docker.

Примеры

- name: Set node role
  community.docker.docker_node:
    hostname: mynode
    role: manager

- name: Set node availability
  community.docker.docker_node:
    hostname: mynode
    availability: drain

- name: Replace node labels with new labels
  community.docker.docker_node:
    hostname: mynode
    labels:
      key: value
    labels_state: replace

- name: Merge node labels and new labels
  community.docker.docker_node:
    hostname: mynode
    labels:
      key: value

- name: Remove all labels assigned to node
  community.docker.docker_node:
    hostname: mynode
    labels_state: replace

- name: Remove selected labels from the node
  community.docker.docker_node:
    hostname: mynode
    labels_to_remove:
      - key1
      - key2

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

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

Ключ	Описание
узел словарь	Информация об узле после операции «обновление» Возвращено: успех

Авторы

Piotr Wojciechowski (@WojciechowskiPiotr)
Thierry Bouvet (@tbouvet)

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

© 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_node_module.html