community.general.influxdb_retention_policy – Управление политиками хранения InfluxDB
Примечание
Этот плагин входит в коллекцию community.general (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.general.
Для использования в книге задач укажите: community.general.influxdb_retention_policy.
Обзор
- Управление политиками хранения InfluxDB.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.6
- influxdb >= 0.9
- requests
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| database_name строка / обязательно | Имя базы данных. | |
| default булево |
| Устанавливает политику хранения в качестве политики хранения по умолчанию. |
| duration строка / обязательно | Определяет, как долго InfluxDB должен хранить данные. | |
| hostname строка | Значение по умолчанию: "localhost" | Имя хоста или IP-адрес, на котором слушает сервер InfluxDB. Начиная с Ansible 2.5, значение по умолчанию установлено на localhost. |
| password строка | Значение по умолчанию: "root" | Пароль, который будет использован для аутентификации на сервере InfluxDB. Псевдоним login_password добавлен в Ansible 2.5.псевдонимы: login_password |
| path строка добавлен в 0.2.0 community.general | Путь, по которому доступен сервер InfluxDB Доступен только при использовании python-influxdb >= 5.1.0 | |
| policy_name строка / обязательно | Имя политики хранения. | |
| port целое число | Значение по умолчанию: 8086 | Порт, на котором слушает сервер InfluxDB |
| proxies словарь | HTTP(S) прокси, который нужно использовать для запросов к серверу InfluxDB. | |
| replication целое число / обязательно | Определяет, сколько независимых копий каждой точки данных хранится в кластере. | |
| retries целое число | Значение по умолчанию: 3 | Количество попыток повторного подключения, которые клиент предпримет перед прерыванием. 0 означает попытку до успеха.Доступно только при использовании python-influxdb >= 4.1.0 |
| shard_group_duration строка добавлен в 2.0.0 community.general | Определяет размер группы фрагментов. Значение должно быть целочисленной константой, немедленно (без пробелов) за которой следует единица измерения длительности. Поддерживаемые единицы измерения длительности — h для часов, d для дней и w для недель. Например 10d, 1h, 2w. | |
| ssl булево |
| Использовать https вместо http для подключения к серверу InfluxDB. |
| timeout целое число | Количество секунд, которые Requests будут ждать, пока клиент установит соединение. | |
| udp_port целое число | Значение по умолчанию: 4444 | Порт UDP для подключения к серверу InfluxDB. |
| use_udp булево |
| Использовать UDP для подключения к серверу InfluxDB. |
| username строка | Значение по умолчанию: "root" | Имя пользователя, которое будет использоваться для аутентификации на сервере InfluxDB. Псевдоним login_username добавлен в Ansible 2.5.псевдонимы: login_username |
| validate_certs булево |
| Если установлено значение no, сертификаты SSL не будут проверены.Это следует устанавливать только в no на сайтах, контролируемых лично, использующих самозаверенные сертификаты. |
Примеры
# Example influxdb_retention_policy command from Ansible Playbooks
- name: Create 1 hour retention policy
community.general.influxdb_retention_policy:
hostname: "{{influxdb_ip_address}}"
database_name: "{{influxdb_database_name}}"
policy_name: test
duration: 1h
replication: 1
ssl: yes
validate_certs: yes
- name: Create 1 day retention policy with 1 hour shard group duration
community.general.influxdb_retention_policy:
hostname: "{{influxdb_ip_address}}"
database_name: "{{influxdb_database_name}}"
policy_name: test
duration: 1d
replication: 1
shard_group_duration: 1h
- name: Create 1 week retention policy with 1 day shard group duration
community.general.influxdb_retention_policy:
hostname: "{{influxdb_ip_address}}"
database_name: "{{influxdb_database_name}}"
policy_name: test
duration: 1w
replication: 1
shard_group_duration: 1d
- name: Create infinite retention policy with 1 week of shard group duration
community.general.influxdb_retention_policy:
hostname: "{{influxdb_ip_address}}"
database_name: "{{influxdb_database_name}}"
policy_name: test
duration: INF
replication: 1
ssl: no
validate_certs: no
shard_group_duration: 1w
Авторы
- Kamil Szczygiel (@kamsz)
© 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/community/general/influxdb_retention_policy_module.html
