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

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

Таблица 1. Параметры конфигурационного файла /opt/rubackup/etc/rb_module_ovirt.conf.conf
Параметр Назначение

engine

IP-адрес для API-запросов в платформу виртуализации oVirt

grant_type

Тип гранта токена аутентификации OAuth для взаимодействия с API-платформой виртуализации

username

Имя пользователя, от имени которого будут выполняться запросы API

password

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

ca_info

Путь до сертификата SSL

timeout

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

Если при выполнении задачи на создание РК или восстановление РК ответ от платформы не поступит в течение заданного опцией timeout времени, то соответствующая задача может быть завершена с ошибкой

По умолчанию

20

disk_upload_mechanism

Механизм для чтения данных диска и записи данных на диск внутри платформы виртуализации:

nbd

Механизм взаимодействия с дисками, реализуемый на основе протокола NBD.

file

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

Для восстановления ВМ на платформе виртуализации с используемой версией oVirt ниже 4.5.0 с помощью механизма загрузки дисков nbd в хранилища типа iSCSI и FCP необходимо, чтобы диски оригинальной ВМ имели Политику распределения «Тонкое резервирование», иначе не гарантируется восстановление ВМ (см. подробнее на странице https://ovirt.github.io/ovirt-imageio/packages.html)

По умолчанию

file

backup_vm_from_native_host

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

yes

Задача будет назначена клиенту RuBackup на том же хосте. Клиент СРК при этом должен быть добавлен в кластерную группу вместе с другими клиентами СРК, размещенными на узлах платформы виртуализации. Для информации о добавлении клиента в кластерную группу см. раздел «Группы клиентов» Руководства системного администратора RuBackup.

no

Задача будет назначена клиенту RuBackup, используемому при создании правила резервного копирования.

По умолчанию

yes

disk_upload_timeout

Время ожидания (в минутах) для загрузки каждого диска на платформу при восстановлении

По умолчанию

25

disk_download_timeout

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

По умолчанию

25

image_transfer_timeout

Параметр указывает время (в секундах), в течение которого модуль будет ожидать перехода ImageTransfer в состояние transferring.

Если этот время ожидания истекло, но ImageTransfer не перешел в состояние transferring, то соответствующая задача резервного копирования или восстановления завершится с ошибкой

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

от 1 до 3600

По умолчанию

300

imagetransfer_inactivity_timeout

Параметр определяет время (в секундах), в течении которого платформа будет ожидать начала загрузки диска после создания ImageTransfer-а.

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

от 5 до 500

По умолчанию

60

image_transfer_finalize_timeout

Параметр указывает время (в секундах), в течение которого модуль будет ожидать завершения ImageTransfer.

Если время ожидания истекло, но ImageTransfer не перешел в состояние finished_success, в журнал модуля будет добавлено предупреждение. Из-за этого резервное копиривание может завершиться с ошибкой

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

от 1 до 3600

По умолчанию

300

allow_work_with_incompatible_versions

Параметр указывает будет ли модуль работать с версией платформы виртуализации, совместимость с которой не была протестирована.

Если модуль не совместим с версией платформы виртуализации и значение параметра установлено в no, модуль завершит свою работу с соответствующим сообщением об ошибке.

При необходимости работы с несовместимой версией платформы виртуализации установите параметр в значение yes

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

yes, no

По умолчанию

no

curl_verbose

Параметр выводит дополнительную информацию по REST API запросам, при значении yes.

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

yes, no

По умолчанию

no

backup_using_ovirt_api

Параметр, позволяющий выбрать способ резервного копирования средствами oVirt API [1].

Если используется значение yes, то модуль выполняет бэкап средствами oVirt API.

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

yes, no

По умолчанию

no

remove_vm_checkpoints_at_full_backup

При создании бэкапа ВМ средствами oVIRT API платформа виртуализации формирует чекпойнт [2] резервируемой ВМ.

Если у данного параметра значение выставлено в yes, а также у параметра backup_using_ovirt_api значение yes, то при каждом полном РК ВМ, СРК (модуль) выполнит запрос на получение списка имеющихся чекпойнтов ВМ, и для каждого чекпойнта отправит запрос на его удаление.

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

yes, no

По умолчанию

no

platform_side_backup_timeout

Параметр указывает время (в секундах), в течение которого модуль будет ожидать готовности (переход oVirt бэкапа в состояние ready [3]) резервной копии.

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

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

от 1 до 7200

По умолчанию

7200

backup_finalize_timeout

Параметр указывает время (в секундах), в течение которого модуль будет ожидать (ожидается переход oVirt бэкапа в состояние succeeded) успешного завершения резервного копирования.

Если время ожидания истекло, но резервное копирование не завершилось успешно, в журнал модуля /opt/rubackup/log/rb_module_ovirt.log будет добавлено предупреждение.

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

от 1 до 3600

По умолчанию

300

clean_vm_operations_before_new_backup

Параметр завершает все операции с ВМ перед началом нового резервного копирования

Применяется только при восстановлении из копий, созданных с backup_using_ovirt_api=yes
Возможные значения

yes, no

По умолчанию

no

use_secret_storage

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

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

yes, no

По умолчанию

no

create_vm_snapshot_timeout

Параметр указывает время (в секундах), в течении которого модуль будет совершать попытки создать снимок состояния ВМ

Применяется только при восстановлении из копий, созданных с backup_using_ovirt_api=yes
Возможные значения

от 1 до 3600

По умолчанию

300

inter_snapshots_creation_timeout

Параметр указывает интервал ожидания (в секундах) между операциями по созданию снимков состояния ВМ

Применяется только при восстановлении из копий, созданных с backup_using_ovirt_api=yes
Возможные значения

от 60 до 3600

По умолчанию

60

delete_vm_snapshot_timeout

Параметр указывает время (в секундах), в течении которого модуль будет совершать попытки удалить снимок состояния ВМ

Применяется только при восстановлении из копий, созданных с backup_using_ovirt_api=yes
Возможные значения

от 1 до 3600

По умолчанию

300

disk_snapshot_wait_unlock_timeout

Параметр указывает время (в секундах), в течении которого модуль будет ожидать диск или снимок состояния ВМ в состояние ОК

Применяется только при восстановлении из копий, созданных с backup_using_ovirt_api=yes
Возможные значения

от 1 до 3600

По умолчанию

300

disk_snapshot_transfer_timeout

Параметр указывает время (в секундах), в течении которого модуль совершает попытки создания объекта ImageTransfer для загрузки данных диска или снимка состояния в среду виртуализации oVirt

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

от 1 до 3600

По умолчанию

300

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

Пример листинга конфигурационного файла /opt/rubackup/etc/rb_module_ovirt.conf.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
#
# oVirt engine FQDN
engine <fqdn>
# Authentication grant type.
# Default value: password
grant_type password
username <username>
password <password>
ca_info  <path to a certificate>
# Maximum time allowed for http request (from start to end) in seconds.
# Default value: 1
timeout 20
#
# The mechanism used (backend) to upload the disk to the server.
# Possible values: file or nbd
# Default: file
disk_upload_mechanism file
#
# Set this flag to 'yes' if there is a need to assign a VM backup task the RuBackup client
# which is running on the same host as the target VM.
#If set 'no' the backup task will be assigned the RuBackup client node used for backup rule creation.
#Default value: yes
backup_vm_from_native_host yes
#
# Specifies the maximum single disk upload timeout in minutes. Default: 25 minutes. Min 1 minute
disk_upload_timeout 25
# Specifies the maximum single disk download timeout in minutes. Default: 25 minutes. Min 1 minute
disk_download_timeout 25
#
# RuBackup module creates oVirt ImageTransfer in order to download or upload disk data.
# Parameter 'image_transfer_timeout' specifies the amount of time in seconds
# the module will wait the ImageTransfer goes to state "transferring".
# If this timeout is reached but the ImageTransfer is not in 'transferring' state
# corresponding backup or restore task will end with error.
# Possible values: [1, 3600]
# Default value: 300
image_transfer_timeout 300
#
# oVirt ImageTransfer inactivity_timeout in seconds. Default: 60 seconds. Min 5 seconds, max 500 seconds
imagetransfer_inactivity_timeout 60
#
# When backup via oVirt API is done and VM disks are dumped
# RuBackup module initiates finalizing the ImageTransfer.
# After that it waits while the the ImageTransfer reaches state 'finished_success'.
# Parameter 'image_transfer_finalize_timeout' specifies the amount of time in seconds
# the module will wait the ImageTransfer is finalized.
# If this timeout is reached but the ImageTransfer is not in 'finished_success'
# state a Warning is added to the module log.
# Further ovirt backup finalizing can also fail due to this.
# Possible values: [1, 3600]
# Default value: 300
image_transfer_finalize_timeout 300
#
# Try using the module if the platform version is not compatible with RuBackup. Default: no
allow_work_with_incompatible_versions no
#
# Turn on debug of REST requests
# Possible values: yes, no. Default no
curl_verbose no
#
# Set this flag to 'yes' if there is a need to make a VM backup by means of the platform (oVirt API)
# Possible values: yes, no
# Default value: no
backup_using_ovirt_api no
#
# Set this flag to 'yes' if there is a need to remove all VM checkpoints at full backup task.
# The flag is applicable only if 'backup_using_ovirt_api' is set to 'yes'.
# Possible values: yes, no
# Default value: no
remove_vm_checkpoints_at_full_backup no
#
# When the 'backup_using_ovirt_api' is set to 'yes', RuBackup module initiates backup
# of a VM using oVirt API. After that it waits while the backup reaches state 'ready'.
# Parameter 'platform_side_backup_timeout' specifies the amount of time in seconds
# the module will wait the backup is ready.
# If this timeout is reached but the backup is not in 'ready' state
# corresponding backup task will end with error.
# Possible values: [1, 72000] seconds
# Default value: 7200 seconds
platform_side_backup_timeout 7200
#
# When backup via oVirt API is ready and VM disks are dumped
# RuBackup module initiates finalizing the backup.
# After that it waits while the backup reaches state 'succeeded'.
# Parameter 'backup_finalize_timeout' specifies the amount of time in seconds
# the module will wait the backup succeeded.
# If this timeout is reached but the backup is not in 'succeeded'
# state a Warning is added to the module log.
# Possible values: [1, 3600]
# Default value: 300
backup_finalize_timeout 300
#
# If this flag is set (value 'yes') the RuBackup module cancels active VM ImageTransfers
#  and finalizes VM Backup(s) before start of a new Backup.
# This behavior is applicable only when 'backup_using_ovirt_api' is set to 'yes'.
# Possible values: yes, no
# Default value: no
clean_vm_operations_before_new_backup no
#
# Enable interaction with centralized secret repositories
# Possible values: yes, no. Default: no
use_secret_storage no
#
# When a VM snapshot is being created, it can fail if some internal
# operations of oVirt are not finished yet. The module is waiting for
# successful snapshot creation during 'create_vm_snapshot_timeout' seconds.
# If a timeout is reached, the task will fail. To mitigate this,
# increase the value of the parameter
# Applicable only for restore of copies created with backup_using_ovirt_api=yes.
# Possible values: [1, 3600] seconds
# Default value: 300  seconds
create_vm_snapshot_timeout 300
#
# To fix the oVirt VM snapshot creation issue, a timeout should be applied between snapshot creations.
# Applicable only for restore of copies created with backup_using_ovirt_api=yes.
# Possible values: [60, 3600] seconds
# Default value: 60 seconds
inter_snapshots_creation_timeout 60
#
# When a VM snapshot is deleting, it can fail if some internal
# operations of oVirt are not finished yet. The module is waiting for
# successful snapshot deletion during 'delete_vm_snapshot_timeout' seconds.
# If a timeout is reached, the task will fail. To mitigate this, increase
# the value of the parameter.
# Applicable only for restore of copies created with backup_using_ovirt_api=yes.
# Possible values: [1, 3600] seconds
# Default value: 300 seconds
delete_vm_snapshot_timeout 300
#
# During a restore operation, a VM's disk/snapshot can be busy because
# it is processed by oVirt. This parameter is used to set amount of time
# (in seconds) to wait while the disk/snapshot becomes available.
# If a timeout is reached, the task will fail. To mitigate this, increase
# the value of the parameter.
# Applicable only for restore of copies created with backup_using_ovirt_api=yes.
# Possible values: [1, 3600] seconds
# Default value: 300 seconds
disk_snapshot_wait_unlock_timeout 300
#
# During a backup/restore operation, a VM's disk/snapshot can be busy because
# it is processed by oVirt. This parameter is used to set amount of time
# (in seconds) to wait while the disk/snapshot will be ready for transfer operation.
# If a timeout is reached, the task will fail. To mitigate this, increase
# the value of the parameter.
# Possible values: [1, 3600] seconds
# Default value: 300 seconds
disk_snapshot_transfer_timeout 300