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

Примечание

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

Эта коллекция может быть уже установлена, если вы используете пакет 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 строка	Файл с сертификатами CA для https соединений
description строка	Описание политики.
host строка	Хост агента Consul, по умолчанию `localhost`. По умолчанию: `"localhost"`
name строка / обязательно	Имя политики, оно прозрачно для Consul.
port целое число	Порт агента Consul. По умолчанию: `8500`
rules строка	Документ правил, связанный с данной политикой.
scheme строка	Схема протокола агента Consul. По умолчанию `http`, может быть `https`, для защищённых соединений. По умолчанию: `"http"`
state строка	Присутствует или отсутствует политика. Варианты: `"present"` ← (по умолчанию) `"absent"`
token строка	Токен для авторизации.
valid_datacenters список / элементы=строка	Допустимые дата-центры для политики. Все, если список пустой.
validate_certs логическое значение	Проверка 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 В режиме проверки различие пропустит операционные атрибуты.	Возвращает детали изменений (или, возможно, требующих изменений в `check_mode`), когда режим diff активен.

Примеры

- 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 строка	Выполненная операция. Возвращается: changed Пример: `"update"`
policy словарь	Политика, возвращенная API Consul HTTP. Возвращается: всегда Пример: `{"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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/consul_policy_module.html