Конфигурационный файл /opt/rubackup/etc/rb_module_postgresql.conf
Обязательные к заполнению параметры обозначены символом .
| Параметр | Назначение | ||||||
|---|---|---|---|---|---|---|---|
|
Имя базы данных, к которой будет происходить подключение для резервного копирования всей СУБД
|
||||||
|
Имя пользователя в СУБД, обладающего правами выполнять резервное копирование
|
||||||
|
Пароль для пользователя, указанного в параметре username
|
||||||
|
IP-адрес или доменное имя локального хоста, на котором СУБД принимает подключения
Необходим для взаимодействия c СУБД, резервное копирование которой выполняется |
||||||
|
Порт для соединения с СУБД
|
||||||
|
Login администратора PostgreSQL в операционной системе
|
||||||
|
Полный путь до утилиты
Параметр используется при восстановлении с развертыванием для остановки и запуска сервиса СУБД
|
||||||
|
Имя
Параметр используется при восстановлении с развертыванием для остановки и запуска сервиса СУБД через
|
||||||
|
Удалять ли архивные WAL-файлы из каталога, указанного в параметре archive_catalog
При значении:
|
||||||
|
Период (в секундах) ожидания окончания архивации последнего WAL-файла, сгенерированного во время создания резервной копии
|
||||||
|
Период (в секундах) проверки окончания архивации последнего WAL-файла, сгенерированного во время создания резервной копии
|
||||||
|
Использование хранилища секретов HashiCorp Vault v1.16.3
|
||||||
|
Сохранять цепочку WAL-файлов даже при полном резервном копировании
|
||||||
|
Автоматически переключать на полное резервное копирование, если произошла ошибка выполнения инкрементального резервного копирования
|
||||||
|
Таймаут (в секундах) запуска/остановки сервиса СУБД
|
||||||
|
Принудительное указание версии ресурса для случаев, когда СУБД, основанная на PostgreSQL, возвращает некорректную или нестандартную версию. Указывается мажорная и минорная версия через точку (
|
||||||
|
Изменение переменной части имени ресурса
По умолчанию имя ресурса имеет формат Параметр Значение может содержать:
|
||||||
|
Использовать формирование имени ресурса, совместимое с прошлыми версиями
По умолчанию имя ресурса имеет новый формат Значение |
||||||
|
Каталог для хранения архивных WAL-файлов
|
||||||
|
Перенос WAL-файлов вместо копирования
При значении:
|
||||||
|
Количество потоков для архивации WAL-файлов
|
||||||
|
Количество обрабатываемых WAL-файлов, которые одновременно отправляются в архивный каталог
|
||||||
|
Максимальный размер архивных WAL-файлов, хранимых локально (в МБ)
При превышении размера архива запускается фоновая очистка. Во время резервного копирования очистка блокируется. При значении
|
||||||
|
Максимальное время ожидания (в секундах) освобождения архивного каталога, которое ждет процесс резервного копирования
|
||||||
|
Проверка работы архивации WAL-файлов до запуска длительного резервного копирования
При значении:
|
||||||
|
Восстановление целевого действия
При значении:
|
||||||
|
Попытки проверки, что wal summarizer успел внести все изменения в summary файлы
|
||||||
|
Абсолютный путь до каталога с репликационными данными
|
||||||
|
Путь до утилиты
Утилита
|
||||||
|
Выполняет удаление физического слота
При значении:
|
||||||
|
Имя, с которым необходимо создать физический слот
Если значение не задано, то используется физический слот, заданный в системе
|
||||||
|
IP-адрес, на котором Patroni принимает входящие запросы Rest API
Параметр необходим только для взаимодействия модуля с Rest API локального процесса Patroni. Если значение параметра не указано, то оно определяется через утилиту |
||||||
|
Порт, на котором локальный процесс Patroni слушает запросы Rest API
Параметр необходим только для взаимодействия модуля с Rest API локального процесса Patroni. Если значение параметра не указано, то оно определяется через утилиту |
||||||
|
Роль узла в кластере Patroni, при которой ресурс будет доступен
При значении:
|
||||||
|
Позволяет использовать режим
При значении:
|
||||||
|
Путь к корневому сертификату, если требуется проверка сертификата сервера Patroni
|
||||||
|
Путь до утилиты
Используется для работы подтипа инкрементального резервного копирования Местонахождение pg_waldump зависит от используемой СУБД |
||||||
|
Количество процессов, выделенных для обработки архивных WAL-файлов
|
||||||
|
В каком состоянии будет восстановлена БД
При значении:
|
||||||
|
Абсолютный путь до утилиты
|
||||||
|
Абсолютный путь до каталога для хранения резервных копий
|
||||||
|
Имя подкаталога для хранения резервных копий
|
||||||
|
Нужно ли проверять версию
|
||||||
|
Интерфейс облачного хранилища
При значении:
|
||||||
|
Путь к исполняемому файлу
|
||||||
|
Путь до файла, в который будет направляться вывод сообщений сервера
|
/opt/rubackup/etc/rb_module_postgresql.conf# Symbol "#" at the beginning of the line treats as a comment
# "#" in the middle of the line treats as a parameter value
# So please do not use comments in one line with parameter
#
#
# ----- General -----
#
#dbname postgres
#username rubackup_backuper
#password 12345
#host localhost
#port 5432
#postgresql_admin postgres
# Specify this path according to the installed version
#pg_ctl /usr/lib/postgresql/12/bin/pg_ctl
#postgresql_service_name postgresql
#auto_remove_wal yes
# Timeout period for the last WAL file generated during backup(in seconds)
#wal_wait_timeout 10
# Availability check period for last WAL file generated during backup(in seconds)
#wal_check_period 1
#Enable interaction with centralized secret repositories
#use_secret_storage no
#keep wal files chain even for full backup
#keep_wal_chain no
# Переключаться или нет на полный бэкап если невозможно выполнить инкрементальный/дифф
#auto_switch_full yes
# Таймаут старт/стоп БД. В секундах. 0 - использовать системный дефолт. Обычно 60 сек.
#operation_timeout 0
# Переопределение версии БД
#version_override 99.99
# Имя инстанса
#instance_name custom_name
# Использовать формирование имени ресурса совместимое с прошлыми версиями
#legacy_instance_name no
#
# ----- Wal Archiving -----
#
#archive_catalog /opt/rubackup/mnt/postgresql_archives
# Использовать move для переноса WAL из архива вместо копирования
#move_on_archive_get yes
# Количество потоков для архивации WAL
#num_threads_for_wal_archiving 1
# Количество файлов обрабатываемых за один вызов архивации
#batch_size_for_wal_archiving 1
# Макс. размер хранимых локально архивных WAL файлов (0 - нет лимита)
#wal_archive_files_size 0
# Макс. время в секундах которое процесс снятия РК ждет освобождения архивного каталога
#cleanup_wait_timeout 1000
# Выполнять проверку работы команд архивации перед снятием РК
#make_archiving_check yes
#
# ----- Параметры для восстановления РК -----
#
# Возможные значения для restore_target_action: [pause promote shutdown]
#restore_target_action promote
#
# ----- Wal Summarizer -----
#
# Попытки проверки, что wal summarizer успел внести все изменения в summary файлы
#wal_sum_max_retries 20
#
# ----- Stream -----
#
# Директория для сохранения репликационных данных
#replication_catalog /opt/rubackup/mnt/postgresql_replica
# Путь до утилиты pg_receivewal (физическая репликация), начиная с 10 версии
#pg_receivewal /usr/lib/postgresql/10/bin/pg_receivewal
# Выполнить drop физического слота с именем slot_name после создания РК
#drop_slot no
# Использовать физический слот, заданный в системе, иначе создать с указанным именем
#slot_name my_slot_name
#
# ----- Patroni -----
#
# and may be needed for the module work in a patroni cluster
#patroni_host localhost
#patroni_port 8008
#patroni_node_type_for_backup leader
#patroni_https no
#patroni_ca /etc/ssl/ca.crt
#
# ----- Page -----
#
#pg_waldump /usr/lib/postgresql/12/bin/pg_waldump
#num_threads_for_wal_processing 8
#
# ----- pg_probackup -----
#
# Возможные значения для restore_target: [immediate | latest]
#restore_target immediate
# Абсолютный путь до утилиты pg_probackup
#pg_probackup /opt/pgpro/std-13/bin/pg_probackup
# Абсолютный путь до каталога, в котором хранятся резервные копии
#probackup_catalog_copies /opt/rubackup/mnt/pg_probackup
# Имя инстанса. Имя подкаталогов, в которых будут храниться копии
#probackup_instance_name data
# Нужно ли проверять версию probackup
#check_probackup_version yes
#
# ----- S3 -----
#
# Возможные значения для s3_interface: [minio | vk]
#s3_interface minio
#
# ----- Custom PostgreSQL build -----
#
# Specify if custom built PostgreSQL binary is required
# pg_binary /usr/bin/custom/postgres
# Specify if server output should be redirected to the file
# pg_log /tmp/postgres.log
#
# Variables value
username
password
port
postgresql_admin
pg_ctl
auto_remove_wal
wal_wait_timeout
wal_check_period
legacy_instance_name
archive_catalog