Модуль community.general.consul_role — управление ролями Consul

ca_path

string

Пакет сертификатов центра сертификации для HTTPS-подключений.

description

string

Описание роли.

Если значение не указано, назначенное описание не изменяется.

host

string

Узел агента Consul.

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

name

string / обязательный

Имя, используемое для идентификации роли.

node_identities

list / элементы=dictionary

Список идентификаторов узлов, назначаемых роли.

Если значение не указано, назначенные в данный момент идентификаторы узлов не изменяются.

Если параметр представляет собой пустой массив ([]), назначенные идентификаторы узлов снимаются.

datacenter

string / обязательный

Центр обработки данных узлов.

В результате политика будет действовать только в этом центре обработки данных.

node_name

псевдонимы: name

string / обязательный

Имя узла.

Длина не должна превышать 256 символов; имя должно начинаться и заканчиваться строчным буквенно-цифровым символом.

Допускаются только строчные буквенно-цифровые символы, а также - и _.

В community.general 8.3.0 это подопция была переименована с node_identities[].name в node_identities[].node_name. Старое имя по-прежнему можно использовать.

policies

list / элементы=dictionary

Список политик, назначаемых роли. Каждая политика — это словарь.

Если параметр не задан, назначенные в данный момент политики не изменяются.

Пустой массив ([]) удаляет все ранее заданные политики.

id

string

Идентификатор политики, назначаемой этой роли; дополнительную информацию см. в документации community.general.consul_policy.

Необходимо указать это значение или policies[].name.

name

string

Имя политики, назначаемой этой роли; дополнительную информацию см. в документации community.general.consul_policy.

Необходимо указать это значение или policies[].id.

port

integer

Порт, на котором работает агент Consul.

По умолчанию: 8500

scheme

string

Схема протокола, используемая агентом Consul. По умолчанию используется http; для защищённых подключений можно задать https.

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

service_identities

list / элементы=dictionary

Список идентификаторов служб, назначаемых роли.

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

Если параметр представляет собой пустой массив ([]), назначенные идентификаторы узлов снимаются.

datacenters

list / элементы=string

Центры обработки данных, в которых действуют политики.

В результате политика будет действовать только в этом центре обработки данных.

Если указан пустой массив ([]), политики будут действовать во всех центрах обработки данных.

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

service_name

псевдонимы: name

string / обязательный

Имя узла.

Длина не должна превышать 256 символов; имя должно начинаться и заканчиваться строчным буквенно-цифровым символом.

Допускаются только строчные буквенно-цифровые символы, а также - и _.

В community.general 8.3.0 это подопция была переименована с service_identities[].name в service_identities[].service_name. Старое имя по-прежнему можно использовать.

state

string

Должна ли роль присутствовать или отсутствовать.

Варианты:

• "present" ← (по умолчанию)
• "absent"

templated_policies

list / элементы=dictionary

добавлено в community.general 8.3.0

Список шаблонных политик, которые следует применить к роли.

template_name

string / обязательный

Имя шаблонной политики.

template_variables

dictionary

Переменные шаблонной политики.

Не всем шаблонным политикам требуются переменные.

token

string

Токен для авторизации.

validate_certs

boolean

Следует ли проверять сертификат TLS агента Consul.

Варианты:

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

action_group

Группа действий: community.general.consul

добавлено в community.general 8.3.0

Используйте group/community.general.consul в module_defaults, чтобы задать значения по умолчанию для этого модуля.

check_mode

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

Может выполняться в режиме check_mode и возвращать прогноз изменения состояния, не изменяя целевой объект.

diff_mode

Поддержка: частичная

добавлено в community.general 8.3.0

В режиме проверки в разнице отсутствуют операционные атрибуты.

В режиме отображения разницы возвращает сведения об изменениях (или о возможных изменениях в check_mode).

operation

string

Операция, выполненная над ролью.

Возвращается: changed

Пример: "update"

role

dictionary

Объект роли.

Возвращается: при успешном выполнении

Пример: {"CreateIndex": 39, "Description": "", "Hash": "Trt0QJtxVEfvTTIcdTUbIJRr6Dsi6E4EcwSFxx9tCYM=", "ID": "9a300b8d-48db-b720-8544-a37c0f5dafb5", "ModifyIndex": 39, "Name": "foo-role", "Policies": [{"ID": "b1a00172-d7a1-0e66-a12e-7a4045c4b774", "Name": "foo-access"}]}