Spec-Zone.ru › Ansible

Модуль sensu.sensu_go.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.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/ для получения более подробной информации о допустимых именах и других ограничениях.

namespace

строка

Пространство имен RBAC для работы. Если этот параметр не задан, используется значение переменной среды SENSU_NAMESPACE.

Значение по умолчанию: "default"

rules

список / элементы=словарь

Правила, которые применяет роль.

Должно быть непустым, если state равен present

resource_names

список / элементы=строка

Имена конкретных ресурсов, к которым правило имеет разрешение доступа.

Обратите внимание, что для глагола create, этот аргумент не будет учитываться при принудительном применении RBAC, даже если он предоставлен.

resources

список / элементы=строка / обязательно

Типы ресурсов, к которым правило имеет разрешение доступа.

verbs

список / элементы=строка / обязательно

Разрешения, которые должны применяться правилом.

Доступные значения:

  • "get"
  • "list"
  • "create"
  • "update"
  • "delete"

state

строка

Целевое состояние объекта Sensu.

Доступные значения:

  • "present" ← (значение по умолчанию)
  • "absent"

См. также

См. также

sensu.sensu_go.role_info

Список ролей Sensu.

sensu.sensu_go.cluster_role

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

sensu.sensu_go.role_binding

Управление привязками ролей Sensu.

Примеры

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

Возвращено: success

Пример: {"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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/sensu/sensu_go/role_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API