community.docker.docker_swarm модуль — Управление кластером Swarm

Примечание

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

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

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

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

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

Описание

Создание нового кластера Swarm.
Добавление/удаление узлов или менеджеров в существующий кластер.

Требования

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

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

Параметры

Параметр	Комментарии
advertise_addr string	Внешне доступный адрес, объявленный для других узлов. Это может быть комбинация адрес/порт в формате `192.168.1.1:4567`, или интерфейс с последующим номером порта, например `eth0:4567`. Если номер порта опущен, используется номер порта из адреса прослушивания. Если `advertise_addr` не указан, он будет автоматически обнаружен, когда это возможно. Используется только при инициализации или присоединении роя. Из-за этого он не учитывается при проверке идемпотентности.
api_version aliases: docker_api_version string	Версия Docker API, работающего на Docker Host. По умолчанию используется последняя версия API, поддерживаемая Docker SDK для Python и демоном docker. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `DOCKER_API_VERSION`. Если переменная среды не установлена, будет использовано значение по умолчанию. Default: `"auto"`
autolock_managers boolean	Если установлено, сгенерировать ключ и использовать его для блокировки данных, хранящихся на менеджерах. Значение по умолчанию в Docker - `false`. community.docker.docker_swarm_info может использоваться для получения ключа разблокировки. Choices: `false` `true`
ca_force_rotate integer	Целое число, предназначенное для принудительной генерации роем нового сертификата и ключа подписи ЦС, если они не были указаны. Значение по умолчанию в Docker - `0`. Требуется версия API >= 1.30.
ca_path aliases: ca_cert, tls_ca_cert, cacert_path path	Использовать сертификат ЦС при проверке сервера, указав путь к файлу сертификата ЦС. Если значение не указано в задаче и переменная среды `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 path	Путь к файлу сертификата TLS клиента. Если значение не указано в задаче и переменная среды `DOCKER_CERT_PATH` установлена, будет использован файл `cert.pem` из каталога, указанного в переменной среды `DOCKER_CERT_PATH`.
client_key aliases: tls_client_key, key_path path	Путь к файлу ключа TLS клиента. Если значение не указано в задаче и переменная среды `DOCKER_CERT_PATH` установлена, будет использован файл `key.pem` из каталога, указанного в переменной среды `DOCKER_CERT_PATH`.
data_path_addr string added in community.docker 2.5.0	Адрес или интерфейс для использования для трафика по пути данных. Это может быть адрес в формате `192.168.1.1`, или интерфейс, например `eth0`. Используется только при инициализации или присоединении роя. Из-за этого он не учитывается при проверке идемпотентности. Требуется версия API >= 1.30.
data_path_port integer added in community.docker 3.1.0	Порт для использования для трафика по пути данных. Это должен быть номер порта, например `9789`. Используется только при инициализации роя. Из-за этого он не учитывается при проверке идемпотентности. Требуется версия API >= 1.40.
debug boolean	Режим отладки Choices: `false` ← (default) `true`
default_addr_pool list / elements=string	Пул адресов по умолчанию в формате CIDR. Используется только при инициализации роя. Из-за этого он не учитывается при проверке идемпотентности. Требуется версия API >= 1.39.
dispatcher_heartbeat_period integer	Задержка (в наносекундах) для агента, чтобы отправить сигнал о сердцебиении диспетчеру. Значение по умолчанию в Docker - 5 секунд, что соответствует значению `5000000000`.
docker_host aliases: docker_url string	URL или путь к сокету Unix, используемый для подключения к Docker API. Для подключения к удаленному хосту укажите строку TCP-подключения. Например, `tcp://192.0.2.23:2376`. Если для шифрования соединения используется TLS, модуль автоматически заменит `tcp` в URL соединения на `https`. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `DOCKER_HOST`. Если переменная среды не установлена, будет использовано значение по умолчанию. Default: `"unix:///var/run/docker.sock"`

election_tick integer	Количество тиков (в секундах), необходимых без лидера для инициирования нового выбора. Значение по умолчанию Docker — `10` секунд.
force boolean	Используется со значением `present` для принудительного создания нового Swarm, даже если узел уже входит в него. Используется со значением `absent` для выхода из Swarm, даже если этот узел является менеджером. Выбор: `false` ← (по умолчанию) `true`
heartbeat_tick integer	Количество тиков (в секундах) между каждым сигналом о состоянии. Значение по умолчанию Docker — `1` секунд.
join_token string	Токен Swarm, используемый для присоединения к кластеру Swarm. Используется с `state=join`. Если это значение указано, соответствующее значение в возвращаемых значениях будет замаскировано Ansible. Это побочный эффект, связанный с тем, что это значение не регистрируется.
keep_old_snapshots integer	Количество сохраняемых снимков помимо текущего. Значение по умолчанию Docker — `0`.
labels dictionary	Пользовательские метаданные в формате ключ/значение. Операции с метками в этом модуле применяются к кластеру Docker Swarm. Используйте модуль community.docker.docker_node, чтобы добавить/изменить/удалить метки узлов Swarm. Требуется версия API ≥ 1.32.
listen_addr string	Адрес прослушивания, используемый для межменеджерского взаимодействия. Это может быть сочетание адреса/порта в формате `192.168.1.1:4567`, или интерфейс, за которым следует номер порта, например `eth0:4567`. Если номер порта опущен, используется порт прослушивания Swarm по умолчанию. Используется только при инициализации или присоединении к Swarm. Поэтому не учитывается при проверке идемпотентности. По умолчанию: `"0.0.0.0:2377"`
log_entries_for_slow_followers integer	Количество записей журнала, которые сохраняются для синхронизации медленных последователей после создания снимка.
name string	Название Swarm.
node_cert_expiry integer	Автоматическое истечение срока действия сертификатов узлов, указанное в наносекундах. Значение по умолчанию Docker — 90 дней, что соответствует значению `7776000000000000`.
node_id string	Идентификатор узла Swarm, который нужно удалить. Используется с `state=remove`.
remote_addrs list / elements=string	Удаленные адреса одного или нескольких управляющих узлов существующего Swarm для подключения. Используется с `state=join`.
rotate_manager_token boolean	Сменить токен присоединения менеджера. Выбор: `false` ← (по умолчанию) `true`
rotate_worker_token boolean	Сменить токен присоединения рабочего узла. Выбор: `false` ← (по умолчанию) `true`
signing_ca_cert string	Желаемый сертификат CA подписи для всех сертификатов узлов Swarm, в формате PEM. Это не путь к сертификату, а содержимое сертификата. Требуется версия API ≥ 1.30.
signing_ca_key string	Желаемый ключ CA подписи для всех сертификатов узлов Swarm, в формате PEM. Это не путь к ключу, а содержимое ключа. Требуется версия API ≥ 1.30.
snapshot_interval integer	Количество записей журнала между снимками. Значение по умолчанию Docker — `10000`.
ssl_version string	Укажите действительный номер версии SSL. Значение по умолчанию определяется модулем SSL Python. Если значение не указано в задании, будет использоваться значение переменной окружения `DOCKER_SSL_VERSION`. Примечание: этот параметр больше не поддерживается для Docker SDK для Python 7.0.0+. Указание его с Docker SDK для Python 7.0.0 или новее приведет к ошибке.

state string	Установите значение `present`, чтобы создать/обновить новый кластер. Установите значение `join`, чтобы присоединиться к существующему кластеру. Установите значение `absent`, чтобы выйти из существующего кластера. Установите значение `remove`, чтобы удалить отсутствующий узел из кластера. Обратите внимание, что для удаления требуется Docker SDK for Python >= 2.4.0. community.docker.docker_node можно использовать для понижения менеджера перед удалением. Выбоы: `"present"` ← (по умолчанию) `"join"` `"absent"` `"remove"`
subnet_size integer	Длина маски подсети для пула адресов по умолчанию. Используется только при инициализации кластера. Из-за этого он не учитывается при проверке идемпотентности. Требуется версия API >= 1.39.
task_history_retention_limit integer	Максимальное количество задач в истории, хранимых в памяти. Значение по умолчанию Docker - `5`.
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 for Python 7.0.0+. Указание её с Docker SDK for Python 7.0.0 или более поздней версией приведёт к ошибке.
use_ssh_client boolean added in community.docker 1.5.0	Для SSH-транспортов используйте инструмент командной строки `ssh` вместо paramiko. Требуется Docker SDK for 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: Init a new swarm with default parameters
  community.docker.docker_swarm:
    state: present

- name: Update swarm configuration
  community.docker.docker_swarm:
    state: present
    election_tick: 5

- name: Add nodes
  community.docker.docker_swarm:
    state: join
    advertise_addr: 192.168.1.2
    join_token: SWMTKN-1--xxxxx
    remote_addrs: [ '192.168.1.1:2377' ]

- name: Leave swarm for a node
  community.docker.docker_swarm:
    state: absent

- name: Remove a swarm manager
  community.docker.docker_swarm:
    state: absent
    force: true

- name: Remove node from swarm
  community.docker.docker_swarm:
    state: remove
    node_id: mynode

- name: Init a new swarm with different data path interface
  community.docker.docker_swarm:
    state: present
    advertise_addr: eth0
    data_path_addr: ens10

- name: Init a new swarm with a different data path port
  community.docker.docker_swarm:
    state: present
    data_path_port: 9789

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

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

Ключ	Описание
actions список / элементы=строка	Предоставляет действия, выполненные в рое. Возвращается: при ошибке действия. Пример: `["This cluster is already a swarm cluster"]`
swarm_facts словарь	Информация о рое. Возвращается: успех
JoinTokens словарь	Токены для подключения к рою. Возвращается: успех
Manager строка	Токен для присоединения к кластеру в качестве нового узла менеджера. Примечание: если это значение было указано как `join_token`, значение здесь не будет токеном, а `VALUE_SPECIFIED_IN_NO_LOG_PARAMETER`. Если вы передаете `join_token`, убедитесь, что ваш playbook/роль не зависит от этого значения возврата! Возвращается: успех Пример: `"SWMTKN-1--xxxxx"`
Worker строка	Токен для присоединения к кластеру в качестве нового узла рабочего. Примечание: если это значение было указано как `join_token`, значение здесь не будет токеном, а `VALUE_SPECIFIED_IN_NO_LOG_PARAMETER`. Если вы передаете `join_token`, убедитесь, что ваш playbook/роль не зависит от этого значения возврата! Возвращается: успех Пример: `"SWMTKN-1--xxxxx"`
UnlockKey строка	Ключ разблокировки роя, если `autolock_managers=true`. Возвращается: при успехе, если `autolock_managers=true` и рой инициализирован, или если `autolock_managers` изменился. Пример: `"SWMKEY-1-xxx"`

Авторы

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

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

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