Модуль community.general.consul_binding_rule – управление правилами привязки Consul

Примечание

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

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

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

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

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

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

Обзор

Позволяет добавлять, изменять и удалять правила привязки в кластере Consul с помощью агента. Подробнее об использовании и настройке правил привязки см. в документации https://developer.hashicorp.com/consul/api-docs/acl/binding-rules.

Параметры

Параметр	Комментарии
auth_method string / обязательный	Имя метода аутентификации, к которому применяется это правило.
bind_name string	Имя, привязываемое к токену во время входа в систему. Объект привязки можно изменить, задав разные значения параметра `bind_type`.
bind_type string	Определяет, как правило привязки влияет на токен, создаваемый при входе в систему. Варианты: `"service"` `"node"` `"role"` `"templated-policy"`
bind_vars dictionary	Задаёт шаблонные переменные политики, если для параметра `bind_type` установлено значение `templated-policy`.
ca_path string	Пакет сертификатов CA для HTTPS-подключений.
description string	Описание правила привязки в свободной форме, понятное человеку.
host string	Имя хоста агента Consul. По умолчанию: `"localhost"`
name string / обязательный	Задаёт имя правила привязки. Примечание: это имя используется для идентификации правила привязки. Однако, поскольку API не поддерживает имена, оно добавляется в начало описания.
port integer	Порт, на котором работает агент Consul. По умолчанию: `8500`
scheme string	Схема протокола, по которой работает агент Consul. По умолчанию используется `http`; для защищённых подключений можно задать `https`. По умолчанию: `"http"`
selector string	Задаёт выражение, используемое для сопоставления этого правила с допустимыми идентификаторами, возвращаемыми при проверке метода аутентификации. Если значение пустое, это правило привязки соответствует всем допустимым идентификаторам, возвращаемым методом аутентификации.
state string	Должно ли правило привязки присутствовать или отсутствовать. Варианты: `"present"` ← (по умолчанию) `"absent"`
token string	Токен для авторизации.
validate_certs boolean	Проверять ли TLS-сертификат агента Consul. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
action_group	Группа действий: community.general.consul	Используйте `group/community.general.consul` в `module_defaults`, чтобы задать значения по умолчанию для этого модуля.
check_mode	Поддержка: full	Модуль может работать в режиме `check_mode` и возвращать прогноз изменения статуса, не изменяя целевой объект.
diff_mode	Поддержка: частичная В режиме проверки в diff не отображаются операционные атрибуты.	В режиме diff возвращает сведения об изменениях (или о том, что, возможно, нужно изменить в `check_mode`).

Примеры

- name: Create a binding rule
  community.general.consul_binding_rule:
    name: my_name
    description: example rule
    auth_method: minikube
    bind_type: service
    bind_name: "{{ serviceaccount.name }}"
    token: "{{ consul_management_token }}"

- name: Remove a binding rule
  community.general.consul_binding_rule:
    name: my_name
    auth_method: minikube
    state: absent

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

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

Ключ	Описание
binding_rule dictionary	Правило привязки в том виде, в котором его возвращает HTTP API Consul. Возвращается: всегда Пример: `{"AuthMethod": "minikube", "BindName": "{{ serviceaccount.name }}", "BindType": "service", "CreateIndex": 30, "Description": "my_name: example rule", "ID": "59c8a237-e481-4239-9202-45f117950c5f", "ModifyIndex": 33, "Selector": "serviceaccount.namespace==default"}`
operation string	Выполненная операция. Возвращается: changed Пример: `"update"`

Ключ

Описание

binding_rule

dictionary

Правило привязки в том виде, в котором его возвращает HTTP API Consul.

Возвращается: всегда

Пример: {"AuthMethod": "minikube", "BindName": "{{ serviceaccount.name }}", "BindType": "service", "CreateIndex": 30, "Description": "my_name: example rule", "ID": "59c8a237-e481-4239-9202-45f117950c5f", "ModifyIndex": 33, "Selector": "serviceaccount.namespace==default"}

operation

string

Выполненная операция.

Возвращается: changed

Пример: "update"

Авторы

Florian Apolloner (@apollo13)

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

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