sensu.sensu_go.role_binding – Управление связями ролей Sensu

Примечание

Этот плагин входит в состав коллекции sensu.sensu_go (версия 1.8.0).

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

Для использования в книге задач укажите: sensu.sensu_go.role_binding.

Новое в версии 1.0.0: sensu.sensu_go

Обзор
Требования
Параметры
См. также
Примеры
Возвращаемые значения

Обзор

Создание, обновление или удаление связей ролей Sensu.
Для получения дополнительной информации обратитесь к документации Sensu по адресу https://docs.sensu.io/sensu-go/latest/reference/rbac/#role-bindings-and-cluster-role-bindings.

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

python >= 2.7

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
auth словарь			Параметры аутентификации. Можно также определить каждый из них с помощью переменной среды.
	api_key строка добавлено в 1.3.0 sensu.sensu_go		Ключ API, который следует использовать при аутентификации. Если он не задан, будет проверена переменная среды SENSU_API_KEY. Заменяет параметры auth.user и auth.password. Дополнительную информацию о ключе API можно найти в официальной документации Sensu по адресу https://docs.sensu.io/sensu-go/latest/guides/use-apikey-feature/.
	ca_path путь добавлено в 1.5.0 sensu.sensu_go		Путь к пакету сертификатов CA, который следует использовать для проверки сертификата бэкенда. Если этот параметр не задан, модуль будет использовать пакет CA, используемый Python. Также можно задать этот параметр через переменную среды SENSU_CA_PATH.
	password строка	Значение по умолчанию: "P@ssw0rd!"	Пароль пользователя Sensu. Если он не задан, будет проверена переменная среды SENSU_PASSWORD. Этот параметр игнорируется, если задан параметр auth.api_key.
	url строка	Значение по умолчанию: "http://localhost:8080"	Расположение API бэкенда Sensu. Если он не задан, будет проверена переменная среды SENSU_URL.
	user строка	Значение по умолчанию: "admin"	Имя пользователя для подключения к API Sensu. Если он не задан, будет проверена переменная среды SENSU_USER. Этот параметр игнорируется, если задан параметр auth.api_key.
	verify логический тип добавлено в 1.5.0 sensu.sensu_go	Варианты: нет да ←	Флаг, управляющий проверкой сертификатов. Если вы используете самозаверяющие сертификаты, можно установить этот параметр в `false`. Используйте этот параметр ТОЛЬКО в сценариях разработки! В случае использования самозаверяющих сертификатов в продакшене, обратитесь к параметру auth.ca_path. Также можно задать этот параметр через переменную среды SENSU_VERIFY.
cluster_role строка			Имя кластерной роли. Обратите внимание, что resультирующая привязка роли предоставляет кластерную роль предоставленным пользователям и группам только в контексте auth.namespace. Этот параметр несовместим с параметром role.
groups список / элементы=строка			Список групп, которые должны быть привязаны к роли или кластерной роли. Обратите внимание, что при создании привязки роли необходимо указать хотя бы один из параметров users и groups.
name строка / требуется			Имя ресурса Sensu. Это имя (в сочетании с пространством имен, где применимо) однозначно идентифицирует ресурс, над которым работает Ansible. Если ресурс с выбранным именем уже существует, Ansible-модуль обновит его, чтобы соответствовать спецификации в задаче. Обратитесь к спецификации атрибута метаданных name в документации upstream по адресу https://docs.sensu.io/sensu-go/latest/reference/ для получения более подробной информации о допустимых именах и других ограничениях.
namespace строка		Значение по умолчанию: "default"	Пространство имен RBAC для работы. Если не задано, используется значение переменной среды SENSU_NAMESPACE.
role строка			Имя роли. Этот параметр несовместим с параметром cluster_role.
state строка		Варианты: present ← absent	Целевое состояние объекта Sensu.
users список / элементы=строка			Список пользователей, которые должны быть привязаны к роли или кластерной роли. Обратите внимание, что при создании привязки роли необходимо указать хотя бы один из параметров users и groups.

См. также

sensu.sensu_go.role_binding_info: Официальная документация по модулю sensu.sensu_go.role_binding_info.
sensu.sensu_go.role: Официальная документация по модулю sensu.sensu_go.role.
sensu.sensu_go.cluster_role: Официальная документация по модулю sensu.sensu_go.cluster_role.
sensu.sensu_go.cluster_role_binding: Официальная документация по модулю sensu.sensu_go.cluster_role_binding.

Примеры

- name: Create a role binding
  sensu.sensu_go.role_binding:
    name: dev_and_testing
    role: testers_permissive
    groups:
      - testers
      - dev
      - ops
    users:
      - alice

- name: Create a role binding for admins
  sensu.sensu_go.role_binding:
    name: org-admins
    cluster_role: admin
    groups:
      - team1-admins
      - team2-admins

- name: Delete a role binding
  sensu.sensu_go.role_binding:
    name: org-admins
    state: absent

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

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

Ключ	Возвращаемое значение	Описание
object словарь	успех	Объект, представляющий связь роли Sensu. Пример: {'metadata': {'name': 'event-reader-binding', 'namespace': 'default'}, 'role_ref': {'name': 'event-reader', 'type': 'Role'}, 'subjects': [{'name': 'bob', 'type': 'User'}]}

Авторы

Paul Arthur (@flowerysong)
Manca Bizjak (@mancabizjak)
Aljaz Kosir (@aljazkosir)
Tadej Borovsak (@tadeboro)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/sensu/sensu_go/role_binding_module.html