Модуль community.general.consul_acl_bootstrap — начальная настройка ACL в Consul

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install community.general.

Чтобы использовать её в плейбуке, укажите: community.general.consul_acl_bootstrap.

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

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

Краткое описание

Позволяет выполнить начальную настройку ACL в кластере Consul; подробности см. на странице https://developer.hashicorp.com/consul/api-docs/acl#bootstrap-acls.

Параметры

Параметр	Комментарии
bootstrap_secret string	Секрет, используемый в качестве идентификатора секрета для начального токена. Должен иметь формат UUID.
ca_path string	Путь к пакету сертификатов центра сертификации для HTTPS-соединений.
host string	Хост агента Consul. По умолчанию: `"localhost"`
port integer	Порт, на котором работает агент Consul. По умолчанию: `8500`
scheme string	Схема протокола, по которой работает агент Consul. По умолчанию используется `http`; для защищённых соединений можно указать `https`. По умолчанию: `"http"`
state string	Должен ли токен присутствовать или отсутствовать. Варианты: `"present"` ← (по умолчанию) `"bootstrapped"`
validate_certs boolean	Проверять ли TLS-сертификат агента Consul. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: нет	Можно выполнить в режиме `check_mode` и получить прогноз изменения статуса, не изменяя целевой объект.
diff_mode	Поддержка: нет	В режиме сравнения возвращает сведения об изменениях (или о возможных изменениях в `check_mode`).

Примеры

- name: Bootstrap the ACL system
  community.general.consul_acl_bootstrap:
    bootstrap_secret: 22eaeed1-bdbd-4651-724e-42ae6c43e387

Возвращаемые значения

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

Ключ	Описание
result dictionary	Результат начальной настройки, возвращённый HTTP API Consul. Примечание: Если указан `bootstrap_secret`, `SecretID` и `ID` не содержат секрет, а содержат `VALUE_SPECIFIED_IN_NO_LOG_PARAMETER`. Если вы передаёте `bootstrap_secret`, убедитесь, что ваш плейбук или роль не зависят от этого возвращаемого значения! Возвращается: changed Пример: `{"AccessorID": "834a5881-10a9-a45b-f63c-490e28743557", "CreateIndex": 25, "CreateTime": "2024-01-21T20:26:27.114612038+01:00", "Description": "Bootstrap Token (Global Management)", "Hash": "X2AgaFhnQGRhSSF/h0m6qpX1wj/HJWbyXcxkEM/5GrY=", "ID": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER", "Local": false, "ModifyIndex": 25, "Policies": [{"ID": "00000000-0000-0000-0000-000000000001", "Name": "global-management"}], "SecretID": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER"}`

Ключ

Описание

result

dictionary

Результат начальной настройки, возвращённый HTTP API Consul.

Примечание: Если указан bootstrap_secret, SecretID и ID не содержат секрет, а содержат VALUE_SPECIFIED_IN_NO_LOG_PARAMETER. Если вы передаёте bootstrap_secret, убедитесь, что ваш плейбук или роль не зависят от этого возвращаемого значения!

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

Пример: {"AccessorID": "834a5881-10a9-a45b-f63c-490e28743557", "CreateIndex": 25, "CreateTime": "2024-01-21T20:26:27.114612038+01:00", "Description": "Bootstrap Token (Global Management)", "Hash": "X2AgaFhnQGRhSSF/h0m6qpX1wj/HJWbyXcxkEM/5GrY=", "ID": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER", "Local": false, "ModifyIndex": 25, "Policies": [{"ID": "00000000-0000-0000-0000-000000000001", "Name": "global-management"}], "SecretID": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER"}

Авторы

Florian Apolloner (@apollo13)

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

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/consul_acl_bootstrap_module.html