Модуль community.general.consul_token – управление токенами Consul

accessor_id

string

Указывает UUID, который будет использоваться в качестве Accessor ID токена. Если значение не указано, для этого поля генерируется UUID.

ca_path

string

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

description

string

Произвольное описание токена в понятной человеку форме.

expiration_ttl

string

Это вспомогательное поле; при его задании инициализируется expiration_time. Значение можно указать в формате 60s или 5m (то есть 60 секунд или 5 минут соответственно). Игнорируется при обновлении токена!

host

string

Хост агента Consul.

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

local

boolean

Если значение равно true, токен не реплицируется глобально, а действует только в текущем центре обработки данных.

Варианты:

• false
• true

node_identities

list / elements=dictionary

Список идентификаторов узлов, которые нужно привязать к токену.

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

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

datacenter

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

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

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

node_name

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

Имя узла.

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

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

policies

list / elements=dictionary

Список политик, которые нужно привязать к токену. Каждая политика представляет собой словарь.

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

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

id

string

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

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

name

string

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

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

port

integer

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

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

roles

list / elements=dictionary

Список ролей, которые нужно привязать к токену. Каждая роль представляет собой словарь.

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

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

id

string

ID роли, которую нужно привязать к этому токену; дополнительную информацию см. в community.general.consul_role.

Необходимо указать этот параметр или roles[].name.

name

string

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

Необходимо указать этот параметр или roles[].id.

scheme

string

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

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

secret_id

string

Указывает UUID, который будет использоваться в качестве Secret ID токена. Если значение не указано, для этого поля генерируется UUID.

service_identities

list / elements=dictionary

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

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

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

datacenters

list / elements=string

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

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

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

service_name

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

Имя службы.

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

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

state

string

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

Варианты:

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

templated_policies

list / elements=dictionary

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

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

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

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

В режиме diff возвращает сведения об изменениях (или о том, что, возможно, потребуется изменить в check_mode).

operation

string

Выполненная операция.

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

Пример: "update"

token

dictionary

Токен в том виде, в котором его возвращает HTTP API Consul.

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

Пример: {"AccessorID": "07a7de84-c9c7-448a-99cc-beaf682efd21", "CreateIndex": 632, "CreateTime": "2024-01-14T21:53:01.402749174+01:00", "Description": "Testing", "Hash": "rj5PeDHddHslkpW7Ij4OD6N4bbSXiecXFmiw2SYXg2A=", "Local": false, "ModifyIndex": 633, "SecretID": "bd380fba-da17-7cee-8576-8d6427c6c930", "ServiceIdentities": [{"ServiceName": "test"}]}