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

Примечание

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

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

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

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

Новый в sensu.sensu_go 1.1.0

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

Описание

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

Требования

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

python >= 2.7

Параметры

Параметр	Комментарии
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` ← (по умолчанию)
batch_buffer целое число	Максимальное количество запросов для буферизации в памяти. Значение по умолчанию: `0`
batch_size целое число	Количество запросов в каждой транзакции записи в PostgreSQL, как указано в конфигурации PostgreSQL. Значение по умолчанию: `1`
batch_workers целое число	Количество Goroutines, отправляющих данные в PostgreSQL, как указано в конфигурации PostgreSQL. По умолчанию устанавливается значение текущего размера пула PostgreSQL.
dsn строка	Атрибут, указывающий имена источников данных в виде URL-адреса или строки подключения к PostgreSQL. Подробнее о строках подключения см. в документации PostgreSQL.
enable_round_robin логический тип	Включает расписание round robin в PostgreSQL. Любое существующее расписание round robin будет остановлено и перенесено в PostgreSQL по мере проверки сущностей с keepalives. Sensu постепенно удалит состояние существующего планировщика etcd по мере истечения срока действия keepalives на ключах планировщика etcd. Варианты: `false` ← (по умолчанию) `true`
max_conn_lifetime строка	Максимальное время существования подключения перед его уничтожением.
max_idle_conns целое число	Максимальное количество неактивных подключений для сохранения. Значение по умолчанию: `2`
name строка / обязательный	Имя ресурса Sensu. Это имя (в сочетании с пространством имен, где это применимо) однозначно идентифицирует ресурс, с которым работает Ansible. Если ресурс с указанным именем уже существует, модуль Ansible обновит его, чтобы он соответствовал спецификации в задаче. См. спецификацию атрибута метаданных name в документации upstream по адресу https://docs.sensu.io/sensu-go/latest/reference/ для получения дополнительной информации о допустимых именах и других ограничениях.
pool_size целое число	Максимальное количество подключений для сохранения в пуле подключений PostgreSQL.
state строка	Целевое состояние объекта Sensu. Варианты: `"present"` ← (по умолчанию) `"absent"`

END_OF_DOCUMENT_MARKER

strict

boolean

При создании ресурса PostgresConfig проверка конфигурации будет включать подключение к базе данных PostgreSQL и выполнение запроса, чтобы подтвердить, имеет ли подключенный пользователь разрешение на создание таблиц базы данных.

Sensu-backend будет пытаться подключиться к PostgreSQL бесконечно с интервалом в 5 секунд вместо возврата к etcd после 3 попыток.

Рекомендуется устанавливать strict в значение true в большинстве случаев. Если подключение не удается или у пользователя нет разрешения на создание таблиц базы данных, настройка ресурса завершится ошибкой, и конфигурация не будет сохранена. Это расширенное поведение полезно для отладки, когда вы не уверены, правильна ли конфигурация или работает ли база данных должным образом.

Варианты:

false ← (по умолчанию)
true

Примечания

Примечание

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

См. также

sensu.sensu_go.datastore_info: Список внешних поставщиков хранилища данных Sensu.

Примеры

- 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

- name: Add external datastore with pool_size and max_conn_lifetime specified
  sensu.sensu_go.datastore:
    name: my-postgres
    dsn: postgresql://user:secret@host:port/dbname
    pool_size: 1
    max_conn_lifetime: "5m30s"

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

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

Ключ	Описание
object словарь	Объект, представляющий поставщика внешнего хранилища данных. Возвращается: success Пример: `{"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}`

Ключ

Описание

object

словарь

Объект, представляющий поставщика внешнего хранилища данных.

Возвращается: success

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