Модуль community.general.consul_acl – Управление ключами и правилами ACL Consul

Примечание

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

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

Для её установки используйте: ansible-galaxy collection install community.general. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробной информации.

Для использования в плейбуке укажите: community.general.consul_acl.

УСТАРЕВШИЙ
Синопсис
Требования
Параметры
Атрибуты
Примеры
Возвращаемые значения
Статус

УСТАРЕВШИЙ

Удалено в:: версии 10.0.0
Почему:: Устаревшая система ACL была удалена из Consul.
Альтернатива:: Используйте community.general.consul_token и/или community.general.consul_policy вместо этого.

Синопсис

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

Требования

Ниже перечислены требования, которые должны быть выполнены на хосте, на котором выполняется этот модуль.

python-consul
pyhcl
requests

Параметры

Параметр	Комментарии
host строка	хост агента consul, по умолчанию localhost По умолчанию: `"localhost"`
mgmt_token строка / обязательно	необходим токен управления для манипулирования списками acl
name строка	имя, которое должно быть связано с ключом acl; оно не имеет смысла для Consul
port целое число	порт, на котором работает агент consul По умолчанию: `8500`
rules список / элементы=словарь	правила, которые должны быть связаны с данным токеном
scheme строка	схема протокола, на котором работает агент consul По умолчанию: `"http"`
state строка	указывается, должен ли набор ACL существовать или отсутствовать Варианты: `"present"` ← (по умолчанию) `"absent"`
token строка	ключ токена, идентифицирующий набор правил ACL. Если сгенерирован consul, это будет UUID
token_type строка	тип токена, который нужно создать Варианты: `"client"` ← (по умолчанию) `"management"`
validate_certs логическое значение	выполнять ли проверку сертификата TLS агента consul Варианты: `false` `true` ← (по умолчанию)

Атрибуты

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

Примеры

- name: Create an ACL with rules
  community.general.consul_acl:
    host: consul1.example.com
    mgmt_token: some_management_acl
    name: Foo access
    rules:
      - key: "foo"
        policy: read
      - key: "private/foo"
        policy: deny

- name: Create an ACL with a specific token
  community.general.consul_acl:
    host: consul1.example.com
    mgmt_token: some_management_acl
    name: Foo access
    token: my-token
    rules:
      - key: "foo"
        policy: read

- name: Update the rules associated to an ACL token
  community.general.consul_acl:
    host: consul1.example.com
    mgmt_token: some_management_acl
    name: Foo access
    token: some_client_token
    rules:
      - event: "bbq"
        policy: write
      - key: "foo"
        policy: read
      - key: "private"
        policy: deny
      - keyring: write
      - node: "hgs4"
        policy: write
      - operator: read
      - query: ""
        policy: write
      - service: "consul"
        policy: write
      - session: "standup"
        policy: write

- name: Remove a token
  community.general.consul_acl:
    host: consul1.example.com
    mgmt_token: some_management_acl
    token: 172bd5c8-9fe9-11e4-b1b0-3c15c2c9fd5e
    state: absent

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

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

Ключ	Описание
operation строка	выполненная операция над ACL Возвращается: changed Пример: `"update"`
rules словарь	представление правил ACL в формате HCL JSON, как описано в документации Consul (https://www.consul.io/docs/guides/acl.html#rule-specification). Возвращается: когда `state=present` Пример: `{"key": {"bar": {"policy": "deny"}, "foo": {"policy": "write"}}}`
token строка	токен, связанный с ACL (ID ACL) Возвращается: success Пример: `"a2ec332f-04cf-6fba-e8b8-acf62444d3da"`

Статус

Этот модуль будет удален в версии 10.0.0. [устаревший]
Для получения дополнительной информации см. УСТАРЕВШИЙ.

Авторы

Steve Gargan (@sgargan)
Colin Nolan (@colin-nolan)

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

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