Модуль sensu.sensu_go.cluster_role – Управление ролями кластера 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.

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

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

Описание

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

Требования

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

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` ← (по умолчанию)
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 строка	Целевое состояние объекта Sensu. Варианты: `"present"` ← (по умолчанию) `"absent"`

См. также

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

Примеры

- 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 словарь	Объект, представляющий роль кластера Sensu. Возвращаемое значение: success Пример: `{"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–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_module.html