Конфигурационный файл

username

Имя пользователя в СУБД PostgreSQL, обладающего правами выполнять резервное копирование

rubackup_backuper

password

Пароль для пользователя, указанного в параметре username

host

IP-адрес или доменное имя локального хоста, на котором СУБД принимает подключения. Используется для взаимодействия c СУБД, резервное копирование которой выполняется. Параметр необязательный, т.е. его можно не указывать в конфигурационном файле

localhost

port

Порт для соединения с СУБД. Параметр необязательный, т.е. его можно не указывать в конфигурационном файле

5432

use_secret_storage

Использование хранилища секретов HashiCorp vault v1.16.3

no

archive_catalog

Каталог для хранения архивных WAL

/opt/rubackup/mnt/postgresql_archives

pg_ctl

Используется для запуска и остановки СУБД PostgreSQL во время восстановления с развертыванием. Местонахождение pg_ctl зависит от используемой версии.

/usr/lib/postgresql/12/bin/pg_ctl

pg_binary

Используется при вызове утилиты pg_ctl для запуска PostgreSQL во время восстановления с развертыванием. Указывает путь к исполняемому файлу postgres. Параметр pg_binary не является обязательным. По умолчанию исполняемый файл postgres берется из того же каталога, из которого запускался pg_ctl, а если найти файл невозможно, то из жёстко заданного каталога инсталляции.

—

pg_log

Используется при вызове утилиты pg_ctl для запуска PostgreSQL во время восстановления с развертыванием. В указанный файл будет направляться вывод сообщений сервера. Файл создаётся, если он ещё не существует. Параметр не является обязательным.

—

postgresql_service_name

Служебное имя базы данных

postgresql

pg_waldump

Путь до утилиты pg_waldump. Параметр необходимо задать для работы подтипа инкрементального резервного копирования page (при использовании подмодуля postgresql). Местонахождение pg_waldump зависит от используемой версии PostgreSQL.

/usr/lib/postgresql/12/bin/pg_waldump

num_threads_for_wal_processing

Количество процессов, выделенных для обработки архивных WAL файлов

8

auto_remove_wal

В случае значения yes архивные WAL будут удалены из каталога archive_catalog после выполнения резервного копирования (если они включены в резервную копию)

yes

postgresql_admin

Login администратора PostgreSQL в операционной системе

postgres

execute_only_on_leader

В случае значения yes резервное копирование выполняется только на лидере кластера Patroni. В случае активации параметра модуль возвращает отрицательный ответ серверу на запрос о наличии ресурса, если хост, на котором производится проверка, не является лидером кластера Patroni. Параметр применяется только при работе в кластере Patroni и используется только в версии модуля 2.0 и ниже. В конфигурационном файле модуля версии 2.1 параметр заменён на patroni_node_type_for_backup.

no

patroni_node_type_for_backup

В случае указания значения leader, ресурс будет доступен только при условии, что узел на котором установлен модуль с таким значением имеет роль leader в кластере patroni. В случае указания значения sync, ресурс будет доступен только при условии, что узел, на котором установлен модуль с таким значением, имеет роль sync stanby в кластере patroni. В случае указания значения async, ресурс будет доступен только при условии, что узел, на котором установлен модуль с таким значением, имеет роль replica в кластере patroni. Параметр patroni_node_type_for_backup заменяет в версии модуля 2.1 параметр execute_only_on_leader.

wal_wait_timeout

Период ожидания окончания архивации последнего WAL-файла, сгенерированного во время создания резервной копии.

10

wal_check_period

Период проверки окончания архивации последнего WAL-файла, сгенерированного во время создания резервной копии

1

patroni_host

IP-адрес, на котором Patroni принимает входящие запросы Rest API. Параметр необязательный (т.е. его можно не указывать в конфигурационном файле) и необходим только для взаимодействия модуля с Rest API локального процесса Patroni. Если значение параметра не указано, будет предпринята попытка автоматически определить значение для этого параметра через утилиту lsof.

localhost

patroni_port

Порт, на котором локальный процесс Patroni слушает запросы Rest API. Параметр необязательный (т.е. его можно не указывать в конфигурационном файле) и необходим только для взаимодействия модуля с Rest API локального процесса Patroni. Если значение параметра не указано, будет предпринята попытка автоматически определить значение для этого параметра через утилиту lsof.

8008

cold_storage_path

Директория «холодного» хранилища писем

/mnt/cold_storage

allow_work_with_incompatible_versions

Позволяет использовать модуль, если версия платформы несовместима с СРК RuBackup

no