community.docker.docker_node – Управление узлом Docker Swarm

Примечание

Этот плагин входит в коллекцию community.docker (версия 1.2.2).

Для его установки используйте: ansible-galaxy collection install community.docker.

Чтобы использовать его в книге задач, укажите: community.docker.docker_node.

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

Обзор

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

Требования

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

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_version строка	Значение по умолчанию: "auto"	Версия Docker API, работающего на хосте Docker. По умолчанию используется последняя версия API, поддерживаемая Docker SDK для Python и демоном Docker. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `DOCKER_API_VERSION`. Если переменная окружения не задана, будет использовано значение по умолчанию. Псевдонимы: docker_api_version
availability строка	Варианты: active pause drain	Доступность узла для назначения. Если не указано, доступность узла остаётся неизменной.
ca_cert путь		Используйте сертификат CA для проверки сервера, указав путь к файлу сертификата CA. Если значение не указано в задаче и установлена переменная окружения `DOCKER_CERT_PATH`, будет использован файл `ca.pem` из каталога, указанного в переменной окружения `DOCKER_CERT_PATH`. Псевдонимы: tls_ca_cert, cacert_path
client_cert путь		Путь к файлу TLS-сертификата клиента. Если значение не указано в задаче и установлена переменная окружения `DOCKER_CERT_PATH`, будет использован файл `cert.pem` из каталога, указанного в переменной окружения `DOCKER_CERT_PATH`. Псевдонимы: tls_client_cert, cert_path
client_key путь		Путь к файлу TLS-ключа клиента. Если значение не указано в задаче и установлена переменная окружения `DOCKER_CERT_PATH`, будет использован файл `key.pem` из каталога, указанного в переменной окружения `DOCKER_CERT_PATH`. Псевдонимы: tls_client_key, key_path
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
hostname строка / обязательно		Имя хоста или ID узла, зарегистрированного в Swarm. Если более одного узла зарегистрировано с одинаковым именем хоста, необходимо использовать ID, иначе модуль завершится с ошибкой.
labels словарь		Пользовательские метаданные ключ/значение, которые будут назначены как атрибут узла. Операции с метками в этом модуле применяются к узлу Docker Swarm, указанному параметром hostname. Используйте модуль community.docker.docker_swarm для добавления/изменения/удаления меток кластера Swarm. Фактическое состояние меток, назначенных узлу при завершении работы модуля, зависит от значений параметров labels_state и labels_to_remove. См. описание ниже.
labels_state строка	Варианты: merge ← replace	Определяет операцию над метками, назначенными узлу, и метками, указанными в параметре labels. Установите значение `merge` для объединения меток, предоставленных в параметре labels, с уже назначенными метками узла. Если метки не назначены, будут добавлены перечисленные метки. Для меток, которые уже назначены узлу, будут обновлены их значения. Метки, не указанные в параметре labels, останутся неизменными. Если labels пустой, изменений не будет. Установите значение `replace` для замены всех назначенных меток предоставленными. Если labels пустой, все метки, назначенные узлу, будут удалены.
labels_to_remove список / элементы=строка		Список меток, которые будут удалены из конфигурации узла. Список должен содержать только имена меток, а не их значения. Если метка, указанная в списке, не назначена узлу, запись игнорируется. Если метка присутствует как в labels_to_remove, так и в labels, значение, указанное в labels, остаётся назначенным узлу. Если labels_state равно `replace`, а labels не указано или пусто, все метки, назначенные узлу, будут удалены, и labels_to_remove будет проигнорировано.
role строка	Варианты: manager worker	Роль узла для назначения. Если не указано, роль узла остаётся неизменной.
ssl_version строка		Укажите версию SSL. Значение по умолчанию определяется модулем ssl.py. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `DOCKER_SSL_VERSION`.
timeout целое число	Значение по умолчанию: 60	Максимальное время ожидания ответа от API в секундах. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `DOCKER_TIMEOUT`. Если переменная окружения не задана, будет использовано значение по умолчанию.
tls логическое	Варианты: нет ← да	Обеспечить безопасность соединения с API с помощью TLS без проверки подлинности хоста Docker. Обратите внимание, что если validate_certs также установлено в `yes`, оно будет иметь приоритет. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `DOCKER_TLS`. Если переменная окружения не задана, будет использовано значение по умолчанию.
tls_hostname строка	Значение по умолчанию: "localhost"	При проверке подлинности хоста Docker укажите ожидаемое имя сервера. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `DOCKER_TLS_HOSTNAME`. Если переменная окружения не задана, будет использовано значение по умолчанию.
validate_certs логическое	Варианты: нет ← да	Обеспечить безопасность соединения с API с помощью TLS и проверить подлинность хоста Docker. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `DOCKER_TLS_VERIFY`. Если переменная окружения не задана, будет использовано значение по умолчанию. Псевдонимы: 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://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

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

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

Ключ	Возвращаемое значение	Описание
node словарь	успех	Информация о узле после операции 'update'

Авторы

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

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