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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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 строка	Секрет, используемый в качестве идентификатора секрета для начального токена. Должен быть UUID.
ca_path строка	Файл с сертификатами CA для подключения HTTPS.
host строка	Хост агента consul, по умолчанию `localhost`. По умолчанию: `"localhost"`
port целое число	Порт, на котором работает агент consul. По умолчанию: `8500`
scheme строка	Схема протокола, по которому работает агент consul. По умолчанию `http` и может быть установлена в `https` для защищённых соединений. По умолчанию: `"http"`
state строка	Присутствие или отсутствие токена. Выбор: `"present"` ← (по умолчанию) `"bootstrapped"`
validate_certs логическое	Верификация TLS-сертификата агента consul. Выбор: `false` `true` ← (по умолчанию)

Атрибуты

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

Примеры

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

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

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

Ключ	Описание
result словарь	Результат инициализации, возвращаемый API Consul по HTTP. Примечание: Если `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

словарь

Результат инициализации, возвращаемый API Consul по HTTP.

Примечание: Если 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/consul_acl_bootstrap_module.html