Spec-Zone.ru › Ansible

sensu.sensu_go.bonsai_asset модуль – Добавление активов Sensu из Bonsai

Примечание

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

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

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

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

Впервые в sensu.sensu_go 1.0.0

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

Описание

  • Создание или обновление актива Sensu Go, определение которого доступно в Bonsai, индексе активов Sensu.
  • Для получения дополнительной информации см. документацию Sensu по адресу https://docs.sensu.io/sensu-go/latest/reference/assets/ и https://bonsai.sensu.io/.

Примечание

Для этого модуля есть соответствующий плагин действий.

Требования

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

  • python >= 2.7
END_OF_DOCUMENT_MARKER

Параметры

Параметр

Комментарии

annotations

словарь

Дополнительные метаданные с меньшими ограничениями, в виде пар ключ/значение.

Эти метаданные сохраняются Sensu, но не доступны как токены или идентификаторы, и предназначены в основном для использования внешними инструментами.

По умолчанию: {}

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 ← (по умолчанию)

labels

словарь

Дополнительные метаданные, которые можно получить в Sensu, в виде пар ключ/значение.

По умолчанию: {}

name

строка / обязательно

Имя ресурса Sensu. Это имя (в сочетании с пространством имен, если применимо) однозначно идентифицирует ресурс, над которым Ansible выполняет операции.

Если ресурс с выбранным именем уже существует, модуль Ansible обновит его в соответствии со спецификацией в задаче.

Обратитесь к спецификации атрибута метаданных name в документации по upstream по адресу https://docs.sensu.io/sensu-go/latest/reference/ для получения дополнительной информации о допустимых именах и других ограничениях.

namespace

строка

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

По умолчанию: "default"

on_remote

логическое

добавлено в sensu.sensu_go 1.13.0

Если установлено в true, модуль загрузит определение актива на удаленный хост.

Если не установлено или установлено в false, Ansible загрузит определение актива на контрольный узел.

Варианты:

  • false
  • true

rename

строка

Имя, которое будет использоваться при добавлении актива в Sensu.

Если не указано, будет использовано значение параметра name.

version

строка / обязательно

Версия актива для установки.

Примечания

Примечание

  • Значения labels и annotations объединяются со значениями, полученными из Bonsai. Значения, переданные в качестве параметров, имеют приоритет перед значениями, полученными из Bonsai.
  • Для удаления актива используйте обычный модуль sensu.sensu_go.asset.

См. также

См. также

sensu.sensu_go.asset

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

sensu.sensu_go.asset_info

Список активов Sensu.

Примеры

- name: Make sure specific version of asset is installed
  sensu.sensu_go.bonsai_asset:
    name: sensu/monitoring-plugins
    version: 2.2.0-1

- name: Remove previously added asset
  sensu.sensu_go.asset:
    name: sensu/monitoring-plugins
    state: absent

- name: Store Bonsai asset under a different name
  sensu.sensu_go.bonsai_asset:
    name: sensu/monitoring-plugins
    version: 2.2.0-1
    rename: sensu-monitoring-2.2.0-1

- name: Display asset info
  sensu.sensu_go.asset_info:
    name: sensu-monitoring-2.2.0-1  # value from rename field

Значения возврата

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

Ключ

Описание

object

словарь

Объект, представляющий Sensu актив.

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

Пример: {"builds": [{"sha512": "4f926bf4328f...2c58ad9ab40c9e2edc31b288d066b195b21b", "url": "http://example.com/asset.tar.gz"}], "metadata": {"name": "check_script", "namespace": "default"}}

Авторы

  • Aljaz Kosir (@aljazkosir)
  • Manca Bizjak (@mancabizjak)
  • 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/bonsai_asset_module.html

Spec-Zone.ru

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