Spec-Zone.ru › Ansible

community.general.consul_token модуль — Управление токенами Consul

Примечание

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

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

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

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

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

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

Обзор

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

Параметры

Параметр

Комментарии

accessor_id

строка

Указывает UUID для использования в качестве идентификатора доступа токена. Если не указано, для этого поля будет сгенерирован UUID.

ca_path

строка

Файл с сертификатами CA для использования в https-соединениях

description

строка

Свободное текстовое описание токена, понятное человеку.

expiration_ttl

строка

Это вспомогательное поле, и если задано, оно инициализирует expiration_time. Может быть указано в формате 60s или 5m (соответственно, 60 секунд или 5 минут). Игнорируется при обновлении токена!

host

строка

Хост агента consul, по умолчанию localhost.

По умолчанию: "localhost"

local

логическое

Если true, указывает, что токен не должен реплицироваться глобально, а должен быть локальным для текущего дата-центра.

Варианты:

  • false
  • true

node_identities

список / элементы=словарь

Список идентификаторов узлов, которые нужно прикрепить к токену.

Если не указано, любые текущие назначенные идентификаторы узлов не будут изменены.

Если параметр пустой массив ([]), любые назначенные идентификаторы узлов будут отменены.

datacenter

строка / обязательно

Дата-центр узлов.

Это приведет к тому, что токен будет действовать только в этом дата-центре.

node_name

строка / обязательно

Имя узла.

Длина не должна превышать 256 символов, должна начинаться и заканчиваться строчной буквой или числом.

Может содержать только строчные буквы, цифры, а также - и _.

policies

список / элементы=словарь

Список политик, которые нужно прикрепить к токену. Каждая политика — это словарь.

Если параметр оставлен пустым, любые текущие назначенные политики не будут изменены.

Любой пустой массив ([]) очистит все ранее установленные политики.

id

строка

Идентификатор политики, которую нужно прикрепить к этому токену; см. community.general.consul_policy для получения дополнительной информации.

Должно быть указано либо это, либо policies[].name.

name

строка

Имя политики, которую нужно прикрепить к этому токену; см. community.general.consul_policy для получения дополнительной информации.

Должно быть указано либо это, либо policies[].id.

port

целое число

Порт, на котором работает агент consul.

По умолчанию: 8500

roles

список / элементы=словарь

Список ролей, которые нужно прикрепить к токену. Каждая роль — это словарь.

Если параметр оставлен пустым, любые текущие назначенные роли не будут изменены.

Любой пустой массив ([]) очистит все ранее установленные роли.

id

строка

Идентификатор роли, которую нужно прикрепить к этому токену; см. community.general.consul_role для получения дополнительной информации.

Должно быть указано либо это, либо roles[].name.

name

строка

Имя роли, которую нужно прикрепить к этому токену; см. community.general.consul_role для получения дополнительной информации.

Должно быть указано либо это, либо roles[].id.

scheme

строка

Протокол, по которому работает агент consul. По умолчанию http, может быть установлен на https для защищенных соединений.

По умолчанию: "http"

secret_id

строка

Указывает UUID для использования в качестве идентификатора секрета токена. Если не указано, для этого поля будет сгенерирован UUID.

service_identities

список / элементы=словарь

Список идентификаторов служб, которые нужно прикрепить к токену.

Если не указано, любые текущие назначенные идентификаторы служб не будут изменены.

Если параметр пустой массив ([]), любые назначенные идентификаторы узлов будут отменены.

datacenters

список / элементы=строка

Центры данных, в которых токен будет действовать.

Если указан пустой массив ([]), токен будет действителен во всех центрах данных.

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

service_name

строка / обязательно

Название службы.

Длина не должна превышать 256 символов, должно начинаться и заканчиваться строчной буквой алфавита или цифрой.

Может содержать только строчные буквы алфавита, цифры, а также - и _.

state

строка

Нужно ли присутствие токена или его отсутствие.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

templated_policies

список / элементы=словарь

Список шаблонизированных политик, которые должны быть применены к роли.

template_name

строка / обязательно

Название шаблонизированной политики.

template_variables

словарь

Переменные шаблонизированной политики.

Не все шаблонизированные политики требуют переменных.

token

строка

Токен, используемый для авторизации.

validate_certs

булево

Подтверждать ли сертификат TLS агента consul.

Варианты:

  • false
  • true ← (по умолчанию)

Атрибуты

Атрибут

Поддержка

Описание

action_group

Группа действий: community.general.consul

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

Используйте group/community.general.consul в module_defaults для установки значений по умолчанию для данного модуля.

check_mode

Поддержка: полная

Может работать в check_mode и возвращать прогноз изменённого статуса без изменения целевого объекта.

diff_mode

Поддержка: частичная

В режиме проверки различие пропустит рабочие атрибуты.

Возвратит подробную информацию о том, что изменилось (или, возможно, требует изменения в check_mode), когда используется режим сравнения.

Примеры

- name: Create / Update a token by accessor_id
  community.general.consul_token:
    state: present
    accessor_id: 07a7de84-c9c7-448a-99cc-beaf682efd21
    token: 8adddd91-0bd6-d41d-ae1a-3b49cfa9a0e8
    roles:
      - name: role1
      - name: role2
    service_identities:
      - service_name: service1
        datacenters: [dc1, dc2]
    node_identities:
      - node_name: node1
        datacenter: dc1
    expiration_ttl: 50m

- name: Delete a token
  community.general.consul_token:
    state: absent
    accessor_id: 07a7de84-c9c7-448a-99cc-beaf682efd21
    token: 8adddd91-0bd6-d41d-ae1a-3b49cfa9a0e8

Значения возврата

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

Ключ

Описание

operation

строка

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

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

Пример: "update"

token

словарь

Токен, возвращённый API consul по HTTP.

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

Пример: {"AccessorID": "07a7de84-c9c7-448a-99cc-beaf682efd21", "CreateIndex": 632, "CreateTime": "2024-01-14T21:53:01.402749174+01:00", "Description": "Testing", "Hash": "rj5PeDHddHslkpW7Ij4OD6N4bbSXiecXFmiw2SYXg2A=", "Local": false, "ModifyIndex": 633, "SecretID": "bd380fba-da17-7cee-8576-8d6427c6c930", "ServiceIdentities": [{"ServiceName": "test"}]}

Авторы

  • 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_token_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API