Spec-Zone.ru › Ansible

Модуль sensu.sensu_go.asset — Управление активами Sensu

Примечание

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

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

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

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

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

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

Описание

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

Требования

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

  • python >= 2.7

Параметры

Параметр

Комментарии

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

builds

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

Список сборок активов, используемых для определения нескольких артефактов, которые предоставляют указанный актив.

Требуется, если state равен present.

filters

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

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

headers

словарь

Дополнительные заголовки для отправки при получении актива, например, для авторизации.

sha512

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

Контрольная сумма актива.

url

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

URL-адрес расположения актива.

labels

словарь

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

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

name

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

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

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

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

namespace

строка

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

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

state

строка

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

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

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

См. также

См. также

sensu.sensu_go.asset_info

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

sensu.sensu_go.bonsai_asset

Добавление активов Sensu из Bonsai.

Примеры

- name: Create a multiple-build asset
  sensu.sensu_go.asset:
    name: sensu-plugins-cpu-checks
    builds:
      - url: https://assets.bonsai.sensu.io/68546e739d96fd695655b77b35b5aabfbabeb056/sensu-plugins-cpu-checks_4.0.0_centos_linux_amd64.tar.gz
        sha512: 518e7c17cf670393045bff4af318e1d35955bfde166e9ceec2b469109252f79043ed133241c4dc96501b6636a1ec5e008ea9ce055d1609865635d4f004d7187b
        filters:
          - entity.system.os == 'linux'
          - entity.system.arch == 'amd64'
          - entity.system.platform == 'rhel'
      - url: https://assets.bonsai.sensu.io/68546e739d96fd695655b77b35b5aabfbabeb056/sensu-plugins-cpu-checks_4.0.0_alpine_linux_amd64.tar.gz
        sha512: b2da25ecd7642e6de41fde37d674fe19dcb6ee3d680e145e32289f7cfc352e6b5f9413ee9b701d61faeaa47b399aa30b25885dbc1ca432c4061c8823774c28f3
        filters:
          - entity.system.os == 'linux'
          - entity.system.arch == 'amd64'
          - entity.system.platform == 'alpine'

- name: Delete an asset
  sensu.sensu_go.asset:
    name: sensu-plugins-cpu-check
    state: absent

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

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

Ключ

Описание

object

словарь

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

Возвращено: успех

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

Авторы

  • Cameron Hurst (@wakemaster39)
  • Aljaz Kosir (@aljazkosir)
  • Manca Bizjak (@mancabizjak)
  • Miha Plesko (@miha-plesko)
  • 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/asset_module.html

Spec-Zone.ru

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