Установка клиента

Для возможности резервного копирования виртуальных машин среды виртуализации RUSTACK необходимо установить клиента RuBackup на одну или несколько виртуальных машин в среде виртуализации RUSTACK, находящихся под управлением операционной системы Ubuntu 18.04 или 20.04, и для которой настроен доступ к гипервизору (гипервизорам). Сюда же необходимо установить модуль rb_module_rustack из пакета rubackup-rustack.deb (см. дистрибутив для ОС Ubuntu).

Подробно процедура установки клиента описана в документе «Руководство по установке серверов резервного копирования и Linux клиентов RuBackup».

При установке клиента рекомендуется использовать функцию централизованного восстановления в тех случаях, когда предполагается восстановление виртуальной машины из средства управления RBM. В ходе инсталляции пакета в системе будет создан файл настроек доступа системы резервного копирования к API RUSTACK /opt/rubackup/etc/rb_module_rustack.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
#
# Mandatory parameters
url <rustack url>
# User name on behalf of which the API requests will proceed
username <user name>
# Password to be used with 'username' to authenticate in API
password <user password>
# Domain name to be used with 'username' and 'password' to authenticate in API
domain <domain name>
# ID of a project to which target VMs belong to
project_id <PROJECT_ID>
# Timeout for curl API requests: minimum 1, maximum 300, default 5 (seconds)
timeout 20
# Timeout for creating volumes in Rustack platform, default 300 (seconds)
volume_creation_timeout 300
# Timeout for creating snapshots in Rustack platform, default 300 (seconds)
snapshot_creation_timeout 300
# Timeout for attaching and detaching volumes in Rustack platform, default 300 (seconds)
volume_attachment_timeout 300
# ID of VM in Rustack platform where current module is deployed - can be obtained using -l option of the module
rubackup-vm-id <vm id>
##
## Optional parameters:
#  Admin user account info of RUSTACK is required to run scripts inside the target VM
admin_name <admin name>
admin_password <admin password>
# Protocol for hypervisor requests: tcp or ssh, default: ssh
protocol ssh
# If certificate info is not specified the module will connect to API w/o certificate verification
enable_ssl no
ca_info <path to cert>
# Turn on debug of REST requests
#curl_verbose

Измените в этом файле настройки для подключения к API.

Обязательные параметры конфигурационного файла:

  • url <rustack url> — адрес (IP или FQDN), используемый для API запросов в платформу виртуализации RUSTACK.

  • username <user name> — имя пользователя, от имени которого будут выполняться запросы API.

  • password <user password> — пароль, который будет использоваться вместе с именем пользователя для аутентификации в API.

  • domain <domain name> — доменное имя, которое будет использоваться с именем пользователя и паролем для аутентификации в API.

  • project_id <PROJECT_ID> — идентификатор проекта внутри платформы виртуализации RUSTACK, к которому относятся виртуальные машины, для которых предполагается возможность создания резервных копий.

  • timeout — время ожидания для запросов curl API. По умолчанию составляет 5 секунд. Может принимать значения от 1 до 300 секунд.

  • volume_creation_timeout — время ожидания для создания томов на платформе Rustack. По умолчанию составляет 300 секунд. Если с момента обработки платформой виртуализации запроса на создание тома, этот том не перешел в состояние «available» в течение заданного времени, соответствующая задача на создание резервной копии или восстановление завершится с ошибкой;.

  • snapshot_creation_timeout — время ожидания для создания снимков на платформе Rustack. По умолчанию составляет 300 секунд. Если с момента обработки платформой виртуализации запроса на создание снимка, этот снимок не перешел в состояние «available» в течение заданного времени, соответствующая задача на создание резервной копии завершится с ошибкой;

  • volume_attachment_timeout — время ожидания для подключения к виртуальной машине и отключения томов (том не перешел в статус «in_use») на платформе Rustack. По умолчанию составляет 300 секунд. Если обозначенный таймаут истек, а том не был присоединен к виртуальной машине или отсоединен от виртуальной машины (том не перешел в статус «available»), отображается ошибка.

  • rubackup-vm-id <vm id> — идентификатор виртуальной машины (внутри платформы виртуализации RUSTACK), на которой развернут данный модуль и клиент RuBackup.

список виртуальных машин внутри проекта (project_id), включая их имя, идентификатор и текущий статус, можно получить, запустив исполняемый файл модуля c опцией -l: /opt/rubackup/modules/rb_module_rustack -l

При этом, перед листингом витуальных машин в конфигурационном файле модуля как минимум должны быть заданы значения для параметров: url, username, password, domain, project_id, timeout.

Необязательные параметры:

  • admin_name <admin name> — имя пользователя, имеющего права администратора внутри платформы виртуализации RUSTACK для запуска скриптов внутри целевой виртуальной машины.

  • admin_password <admin password> — пароль пользователя, имеющего права администратора внутри платформы виртуализации RUSTACK. Используется вместе с именем администратора для аутентификации в API.

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

  • protocol — протокол для запросов к гипервизору: tcp или ssh. По умолчанию используется ssh тк этот протокол безопаснее, чем tcp.

  • enable_ssl — параметр, указывающий, следует ли использовать SSL-сертификат. Доступные значения: yes и no. Если указано значение yes, то необходимо раскомментировать параметр ca_info и указать полный путь до SSL-сертификата, если указано значение no, то в таком случае запросы к API платформы виртуализации RUSTACK будут выполняться без проверки сертификата. Если информация о сертификате не указана, модуль подключится к API без проверки.

  • ca_info — путь к SSL-сертификату, который будет использоваться при подключении к API, если включена проверка сертификата.

для целей отладки подключения к API в конфигурационный файл модуля можно добавить следующую строку:

`curl_verbose`

curl_verbose — включает режим отладки REST-запросов.

При старте клиента RuBackup в журнальном файле /opt/rubackup/log/RuBackup.log на клиенте появится следующая запись:

Image1

В ручном режиме проверить правильность настроек можно при помощи следующей команды: /opt/rubackup/modules/rb_module_rustack -t