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

Примечание

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

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

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

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

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

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

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

Позволяет добавлять, изменять и удалять политики в кластере Consul с помощью агента. Подробнее об использовании и настройке ACL см. в документации https://www.consul.io/docs/guides/acl.html.

Параметры

Параметр	Комментарии
ca_path string	Пакет CA-сертификатов для HTTPS-подключений.
description string	Описание политики.
host string	Узел агента Consul. По умолчанию: `"localhost"`
name string / обязательный	Имя, которое должно быть связано с политикой; для Consul это непрозрачное значение.
port integer	Порт, на котором работает агент Consul. По умолчанию: `8500`
rules string	Документ с правилами, который должен быть связан с текущей политикой.
scheme string	Схема протокола, используемая агентом Consul. По умолчанию используется `http`; для защищённых подключений можно указать `https`. По умолчанию: `"http"`
state string	Должна ли политика присутствовать или отсутствовать. Варианты: `"present"` ← (по умолчанию) `"absent"`
token string	Токен для авторизации.
valid_datacenters list / elements=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	Поддержка: полная добавлено в community.general 8.3.0	Модуль может работать в режиме `check_mode` и возвращать прогноз статуса изменений, не изменяя целевой объект.
diff_mode	Поддержка: частичная добавлено в community.general 8.3.0 В режиме проверки в diff не отображаются операционные атрибуты.	В режиме diff возвращает сведения об изменениях (или о том, что, возможно, потребуется изменить в `check_mode`).

Примеры

- name: Create a policy with rules
  community.general.consul_policy:
    host: consul1.example.com
    token: some_management_acl
    name: foo-access
    rules: |
      key "foo" {
          policy = "read"
      }
      key "private/foo" {
          policy = "deny"
      }

- name: Update the rules associated to a policy
  community.general.consul_policy:
    host: consul1.example.com
    token: some_management_acl
    name: foo-access
    rules: |
      key "foo" {
          policy = "read"
      }
      key "private/foo" {
          policy = "deny"
      }
      event "bbq" {
          policy = "write"
      }

- name: Remove a policy
  community.general.consul_policy:
    host: consul1.example.com
    token: some_management_acl
    name: foo-access
    state: absent

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

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

Ключ	Описание
operation string	Выполненная операция. Возвращается: при изменении Пример: `"update"`
policy dictionary	Политика в формате, возвращаемом HTTP API Consul. Возвращается: всегда Пример: `{"CreateIndex": 632, "Description": "Testing", "Hash": "rj5PeDHddHslkpW7Ij4OD6N4bbSXiecXFmiw2SYXg2A=", "Name": "foo-access", "Rules": "key \"foo\" {\n policy = \"read\"\n}\nkey \"private/foo\" {\n policy = \"deny\"\n}"}`

Авторы

Håkon Lerring (@Hakon)

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

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