consul_acl - Управление ключами и правилами Consul ACL

Новое в версии 2.0.

Обзор
- Требования
Параметры
Примеры
Значения возврата
Статус
Техническое обслуживание
- Автор

Обзор

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

Требования

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

python >= 2.6
python-consul
pyhcl
requests

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
host	Значение по умолчанию: "localhost"	Хост агента consul, по умолчанию localhost
mgmt_token		Для управления списками ACL требуется маркер управления.
name		Имя, которое должно быть связано с ключом ACL, для Consul оно не имеет значения.
port	Значение по умолчанию: 8500	Порт, на котором работает агент consul.
rules		Список правил, которые должны быть связаны с данным токеном.
scheme (добавлено в 2.1)	Значение по умолчанию: "http"	Схема протокола, на котором работает агент consul.
state	Варианты: present ← absent	Признак того, должен ли набор ACL быть присутствующим или отсутствующим.
token		Ключ токена, определяющий набор правил ACL. Если сгенерирован consul, это будет UUID.
token_type	Варианты: client ← management	Тип токена, который должен быть создан: management или client.
validate_certs (добавлено в 2.1)	Значение по умолчанию: "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 (ID ACL). Пример: a2ec332f-04cf-6fba-e8b8-acf62444d3da

Статус

Этот модуль помечен как preview, что означает, что его интерфейс не гарантируется как обратной совместимости.

Техническое обслуживание

Этот модуль помечен как community, что означает, что он поддерживается сообществом Ansible. Подробнее см. Техническое обслуживание и поддержка модулей.

Список других модулей, поддерживаемых сообществом Ansible, см. здесь.

Автор

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.6/modules/consul_acl_module.html