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

Примечание

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

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

Для установки используйте: ansible-galaxy collection install community.general.

Для использования в playbook, укажите: 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`. По умолчанию: `"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	Поддержка: полная	Может работать в режиме `check_mode` и возвращать прогноз состояния «изменено» без изменения цели.
diff_mode	Поддержка: частичная В режиме проверки diff будет пропускать операционные атрибуты.	Возвращает подробную информацию о том, что изменилось (или, возможно, нуждается в изменении в `check_mode`), когда находится в diff-режиме.

Примеры

- 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 словарь	Правило привязки, возвращаемое API Consul HTTP. Возвращается: всегда Пример: `{"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 строка	Выполненная операция. Возвращается: changed Пример: `"update"`

Ключ

Описание

binding_rule

словарь

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

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

Пример: {"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

строка

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

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

Пример: "update"

Авторы

Florian Apolloner (@apollo13)

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

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