sensu.sensu_go.role – Управление ролями Sensu

Примечание

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

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

Чтобы использовать его в книге задач, укажите: sensu.sensu_go.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 в документации upstream по адресу https://docs.sensu.io/sensu-go/latest/reference/ для получения дополнительных сведений о допустимых именах и других ограничениях.
namespace строка		Значение по умолчанию: "default"	Пространство имен RBAC для работы. Если он не задан, будет использовано значение переменной среды SENSU_NAMESPACE.
rules список / элементы=словарь			Правила, применяемые ролью. Должно быть непустым, если state равно `present`.
	resource_names список / элементы=строка		Имена конкретных ресурсов, к которым правило имеет разрешение на доступ. Обратите внимание, что для глагола `create`, этот аргумент не будет учитываться при принудительном применении RBAC, даже если он указан.
	resources список / элементы=строка / обязательно		Типы ресурсов, к которым правило имеет разрешение на доступ.
	verbs список / элементы=строка / обязательно	Варианты: get list create update delete	Разрешения, которые должны применяться правилом.
state строка		Варианты: present ← absent	Целевое состояние объекта Sensu.

См. также

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

Примеры

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

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

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

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

Ключ	Возвращаемое значение	Описание
object словарь	успех	Объект, представляющий роль Sensu. Пример: {'metadata': {'name': 'namespaced-resources-all-verbs', 'namespace': 'default'}, 'rules': [{'resource_names': [], 'resources': ['assets', 'checks'], 'verbs': ['create', 'update', 'delete']}]}

Авторы

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