variables.md

Переменные, используемые в роли

Переменные, общие на весь кластер

Инсталляция

Имя	Значение по умолчанию	Описание
repo	'https://download.picodata.io'	репозиторий для установки пакетов, значение для ночных сборок: https://download.binary.picodata.io
cluster_name	demo	имя кластера
user	root	имя пользователя для файлов
group	root	имя группы для файлов
service_password		пароль для сервисной учетной записи pico_service
admin_password		пароль для учетной записи admin, который должен удовлетворять условиям
init_system	systsemd	система управления сервисами и процессами (systemd, supervisord)
install_packages	true	необходимость установки picodata из репозитория пакетов

Пути

Имя	Значение по умолчанию	Описание
conf_dir	/etc/picodata	размещение настроечных файлов
data_dir	/var/lib/picodata	размещение данных
run_dir	/var/run/picodata	размещение socket-файлов
systemd_dir	/etc/systemd/system	размещение systemd-файлов
supervisord_dir	/etc/picodata/supervisord	размещение кофигурационных файлов для supervisord
dir_mode	0750	Права, создаваемые на каталоги

Логирование и аудит

Имя	Значение по умолчанию	Описание
log_level	info	уровень логирования. Возможные значения: fatal, system, error, crit, warn, info, verbose, debug
log_to	syslog	место хранения лог-файлов. Возможные значения: file, syslog
log_dir	/var/log/picodata	место для размещения файлов логирования и аудита
audit	false	включение аудита событий в кластере, при включении файлы будут размещаться в log_dir и начинаться с audit-

Адреса и порты

Имя	Значение по умолчанию	Описание
first_bin_port	13301	начальный номер порта для бинарных портов инстансов кластера
first_http_port	18001	начальный номер порта для http-портов инстансов кластера
first_pg_port	15001	начальный номер порта для postgress-протокола инстансов кластера. Значение 0 выключает поддержку протокола postgress
listen_address	{{ansible_fqdn}}	Jinja шаблон для определния адреса сервера. Для IP можно указать {{ansible_default_ipv4.address}}

Бэкапы

Имя	Значение по умолчанию	Описание
backup_dir	/var/lib/picodata/backups	каталог для размещения бэкапов локально
backup_fetch_dir	backups	каталог для размещения скачанных бэкапов с серверов кластера
backup_fetch	true	необходимость скачивания бэкапов с серверов, если выставлена в false, то бэкапы сохраняются только локально на серверах. Используется также и при восстановлении
restore_dir		указание каталога для восстановления кластера в формате YYYYMMDDhhmmss, если не указан, то будет браться последний из существующих

Прочие

Имя	Значение по умолчанию	Описание
purge	false	при выставлении этой переменной в true при удалении кластера будут удалены все файлы: настроечные, данные
fd_uniq_per_instance	false	позволяет разворачивать репликасет из нескольких реплик на одном сервере. Испольуется только для тестовых целей!
debug	false	вывод отладочной информации
serial_host_restart	100	количество серверов для одновременного рестарта
extra_vars	{}	словарь с дополнительными переменными для всего кластера

---

Переменные для тиров (tiers)

Имя	Значение по умолчанию	Описание
instances_per_server	1	количество инстансов тира на каждом сервере
replication_factor	1	фактор репликации
shredding	false	режим безопасного удаления рабочих файлов инстанса путем многократной перезаписи специальными битовыми последовательностями
can_vote	true	возможность инстансов участвовать в голосовании на выборах raft-лидера
config	{}	словарь для настройки инстансов тира, например указание размера инстанса. Подробнее в документации параметр instance
extra_vars	{}	словарь с дополнительными переменными для конкретного тира

Размещение тиров по хостам (host_groups)

Групп хостов может быть несколько

host_groups:
- STORAGES

Если host_groups не определена, то инстансы будут раскатаны на каждом сервере.

Переменная host_group должна быть определена в списке серверов.

---

Переменные для хостов

Пример настройки хостов

DC1:                                # Датацентр 1
  hosts:
    server-1-1:                     # Имя сервера 1
      ansible_host: 192.168.19.21   # адрес сервера 1
      host_group: 'ROUTERS'         # группа хостов

DC2:                                # Датацентр 2
  hosts:
    server-2-1:                     # Имя сервера 2
      ansible_host: 192.168.19.22   # адрес сервера 2
      host_group: 'STORAGES'        # группа хостов

DC3:                                # Датацентр 3
  hosts:
    server-3-1:                     # Имя сервера 3
      ansible_host: 192.168.19.23   # адрес сервера 3
      host_group: 'STORAGES'        # группа хостов

Переменные для плагинов (plugins)

Имя	Значение по умолчанию	Описание
path		месторасположение пакета с плагином на локальном хосте
config		месторасположение конфигурационного файла плагина на локальном хосте (опционально)
tiers	default	список тиров, в которые установить плагин
migration_context		переменные для подстановки в миграциях (опционально)
migration_timeout	300	время ожидания окончания выполнения миграций
do_not_run_plugin_install_sql	false	не выполнять sql-инструкции по включению и настройке плагина (используется для отладки)