sensu.sensu_go.cluster_role – Управление ролями кластера Sensu

Примечание

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

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

Для использования в плейбуке укажите: sensu.sensu_go.cluster_role.

Новое в версии 1.0.0: плагина sensu.sensu_go

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

Описание

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

Требования

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

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	Варианты: no да ←	Флаг, контролирующий проверку сертификатов. Если вы используете самоподписанные сертификаты, можно задать этот параметр в значение `false`. ИСПОЛЬЗУЙТЕ ЭТОТ ПАРАМЕТР ТОЛЬКО В СЦЕНАРИЯХ РАЗРАБОТКИ! Если вы используете самоподписанные сертификаты в продакшене, см. параметр auth.ca_path. Также можно задать этот параметр через переменную среды SENSU_VERIFY.
name строка / обязательный			Имя ресурса Sensu. Это имя (в сочетании с пространством имён, где применимо) однозначно идентифицирует ресурс, с которым работает Ansible. Если ресурс с выбранным именем уже существует, модуль Ansible обновит его, чтобы он соответствовал спецификации в задаче. Обратитесь к спецификации атрибута метаданных name в документации источника по адресу https://docs.sensu.io/sensu-go/latest/reference/ для получения более подробной информации о допустимых именах и других ограничениях.
rules список / элементы=словарь			Правила, применяемые к роли кластера. Должно быть непустым, если state имеет значение `present`.
	resource_names список / элементы=строка		Имена конкретных ресурсов, к которым правило имеет разрешение доступа. Обратите внимание, что для глагола `create`, этот аргумент не будет учитываться при применении RBAC, даже если он предоставлен.
	resources список / элементы=строка / обязательный		Типы ресурсов, к которым правило имеет разрешение доступа.
	verbs список / элементы=строка / обязательный	Варианты: get list create update delete	Разрешения, которые должно применять правило.
state строка		Варианты: present ← absent	Целевое состояние объекта Sensu.

См. также

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

Примеры

- name: Create a cluster role
  sensu.sensu_go.cluster_role:
    name: readonly
    rules:
      - verbs:
          - get
          - list
        resources:
          - checks
          - entities

- name: Delete a cluster role
  sensu.sensu_go.cluster_role:
    name: readonly
    state: absent

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

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

Ключ	Возвращаемое значение	Описание
object словарь	success	Объект, представляющий роль кластера Sensu. Пример: {'metadata': {'name': 'cluster-role'}, 'rules': [{'resource_names': ['sample-name'], 'resources': ['assets', 'checks'], 'verbs': ['get', 'list']}]}

Авторы

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_module.html