consul_acl – Управление ключами и правилами доступа Consul

Обзор
Требования
Параметры
Примеры
Возвращаемые значения
Статус

Обзор

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

Требования

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

python-consul
pyhcl
requests

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
host -	Значение по умолчанию: "localhost"	Хост агента Consul, по умолчанию localhost
mgmt_token -		Требуется маркер управления для изменения списков ACL
name -		Имя, которое должно быть связано с ключом ACL, оно невидимо для Consul
port целое число	Значение по умолчанию: 8500	Порт, на котором работает агент Consul
rules список		Правила, которые должны быть связаны с заданным токеном
scheme -	Значение по умолчанию: "http"	Схема протокола, на котором работает агент Consul
state -	Варианты: present ← absent	Требуется ли пара ACL или нет
token -		Ключ токена, идентифицирующий набор правил ACL. Если сгенерировано Consul, это будет UUID
token_type -	Варианты: client ← management	Тип токена, который должен быть создан
validate_certs boolean	Варианты: no yes ←	Требуется ли проверка TLS-сертификата агента Consul

Примеры

- name: create an ACL with rules
  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
  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
  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
  consul_acl:
    host: consul1.example.com
    mgmt_token: some_management_acl
    token: 172bd5c8-9fe9-11e4-b1b0-3c15c2c9fd5e
    state: absent

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

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

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

Статус

Этот модуль не гарантирует обратной совместимости. [preview]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

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

Подсказка

Если вы обнаружите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/consul_acl_module.html