Конфигурационный файл /opt/rubackup/etc/rb_module_clickhouse.conf

Обязательные к заполнению параметры обозначены символом .

Таблица 1. Параметры конфигурационного файла /opt/rubackup/etc/rb_module_clickhouse.conf
Параметр Описание

backup_user

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

Определяется на этапе настройки СУБД (см. раздел Настройка пользователя для резервного копирования на стороне СУБД).

По умолчанию

rubackup_backuper

password

Пароль пользователя СУБД, имя которого указано в backup_user.

Определяется на этапе настройки СУБД (см. раздел Настройка пользователя для резервного копирования на стороне СУБД).

host

FQDN или IP-адрес сервера СУБД для подключения модуля.

По умолчанию

localhost

port

Порт сервера СУБД для подключения модуля.

По умолчанию

9000

backup_disk_name

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

Определяется на этапе настройки СУБД (см. раздел Настройка промежуточного хранилища для резервных копий).

По умолчанию

rubackup_disk.

Если в качестве промежуточного хранилища будет использоваться диск, то на этапе резервного копирования выберите значение disk в параметре archive_format в тонких настройках модуля

backup_file_path

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

Определяется на этапе настройки СУБД (см. раздел Настройка промежуточного хранилища для резервных копий).

По умолчанию

/var/lib/clickhouse.

Если в качестве промежуточного хранилища будет использоваться локальная директория, то на этапе резервного копирования выберите значение file в параметре archive_format в тонких настройках модуля

clickhouse_server_config_path

Путь до конфигурационных файлов сервера ClickHouse.

Конфигурационные файлы сервера попадают в резервную копию всей СУБД.

По умолчанию

/etc/clickhouse-server.

Если значение не задано, то конфигурационные файлы не попадут в резервную копию

clickhouse_keeper_config_path

Путь до конфигурационных файлов службы координатора ClickHouse.

Конфигурационные файлы службы координатора попадают в резервную копию всей СУБД.

По умолчанию

/etc/clickhouse-keeper.

Если значение не задано, то конфигурационные файлы не попадут в резервную копию

use_secret_storage

Использование внешнего хранилища секретов

true

Будут использованы значения параметров backup_user и password из предварительно настроенного хранилища секретов.

false

Будут использованы значения параметров backup_user и password из конфигурационного файла.

По умолчанию

false.
Пример 1. Конфигурационный файл /opt/rubackup/etc/rb_module_clickhouse.conf
# Конфигурационный файл заполняется пользователем вручную.

# Пользователь созданный для выполнения резервного копирования
backup_user: 'rubackup_backuper'
# Пароль пользователя
password: ''
# FQDN/IP для подключения к серверу ClickHouse
host: 'localhost'
# Порт для подключения к серверу ClickHouse
port: '9000'

# Имя диска промежуточного хранения резервных копий
backup_disk_name: 'rubackup_disk'
# Путь до промежуточного файлового хранилища резервных копий
backup_file_path: '/var/lib/clickhouse'

# Путь до конфигурационных файлов сервера ClickHouse
clickhouse_server_config_path: '/etc/clickhouse-server'
# Путь до конфигурационных файлов координатора ClickHouse
clickhouse_keeper_config_path: '/etc/clickhouse-keeper'

# Флаг использования секретов модуля
use_secret_storage: False