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

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

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

termidesk_url[1]

Адрес хоста с Termidesk API

termidesk_api_version[1]

Версия Termidesk API

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

draft, v1, v1.1, v2 и т.д.

termidesk_username[1]

Логин администратора Brest для Termidesk API

termidesk_password[1]

Пароль администратора Brest для Termidesk API

vm_state_timeout

Время ожидания (в секундах) с момента запроса на создание ВМ до ее перехода в состояние POWEROFF при восстановлении из РК

Диапазон значений

10-86400
По умолчанию

300

enable_remote_backup

Ускорение процедуры резервного копирования. Не рекомендуем использовать параметр начиная с версии СРК RuBackup 2.6

snapshot_path

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

По умолчанию

vm_path

При значении по умолчанию снимки состояния томов ВМ создаются по пути /var/lib/datastores/<id хранилища>/<id ВМ>/ на узле виртуализации, где эта ВМ запущена.

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

Определенные пути необходимо дополнительно указать в файле /usr/sbin/pdp-init-libvirt в переменной LIBVIRT_DIRS, а затем перезапустить сервис libvirt

free_to_total_storage_space_ratio

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

По умолчанию

30

Если по пути, который задан параметром snapshot_path доля свободного пространства меньше, чем указано в параметре free_to_total_storage_space_ratio, то задача на резервное копирование будет завершена с ошибкой, модуль зафиксирует предупреждение в журнале

remove_old_snapshots_if_found

Удаление неактуальных снимков состояния томов ВМ

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

yes, no
По умолчанию

no

Если на момент выполнения задачи резервного копирования ВМ для томов данной ВМ обнаружены неактуальные файлы снимков состояния, созданные модулем, то при значении:

  • yes модуль выполнит удаление неактуальных файлов снимков состояния, задача на резервное копирование продолжит свое выполнение;

  • no задача на резервное копирование будет завершена с ошибкой, модуль зафиксирует предупреждение в журнале.

commit_old_snapshots_if_found

Финализация снимков состояния томов ВМ

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

yes, no
По умолчанию

no

Если на момент выполнения задачи резервного копирования ВМ обнаружен нефинализированнный снимок состояния томов ВМ, созданный модулем, то при значении:

  • yes модуль выполнит финализацию снимка состояния, задача на резервное копирование продолжит свое выполнение;

  • no задача на резервное копирование будет завершена с ошибкой, модуль зафиксирует предупреждение в журнале.

platform_user

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

По умолчанию

root

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

Пользователь должен входить в группу brestadmins.

Для возможности создания моментальных снимков состояния томов ВМ пользователь должен входить в группы astra-console, astra-admin, kvm, libvirt, libvirt-qemu, libvirt-admin, oneadmin на узлах фронтальных[2] машин и гипервизоров.

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

Пример 1. Выдача прав пользователю
chown -R <platform_user>:brestadmins <rubackup_tmp_dir_path>
chmod -R 770 <rubackup_tmp_dir_path>

Для платформы виртуализации версии 3.3.3 при значении:

  • root не гарантируется восстановление ВМ из РК с использованием параметра восстановления restore_on_current_node;

  • oneadmin не гарантируется восстановление ВМ из РК с развертыванием.
2. Машина, на которой развернуты клиент СРК RuBackup и модуль.
Пример листинга конфигурационного файла /opt/rubackup/etc/rb_module_brest_vm.conf
# Конфигурационный файл заполняется пользователем вручную
#
# Символ "#" в начале строки воспринимается как комментарий
# "#" в середине строки воспринимается как значение параметра
# По этой причине не стоит добавлять комментарии на одной строке
# с именем и значением параметра
#
# Хост с Termidesk API
#
#termidesk_url: ~
#
# Версия Termidesk api, например draft, v1, v1.1, v2
#
#termidesk_api_version: ~
#
# Учетные данные администратора Brest для Termidesk api
#
#termidesk_username: ~
#termidesk_password: ~
#
# Время ожидания в секундах с момента запроса на создание ВМ до ее перехода в состояние
# "POWEROFF" (8) при восстановлении из РК.
# Значение по умолчанию: 300 секунд
# Минимальное значение: 10 секунд
# Максимальное значение: 86400 секунд
vm_state_timeout: 300
#
# Опция актуальна если ВМ, для которой выполняется резервное копирование:
# - содержит тома на базе LVM-LVM хранилища;
# - расположена на хосте, отличном от того, где запущена процедура бэкапа.
# Возможные значения: yes, no.
# Значение по умолчанию: no.
# Если установлено значение "yes", то тома ВМ отправляются в РК
#   непосредственно с хоста, на котором эта ВМ расположена, т.е. не происходит промежуточного
#   копирования томов ВМ на фронтальный хост, где запущена процедура бэкапа.
# Важно отметить, что при этом недоступны опции защищенного преобразования и цифровой подписи РК.
#
enable_remote_backup: no
#
# Путь до директории на узле виртуализации, в которой будут создаваться снэпшоты томов при бэкапе включенной ВМ.
# Если установлено значение "vm_path", снэпшоты ВМ создаются в директории ВМ на узле виртуализации: /var/lib/datastores/<id хранилища>/<id ВМ>/
snapshot_path: vm_path
#
# Необходимая доля свободного пространства в процентах на томе в директории,
#  в которой будут созданы снэпшоты томов включенной ВМ при ее резервировании.
free_to_total_storage_space_ratio: 30
#
# Если для опции 'remove_old_snapshots_if_found' установлено значение 'yes',
#  и на момент выполнения задачи резервирования ВМ для томов данной ВМ обнаружены неактуальные файлы снэпшотов,
#  созданные данным модулем, например в случае нештатного завершения предыдущей задачи резервирования,
#  то на текущей итерации бэкапа модуль выполнит удаление неактуальных файлов снэпшотов.
# В аналогичной ситуации при значении 'no' данного парамтера задача резервирования ВМ завершится с ошибкой.
# Возможные значения: yes, no
# Значение по умолчанию: no
remove_old_snapshots_if_found: no
#
# Если для опции 'commit_old_snapshots_if_found' установлено значение 'yes',
#  и на момент выполнения задачи резервирования ВМ обнаружен нефинализированнный снэпшот ВМ,
#  созданный данным модулем, например в случае нештатного завершения предыдущей задачи резервирования,
#  то на текущей итерации бэкапа модуль выполнит финализацию снэпшота.
# В случае успеха задача резервирования ВМ продолжит свое выполнение.
# Возможные значения: yes, no
# Значение по умолчанию: no
commit_old_snapshots_if_found: no
#
# Пользователь, от имени которого будут выполняться команды
#  для взаимодействия с платформой виртуализации.
# В случае c ПК СВ Брест, пользователь должен входить в группу "brestadmins".
# Значение по умолчанию: root
platform_user: root
1. Используется для выполнения резервного копирования виртуальных машин платформы виртуализации, которые находятся в кластере Termidesk.