Модуль sensu.sensu_go.cluster – Управление кластерами Sensu Go

Примечание

Этот модуль является частью коллекции sensu.sensu_go (версия 1.14.0).

У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install sensu.sensu_go. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.

Чтобы использовать его в книге задач, укажите: sensu.sensu_go.cluster.

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

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

Описание

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

Требования

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

python >= 2.7

Параметры

Параметр	Комментарии
api_urls список / элементы=строка	Список URL API, составляющих один кластер. Требуется, если state равен `present`.
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 в документации upstream по адресу https://docs.sensu.io/sensu-go/latest/reference/ для получения более подробной информации о допустимых именах и других ограничениях.
state строка	Целевое состояние объекта Sensu. Варианты: `"present"` ← (по умолчанию) `"absent"`

См. также

sensu.sensu_go.cluster_info: Список доступных кластеров Sensu Go.

Примеры

- name: Create a small cluster
  sensu.sensu_go.cluster:
    name: small-cluster
    api_urls: https://sensu.alpha.example.com:8080

- name: Create a larger cluster
  sensu.sensu_go.cluster:
    name: large-cluster
    api_urls:
      - https://sensu.alpha.example.com:8080
      - https://sensu.beta.example.com:8080
      - https://sensu.gamma.example.com:8080

- name: Delete a cluster
  sensu.sensu_go.cluster:
    name: small-cluster
    state: absent

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

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

Ключ	Описание
object словарь	Объект, представляющий кластер Sensu. Возвращается: success Пример: `{"api_urls": ["http://10.10.0.1:8080"], "metadata": {"name": "alpha-cluster"}}`

Авторы

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