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

Примечание

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

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

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

Новое в версии 1.0.0: of sensu.sensu_go

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

Описание

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

Примечание

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

Требования

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

python >= 2.7

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
annotations словарь			Пользовательские метаданные с меньшими ограничениями, как пары ключ/значение. Они сохраняются Sensu, но недоступны в качестве токенов или идентификаторов и предназначены в основном для использования с внешними инструментами.
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	Варианты: нет да ←	Флаг, контролирующий проверку сертификата. Если вы используете самозаверяющие сертификаты, вы можете установить этот параметр в `false`. Используйте этот параметр ТОЛЬКО в сценариях разработки! Если вы используете самозаверяющие сертификаты в продакшене, обратитесь к параметру auth.ca_path. Этот параметр также можно задать через переменную среды SENSU_VERIFY.
labels словарь			Пользовательские поля метаданных, к которым можно получить доступ в Sensu, как пары ключ/значение.
name строка / обязательно			Имя ресурса Sensu. Это имя (в сочетании с пространством имен, где применимо) однозначно идентифицирует ресурс, с которым работает Ansible. Если ресурс с выбранным именем уже существует, модуль Ansible обновит его в соответствии со спецификацией в задаче. См. спецификацию атрибута метаданных name в документации upstream по адресу https://docs.sensu.io/sensu-go/latest/reference/, чтобы получить более подробную информацию о допустимых именах и других ограничениях.
namespace строка		По умолчанию: "default"	Пространство имен RBAC для работы. Если оно не задано, используется значение переменной среды SENSU_NAMESPACE.
rename строка			Имя, которое будет использоваться при добавлении актива в Sensu. Если не указано, используется значение параметра name.
version строка / обязательно			Номер версии устанавливаемого актива.

Примечания

Примечание

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

См. также

sensu.sensu_go.asset: Официальная документация по модулю sensu.sensu_go.asset.
sensu.sensu_go.asset_info: Официальная документация по модулю sensu.sensu_go.asset_info.

Примеры

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