Модуль community.general.consul_auth_method — управление методами аутентификации Consul

Примечание

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

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

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

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

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

Краткое описание
Параметры
Атрибуты
Примеры
Возвращаемые значения

Краткое описание

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

Параметры

Параметр	Комментарии
ca_path string	Пакет сертификатов CA для HTTPS-подключений.
config dictionary	Необработанная конфигурация для выбранного метода аутентификации. Содержимое зависит от выбранного `type`. Обязательный параметр при создании метода аутентификации.
description string	Произвольное понятное пользователю описание метода аутентификации.
display_name string	Необязательное имя, отображаемое вместо `name` при выводе информации об этом методе аутентификации.
host string	Хост агента Consul. По умолчанию: `"localhost"`
max_token_ttl string	Задает максимальный срок действия любого токена, созданного этим методом аутентификации. Можно указать в формате `60s` или `5m` (то есть 60 секунд или 5 минут соответственно).
name string / обязательный	Задает имя метода аутентификации ACL. Имя может содержать буквенно-цифровые символы, дефисы `-` и символы подчеркивания `_`.
port integer	Порт, на котором работает агент Consul. По умолчанию: `8500`
scheme string	Схема протокола, используемая агентом Consul. По умолчанию используется `http`; для защищенных подключений можно задать `https`. По умолчанию: `"http"`
state string	Должен ли токен присутствовать или отсутствовать. Варианты: `"present"` ← (по умолчанию) `"absent"`
token string	Токен для авторизации.
token_locality string	Определяет тип токена, который должен создавать этот метод аутентификации. Варианты: `"local"` `"global"`
type string	Тип настраиваемого метода аутентификации. Это поле неизменяемо. Обязательный параметр при создании метода аутентификации. Варианты: `"kubernetes"` `"jwt"` `"oidc"` `"aws-iam"`
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	Поддержка: partial В режиме проверки в diff не отображаются эксплуатационные атрибуты.	В режиме diff возвращает сведения об изменениях (или о возможных изменениях в `check_mode`).

Примеры

- name: Create an auth method
  community.general.consul_auth_method:
    name: test
    type: jwt
    config:
      jwt_validation_pubkeys:
        - |
          -----BEGIN PUBLIC KEY-----
          MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAu1SU1LfVLPHCozMxH2Mo
          4lgOEePzNm0tRgeLezV6ffAt0gunVTLw7onLRnrq0/IzW7yWR7QkrmBL7jTKEn5u
          +qKhbwKfBstIs+bMY2Zkp18gnTxKLxoS2tFczGkPLPgizskuemMghRniWaoLcyeh
          kd3qqGElvW/VDL5AaWTg0nLVkjRo9z+40RQzuVaE8AkAFmxZzow3x+VJYKdjykkJ
          0iT9wCS0DRTXu269V264Vf/3jvredZiKRkgwlL9xNAwxXFg0x/XFw005UWVRIkdg
          cKWTjpBP2dPwVZ4WWC+9aGVd+Gyn1o0CLelf4rEjGoXbAAEgAqeGUxrcIlbjXfbc
          mwIDAQAB
          -----END PUBLIC KEY-----
    token: "{{ consul_management_token }}"

- name: Delete auth method
  community.general.consul_auth_method:
    name: test
    state: absent
    token: "{{ consul_management_token }}"

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

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

Ключ	Описание
auth_method dictionary	Метод аутентификации в формате, возвращаемом HTTP API Consul. Возвращается: всегда Пример: {"Config": {"JWTValidationPubkeys": ["-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAu1SU1LfVLPHCozMxH2Mo\n4lgOEePzNm0tRgeLezV6ffAt0gunVTLw7onLRnrq0/IzW7yWR7QkrmBL7jTKEn5u\n+qKhbwKfBstIs+bMY2Zkp18gnTxKLxoS2tFczGkPLPgizskuemMghRniWaoLcyeh\nkd3qqGElvW/VDL5AaWTg0nLVkjRo9z+40RQzuVaE8AkAFmxZzow3x+VJYKdjykkJ\n0iT9wCS0DRTXu269V264Vf/3jvredZiKRkgwlL9xNAwxXFg0x/XFw005UWVRIkdg\ncKWTjpBP2dPwVZ4WWC+9aGVd+Gyn1o0CLelf4rEjGoXbAAEgAqeGUxrcIlbjXfbc\nmwIDAQAB\n-----END PUBLIC KEY-----"]}, "CreateIndex": 416, "ModifyIndex": 487, "Name": "test", "Type": "jwt"}
operation string	Выполненная операция. Возвращается: changed Пример: `"update"`

Ключ

Описание

auth_method

dictionary

Метод аутентификации в формате, возвращаемом HTTP API Consul.

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

Пример: {"Config": {"JWTValidationPubkeys": ["-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAu1SU1LfVLPHCozMxH2Mo\n4lgOEePzNm0tRgeLezV6ffAt0gunVTLw7onLRnrq0/IzW7yWR7QkrmBL7jTKEn5u\n+qKhbwKfBstIs+bMY2Zkp18gnTxKLxoS2tFczGkPLPgizskuemMghRniWaoLcyeh\nkd3qqGElvW/VDL5AaWTg0nLVkjRo9z+40RQzuVaE8AkAFmxZzow3x+VJYKdjykkJ\n0iT9wCS0DRTXu269V264Vf/3jvredZiKRkgwlL9xNAwxXFg0x/XFw005UWVRIkdg\ncKWTjpBP2dPwVZ4WWC+9aGVd+Gyn1o0CLelf4rEjGoXbAAEgAqeGUxrcIlbjXfbc\nmwIDAQAB\n-----END PUBLIC KEY-----"]}, "CreateIndex": 416, "ModifyIndex": 487, "Name": "test", "Type": "jwt"}

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_auth_method_module.html