sensu.sensu_go.cluster_role_binding – Управление связями Sensu кластерных ролей

Примечание

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

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

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

Новый в версии 1.0.0: of 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 строка			Имя кластерной роли. Требуется, если state равно `present`.
groups список / элементы=строка			Список групп, которым нужно связать кластерную роль. Обратите внимание, что при создании связи кластерной роли необходимо указать хотя бы один из параметров users и groups.
name строка / обязательный			Имя ресурса Sensu. Это имя (в сочетании с пространством имен, если применимо) однозначно идентифицирует ресурс, с которым взаимодействует Ansible. Если ресурс с выбранным именем уже существует, модуль Ansible обновит его в соответствии со спецификацией в задаче. См. спецификацию атрибута метаданных name в документации upstream по адресу https://docs.sensu.io/sensu-go/latest/reference/ для получения дополнительной информации о допустимых именах и других ограничениях.
state строка		Варианты: present ← absent	Целевое состояние объекта Sensu.
users список / элементы=строка			Список пользователей, которым нужно связать кластерную роль. Обратите внимание, что при создании связи кластерной роли необходимо указать хотя бы один из параметров users и groups.

См. также

sensu.sensu_go.cluster_role_binding_info: Официальная документация модуля sensu.sensu_go.cluster_role_binding_info.
sensu.sensu_go.cluster_role: Официальная документация модуля sensu.sensu_go.cluster_role.
sensu.sensu_go.role_binding: Официальная документация модуля sensu.sensu_go.role_binding.

Примеры

- name: Create a cluster role binding
  sensu.sensu_go.cluster_role_binding:
    name: all-cluster-admins
    cluster_role: cluster-admin
    groups:
      - cluster-admins
    users:
      - alice

- name: Delete a cluster role binding
  sensu.sensu_go.cluster_role_binding:
    name: all-cluster-admins
    state: absent

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

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

Ключ	Возвращаемое значение	Описание
object словарь	успех	Объект, представляющий связь кластерной роли Sensu. Пример: {'metadata': {'name': 'cluster-admin'}, 'role_ref': {'name': 'cluster-admin', 'type': 'ClusterRole'}, 'subjects': [{'name': 'cluster-admins', 'type': 'Group'}]}

Авторы

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/cluster_role_binding_module.html