Модуль sensu.sensu_go.cluster_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.cluster_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. Значение по умолчанию: |
|
url строка |
Местоположение API бэкенда Sensu. Если не задан, будет проверена переменная среды SENSU_URL. Значение по умолчанию: |
|
user строка |
Имя пользователя для подключения к API Sensu. Если не задан, будет проверена переменная среды SENSU_USER. Этот параметр игнорируется, если задан параметр auth.api_key. Значение по умолчанию: |
|
verify булево добавлен в sensu.sensu_go 1.5.0 |
Флаг, контролирующий проверку сертификата. Если вы используете самозаверяемые сертификаты, можно установить этот параметр в ИСПОЛЬЗУЙТЕ ЭТОТ ПАРАМЕТР ТОЛЬКО В СЦЕНАРИЯХ РАЗРАБОТКИ! Если в производственной среде используются самозаверяемые сертификаты, см. параметр auth.ca_path. Также можно задать этот параметр через переменную среды SENSU_VERIFY. Доступные значения:
|
cluster_role строка | Имя роли кластера. Требуется, если state равно |
groups список / элементы=строка | Список групп для привязки к роли кластера. Обратите внимание, что при создании привязки роли кластера необходимо указать хотя бы один из параметров users или groups. |
name строка / обязательный | Имя ресурса Sensu. Это имя (в сочетании с именем пространства имен, где это применимо) однозначно идентифицирует ресурс, над которым Ansible выполняет операции. Если ресурс с выбранным именем уже существует, модуль Ansible обновит его в соответствии со спецификацией в задаче. Для получения дополнительной информации о допустимых именах и других ограничениях см. метаданные атрибута name в документации по адресу https://docs.sensu.io/sensu-go/latest/reference/. |
state строка | Целевое состояние объекта Sensu. Доступные значения:
|
users список / элементы=строка | Список пользователей для привязки к роли кластера. Обратите внимание, что при создании привязки роли кластера необходимо указать хотя бы один из параметров users или groups. |
См. также
См. также
- sensu.sensu_go.cluster_role_binding_info
-
Вывод информации о привязках ролей кластера Sensu.
- sensu.sensu_go.cluster_role
-
Управление ролями кластера Sensu.
- sensu.sensu_go.role_binding
-
Управление привязками ролей Sensu.
Примеры
- 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. Возвращено: успешно Пример: |
Ссылки на коллекции
© 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/cluster_role_binding_module.html