Модуль sensu.sensu_go.role_binding – Управление привязками ролей Sensu

Примечание

Этот модуль является частью коллекции sensu.sensu_go (версия 1.14.0).

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

Для установки используйте: ansible-galaxy collection install sensu.sensu_go. Для использования этого модуля требуются дополнительные зависимости. Подробности см. в разделе Требования.

Чтобы использовать его в плейбуке, укажите: sensu.sensu_go.role_binding.

Добавлена в sensu.sensu_go 1.0.0

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

Описание

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

Требования

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

python >= 2.7

Параметры

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

См. также

sensu.sensu_go.role_binding_info: Список связываний ролей Sensu.
sensu.sensu_go.role: Управление ролями Sensu.
sensu.sensu_go.cluster_role: Управление ролями кластера Sensu.
sensu.sensu_go.cluster_role_binding: Управление связываними ролей кластера Sensu.

Примеры

- 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. Возвращаемое значение: success Пример: `{"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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/sensu/sensu_go/role_binding_module.html