Spec-Zone.ru › Ansible 2.11

sensu.sensu_go.datastore – Управление внешними поставщиками хранилищ данных Sensu

Примечание

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

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

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

Новое в версии 1.1.0: модуля sensu.sensu_go

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

Обзор

  • Добавление или удаление внешнего поставщика хранилища данных.
  • Для получения дополнительной информации см. документацию Sensu по адресу https://docs.sensu.io/sensu-go/latest/reference/datastore/.

Требования

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

  • python >= 2.7

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
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
Путь к файлу с набором доверенных корневых сертификатов, который должен использоваться для проверки сертификата бэкенда.
Если этот параметр не задан, модуль будет использовать набор сертификатов, используемый 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.
dsn
строка
Атрибут, задающий имена источников данных в виде URL-адреса или строки подключения PostgreSQL. Дополнительную информацию о строках подключения см. в документации PostgreSQL.
name
строка / обязательный
Имя ресурса Sensu. Это имя (в сочетании с пространством имен, если применимо) однозначно идентифицирует ресурс, с которым работает Ansible.
Если ресурс с выбранным именем уже существует, модуль Ansible обновит его в соответствии с указаниями в задаче.
Для получения подробной информации о допустимых именах и других ограничениях см. спецификацию атрибута метаданных name в документации upstream по адресу https://docs.sensu.io/sensu-go/latest/reference/.
pool_size
целое число
Максимальное количество подключений, хранящихся в пуле подключений PostgreSQL.
state
строка
    Варианты:
  • present ←
  • absent
Целевое состояние объекта Sensu.

Примечания

Примечание

  • В настоящее время только один внешний поставщик хранилища данных может быть активным одновременно. Модуль не сможет выполнить свою операцию, если это нарушит это ограничение.

См. также

См. также

sensu.sensu_go.datastore_info

Официальная документация модуля sensu.sensu_go.datastore_info.

Примеры

- name: Add external datastore
  sensu.sensu_go.datastore:
    name: my-postgres
    dsn: postgresql://user:secret@host:port/dbname

- name: Remove external datastore
  sensu.sensu_go.datastore:
    name: my-postgres
    state: absent

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

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

Ключ Возвращаемое значение Описание
object
словарь
успех
Объект, представляющий внешнего поставщика хранилища данных.

Пример:
{'batch_buffer': 0, 'batch_size': 1, 'batch_workers': 0, 'dsn': 'postgresql://user:secret@host:port/dbname', 'enable_round_robin': True, 'max_conn_lifetime': '5m', 'max_idle_conns': 2, 'metadata': {'name': 'my-postgres'}, 'pool_size': 20, 'strict': True}


Авторы

  • 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/datastore_module.html

Spec-Zone.ru

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