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

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

1. Параметры файла

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

url

URL-адрес для API-запросов в ПВ

login_url

URL для запроса токена аутентификации в ПВ, который будет использоваться для последующих API-запросов

client_id

Идентификатор приложения для получения токена аутентификации от ПВ

client_secret

Секретный API ключ для получения токена аутентификации от ПВ

hypervisor_backup_path

Путь к точке монтирования на узле гипервизора, в которую будут помещены копии виртуальных машин, доступные в локальной точке монтирования.

Взаимодействует с параметром local_backup_path.

По умолчанию

NONE

local_backup_path

Путь к локальной точке монтирования NFS-ресурса на клиенте РК, в которой модуль ожидает появления копий дисков резервируемой ВМ.

Взаимодействует с параметром hypervisor_backup_path.

По умолчанию

NONE

backup_disk_timeout

Время ожидания (в минутах) создания резервной копии одного диска ВМ в ПВ.

Если время ожидания истекло, но резервная копия не готова, то задача на резервное копирование завершится с ошибкой.

Возможные значения

от 1 до 1440.

По умолчанию

10

restore_disk_timeout

Время ожидания (в минутах) восстановления одного диска ВМ в ПВ.

Если время ожидания истекло, но восстановление диска не произошло, то задача на восстановление завершится с ошибкой.

Возможные значения

от 1 до 1440.

По умолчанию

5

allow_work_with_incompatible_versions

Разрешить модулю работать с неподдерживаемой версией ПВ.

yes

Если версия ПВ отличается от списка версий, с которыми взаимодействует модуль, резервное копирование и восстановление РК будет выполняться. В журнал модуля будет добавлена запись о неподдерживаемой[1] версии ПВ.

no

Если версия ПВ отличается от списка версий, с которыми взаимодействует модуль, резервное копирование и восстановление РК будет недоступно.

По умолчанию

no

1. За взаимодействие модуля с неподдерживаемой версией ПВ компания RuBackup ответственности не несет.

timeout

Время ожидания (в секундах) ответа от платформы виртуализации на API-запрос.

Если при выполнении задачи на создание или восстановление РК ответ от платформы на API-запрос от СРК не поступит в течение заданного времени, то задача завершится с ошибкой.

Возможные значения

от 1 до 300.

По умолчанию

20

enable_ssl

Включить проверку SSL-сертификата при API-запросах на подключение к ПВ.

Возможные значения

yes, no.

По умолчанию

no

ca_info

Полный путь до SSL-сертификата при API-запросах на подключение к ПВ.

По умолчанию

NONE. API-запросы будут отправляться без проверки SSL-сертификата.

Используется только если параметр enable_ssl равен yes.

curl_verbose

Использование отладки API-запросов. Позволяет просматривать подробную информацию об API-запросах и ответах.

Информация отображается в журнале модуля /opt/rubackup/log/rb_module_dynamix.log.

Возможные значения

yes, no.

По умолчанию

no

Рекомендуем включать настройку (значение yes) только с целью отладки проблем при взаимодействии модуля с ПВ через REST API.

curl_workers

Количество параллельных API-запросов на получение списка ВМ ПВ.

Возможные значения

от 1 до 100.

По умолчанию

1

use_secret_storage

Использование внешнего хранилища секретов для хранения аутентификационных параметров пользователя.

В хранилище секретов располагаются параметры аутентификации пользователя, от которого будут выполняться API-запросы в ПВ.

yes

Будут использоваться параметры аутентификации из хранилища секретов.

no

Будут использоваться параметры аутентификации url, login_url, client_id и client_secret из конфигурационного файла модуля.

Возможные значения

yes, no.

По умолчанию

no

2. Листинг файла

Пример листинга конфигурационного файла /opt/rubackup/etc/rb_module_dynamix.conf
# Web interface that provides REST API service and VM's Web UI management
url
#
# Authentication host
login_url
#
# Client ID - can be obtained from instance info in Web GUI throuh
# authentication host as "Application ID"
client_id
#
# Client Secret - can be obtained from instance info in Web GUI throuh
# authentication host as "API Key"
client_secret
#
# Hypervisors backup path where backups would be stored. Connected by NFS
# with local_backup_path. For value 'NONE' the module expects to get this
# parameter from special module options
hypervisor_backup_path NONE
#
# Local backup path where backups would be stored. Connected by NFS with
# hypervisor_backup_path. For value 'NONE' the module expects to get this
# parameter from special module options
local_backup_path NONE
#
# Single disk backup timeout in minutes
# Possible values: [1 - 1440]
# Default: 10 minutes
backup_disk_timeout 10
#
# Single disk restore timeout in minutes
# Possible values: [1 - 1440]
# Default: 5 minutes
restore_disk_timeout 5
#
# Try using the module if the DynamiX platform version is not compatible
# with RuBackup
# Possible values: yes, no
# Default: no
allow_work_with_incompatible_versions no
#
# REST operations timeout in seconds
# Possible values: [1 - 300]
# Default: 20 seconds
timeout 20
#
# Enable ssl connection to API server
# Possible values: yes, no
# Default: no (connecting to API server w/o ssl)
enable_ssl no
#
# Specify full path to a certificate for ssl connection to API server. For
# value 'NONE' the module will connect to API w/o certificate verification
# Default: NONE
ca_info NONE
#
# Turn on debug for REST API requests
# Possible values: yes, no
# Default: no (debug is turned off)
curl_verbose no
#
# Amount of parallel workers for REST requests
# min 1, max 100, default 1
curl_workers 1
#
# Enable interaction with centralized secret repositories
# Possible values: yes, no. Default: no
use_secret_storage no