community.general.consul_role модуль — Управление ролями Consul

Примечание

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

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

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

Для использования в книге задач укажите: community.general.consul_role.

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

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

Обзор

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

Параметры

Параметр	Комментарии
ca_path строка	Файл с набором сертификатов CA для подключения по протоколу HTTPS
description строка	Описание роли. Если не указано, присвоенное описание не будет изменено.
host строка	Хост агента consul, по умолчанию `localhost`. По умолчанию: `"localhost"`
name строка / обязательно	Имя роли для идентификации.
node_identities список / элементы=словарь	Список идентификаторов узлов для прикрепления к роли. Если не указано, любые текущие идентификаторы узлов не будут изменены. Если параметр является пустым массивом (`[]`), любые присвоенные идентификаторы узлов будут удалены.
datacenter строка / обязательно	Центер данных узла. Это приведет к тому, что эффективная политика будет действительна только в этом центре данных.
node_name псевдонимы: name строка / обязательно	Имя узла. Длина должна быть не более 256 символов, должна начинаться и заканчиваться строчной буквой или цифрой. Может содержать только строчные буквы, цифры, - и _. Этот подпараметр был переименован из `node_identities[].name` в `node_identities[].node_name` в community.general 8.3.0. Старое имя по-прежнему можно использовать.
policies список / элементы=словарь	Список политик для присоединения к роли. Каждая политика — словарь. Если параметр опущен, любые текущие присоединенные политики не будут изменены. Пустой массив (`[]`) очистит ранее установленные политики.
id строка	Идентификатор политики, прикрепляемой к данной роли; см. community.general.consul_policy для получения дополнительной информации. Должен быть указан либо этот, либо `policies[].name`.
name строка	Имя политики, прикрепляемой к роли; см. community.general.consul_policy для получения дополнительной информации. Должен быть указан либо этот, либо `policies[].id`.
port целое число	Порт, на котором работает агент consul. По умолчанию: `8500`
scheme строка	Протокол, используемый агентом consul. По умолчанию `http`, можно изменить на `https` для безопасных соединений. По умолчанию: `"http"`
service_identities список / элементы=словарь	Список идентификаторов служб для прикрепления к роли. Если не указано, любые текущие идентификаторы служб не будут изменены. Если параметр является пустым массивом (`[]`), любые присвоенные идентификаторы узлов будут удалены.
datacenters список / элементы=строка	Центры данных, в которых политики будут действовать. Это приведет к тому, что эффективная политика будет действительна только в этом центре данных. Если указан пустой массив (`[]`), политики будут действительны во всех центрах данных. включая те, которые еще не существуют, но могут появиться в будущем.
service_name псевдонимы: name строка / обязательно	Имя узла. Длина должна быть не более 256 символов, должна начинаться и заканчиваться строчной буквой или цифрой. Может содержать только строчные буквы, цифры, - и _. Этот подпараметр был переименован из `service_identities[].name` в `service_identities[].service_name` в community.general 8.3.0. Старое имя по-прежнему можно использовать.
state строка	устанавливать роль как присутствующую или отсутствующую. Варианты: `"present"` ← (по умолчанию) `"absent"`
templated_policies список / элементы=словарь добавлен в community.general 8.3.0	Список шаблонизированных политик, которые должны быть применены к роли.
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	Поддержка: частичная Добавлен в community.general 8.3.0 В режиме проверки различие пропустит операционные атрибуты.	Вернет подробности о том, что изменилось (или, возможно, нужно изменить в `check_mode`), когда режим отличается.

Примеры

- name: Create a role with 2 policies
  community.general.consul_role:
    host: consul1.example.com
    token: some_management_acl
    name: foo-role
    policies:
      - id: 783beef3-783f-f41f-7422-7087dc272765
      - name: "policy-1"

- name: Create a role with service identity
  community.general.consul_role:
    host: consul1.example.com
    token: some_management_acl
    name: foo-role-2
    service_identities:
      - name: web
        datacenters:
          - dc1

- name: Create a role with node identity
  community.general.consul_role:
    host: consul1.example.com
    token: some_management_acl
    name: foo-role-3
    node_identities:
      - name: node-1
        datacenter: dc2

- name: Remove a role
  community.general.consul_role:
    host: consul1.example.com
    token: some_management_acl
    name: foo-role-3
    state: absent

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

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

Ключ	Описание
operation строка	Выполненная операция с ролью. Возвращается: changed Пример: `"update"`
role словарь	Объект роли. Возвращается: success Пример: `{"CreateIndex": 39, "Description": "", "Hash": "Trt0QJtxVEfvTTIcdTUbIJRr6Dsi6E4EcwSFxx9tCYM=", "ID": "9a300b8d-48db-b720-8544-a37c0f5dafb5", "ModifyIndex": 39, "Name": "foo-role", "Policies": [{"ID": "b1a00172-d7a1-0e66-a12e-7a4045c4b774", "Name": "foo-access"}]}`

Авторы

Håkon Lerring (@Hakon)

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

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