Конфигурационный файл rb_module_ovirt.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
engine <url>
grant_type <password>
username <username>
password <password>
ca_info <path to a certificate>
timeout <timeout in seconds>
# The mechanism used (backend) to upload the disk to the server. Default: file
disk_upload_mechanism <file/nbd>
# 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 'platfom_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]
# Default value: 7200
platfom_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
Параметры из конфигурационного файла rb_module_ovirt.conf
представлены в
таблице 1.
Параметр | Назначение | Значение по умолчанию |
---|---|---|
|
IP-адрес для API-запросов в платформу виртуализации oVirt |
|
|
Тип гранта токена аутентификации OAuth для взаимодействия с API-платформой виртуализации |
password |
|
Имя пользователя, от имени которого будут выполняться запросы API |
|
|
Пароль для пользователя, указанного в параметре username |
|
|
Путь до сертификата ssl |
|
|
Время ожидания (в секундах) ответа от платформы виртуализации на API запросы. Минимум 1 секунда, максимум 300 секунд, по умолчанию 10 секунд. Если при выполнении задачи на создание РК или восстановление РК ответ от платформы не поступит в течение заданного опцией timeout времени, то соответствующая задача может быть завершена с ошибкой |
10 |
|
Механизм для чтения данных диска и записи данных на диск внутри платформы виртуализации. Допустимые значения:
|
file |
|
Параметр определяет, будет ли задача резервного копирования виртуальной машины назначена клиенту RuBackup, который работает на том же хосте, что и целевая ВМ.
|
yes |
|
Таймаут для загрузки каждого диска на платформу при восстановлении. Измеряется в минутах. По умолчанию 25 минут. Минимальное значение — 1 минута; |
25 |
|
Таймаут для загрузки каждого диска с платформы при бэкапе. Измеряется в минутах. По умолчанию 25 минут. Минимальное значение — 1 минута; |
25 |
|
Параметр указывает время в секундах, в течение которого модуль будет ожидать перехода ImageTransfer в состояние "transferring". Если этот время ожидания истекло, но ImageTransfer не перешел в состояние "transferring", то соответствующая задача резервного копирования или восстановления завершится с ошибкой. По умолчанию 300 секунд. Минимальное значение — 1 секунда, максимальное — 3600 секунд; |
300 |
|
Параметр определяет какое количество секунд платформа будет ожидать начала загрузки диска после создания ImageTransfer-а. Измеряется в секундах. Минимальное значение — 5 секунд, максимальное значение — 500 секунд. |
60 |
|
Параметр указывает время в секундах, в течение которого модуль будет ожидать завершения ImageTransfer. Если время ожидания истекло, но ImageTransfer не перешел в сосотояние "finished_success", в журнал модуля будет добавлено предупреждение. Из-за этого резервное копиривание может завершиться с ошибкой. |
300 |
|
Параметр, указывающий, будет ли модуль работать с версией платформы виртуализации, совместимость с которой не была протестирована. Допустимые значения: yes, no. Если модуль не совместим с версией платформы виртуализации и значение параметра установлено в no, модуль завершит свою работу с соответствующим сообщением об ошибке. При необходимости работы с несовместимой версией платформы виртуализации установите параметр в значение yes |
no |
|
Параметр выводит дополнительную информацию по REST API запросам, при значении yes. |
no |
|
Параметр, позволяющий выбрать способ резервного копирования средствами oVirt API [1]. Допустимые значения: Если используется значение При значении
|
no |
|
При создании бэкапа ВМ средствами oVIRT API платформа виртуализации формирует чекпойнт [2] резервируемой ВМ.
Если у данного параметра значение выставлено в |
no |
|
Параметр указывает время в секундах, в течение которого модуль будет ожидать готовности (переход oVirt бэкапа в состояние |
7200 |
|
Параметр указывает количество времени в секундах, в течение которого модуль будет ожидать (ожидается переход oVirt бэкапа в состояние |
300 |