В этом разделе

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

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

Параметр Описание

identity_url^[1]

URL-адрес для доступа к сервису Identity для идентификации пользователя

По умолчанию

http://<OPENSTACK_WEBUI_IP>:5000/v3/

compute_url^[1]

URL-адрес для доступа к сервису Compute, предоставляющего вычислительные мощности для создания виртуальных машин и управления ими

По умолчанию

http://<OPENSTACK_WEBUI_IP>:8774/v2.1/<PROJECT_ID>/

volume_url^[1]

URL-адрес для доступа к сервису Volume для блочного хранения данных

По умолчанию

http://<OPENSTACK_WEBUI_IP>:8776/v3/<PROJECT_ID>/

network_url^[1]

URL-адрес для доступа к сервису Network для управления сетями

По умолчанию

http://<OPENSTACK_WEBUI_IP>:9696

image_url^[1]

URL-адрес для доступа к сервису Image для взаимодействия с образами

По умолчанию

http://<OPENSTACK_WEBUI_IP>:9292

project_id^[1]

Идентификатор проекта платформы виртуализации

По умолчанию

<PROJECT_ID>

username^[2]

Имя для авторизации пользователя в платформе виртуализации

По умолчанию

<user name>

password^[2]

Пароль для авторизации пользователя в платформе виртуализации

По умолчанию

<user password>

domain^[1]

Имя домена платформы виртуализации

По умолчанию

<domain name>

timeout

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

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

1-300

По умолчанию

5

rubackup-vm-id^[1]

Идентификатор виртуальной машины, на которой установлен клиент РК RuBackup

По умолчанию

<vm id>

admin_name^[2]

Имя для авторизации администратора на платформе виртуализации

По умолчанию

<admin name>

Требуется для возможности запуска скриптов внутри виртуальной машины в процессе выполнения задачи резервного копирования

Для возможности резервного копирования виртуальных машин из различных проектов и для восстановления виртуальных машин в эти проекты учетная запись администратора должна иметь роли admin и member в платформе виртуализации.

admin_password^[2]

Пароль для авторизации администратора на платформе виртуализации

По умолчанию

<admin password>

admin_project_name

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

По умолчанию

NONE

Если значение параметра не задано, то используется идентификатор, указанный в параметре project_id

admin_project_domain_name

Имя администратора домена проекта на платформе виртуализации

По умолчанию

NONE

Если значение параметра не задано, то используется идентификатор, указанный в параметре project_id

enable_ssl

Включить проверку ssl-сертификатов для REST-запросов к платформе виртуализации

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

yes, no

По умолчанию

no

ca_info

Путь до корневого ssl-сертификата клиента СРК RuBackup с установленным модулем в формате .pem при использовании SSL соединения (требуется указать при значении yes параметра enable_ssl)

По умолчанию

<path to cert>

curl_verbose

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

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

yes, no

По умолчанию

no

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

curl_workers

Количество параллельных REST-запросов при запросе списка ресурсов модуля

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

1-100

По умолчанию

1

script_transport

Тип транспорта для отправки запроса на выполнение скриптов в гостевой ОС резервируемой ВМ до/после создания снимков состояния в процессе резервного копирования

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

virsh, ssh

По умолчанию

virsh

ssh_user

Имя пользователя для транспорта типа ssh

По умолчанию

rubackup_service_user

ssh_connection_timeout

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

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

1-300

По умолчанию

5

ssh_key_file

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

По умолчанию

/root/my_keys/my_key_file

region^[2]

Дополнительный параметр для авторизации в платформе виртуализации и для взаимодействия с платформой через REST API

По умолчанию

NONE

Задается, если в платформе виртуализации используется регион не по умолчанию

cinder_api_request_retry_number

Количество повторных REST-запросов к сервису Cinder платформы, которые будут выполнены в случае, если от сервиса был получен ответ с ошибкой

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

0-10

По умолчанию

0

При значении 0 повторные REST-запросы не выполняются

cinder_api_request_retry_timeout

Тайм-аут (в секундах) между повторными REST-запросами к сервису Cinder платформы, которые будут выполнены в случае, если от сервиса был получен ответ с ошибкой

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

1-600

По умолчанию

1

volume_creation_timeout

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

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

100-600

По умолчанию

300

Если время, заданное параметром volume_creation_timeout, истекло с момента отправки запроса на создание тома, и при этом том не перешел в состояние available, то соответствующая задача на создание РК завершится с ошибкой

snapshot_creation_timeout

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

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

100-600

По умолчанию

300

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

Если время, заданное параметром snapshot_creation_timeout, истекло с момента отправки запросов на создание снимков состояния, и при этом снимки не перешли в состояние available, то соответствующая задача на создание РК завершится с ошибкой

volume_attachment_timeout

Время (в секундах), в течение которого модуль ожидает подключения тома (перехода тома в состояние in-use с момента оправки запроса на его подключение) к виртуальной машине в платформе виртуализации

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

100-600

По умолчанию

300

Если время, заданное параметром volume_attachment_timeout, истекло с момента отправки запроса на подключение тома к ВМ, и при этом том не перешел в состояние in-use, то соответствующая задача на создание или восстановление РК завершится с ошибкой

Пример листинга конфигурационного файла /opt/rubackup/etc/rb_module_openstack.conf

# Description variables
# 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
# Get config URLs at https://<OPENSTACK_WEBUI_IP>/dashboard/project/api_access/
# or https://msk.cloud.vk.com/app/<PROJECT>/project/endpoints
#identity_url http://<OPENSTACK_WEBUI_IP>:5000/v3/
# URL to the  compute service, optional
# compute_url http://<OPENSTACK_WEBUI_IP>:8774/v2.1/<PROJECT_ID>/
# URL to the volumev3 service, optional
# volume_url  http://<OPENSTACK_WEBUI_IP>:8776/v3/<PROJECT_ID>/
# URL to the network service, optional
# Network URL must be provided without version in path
# network_url http://<OPENSTACK_WEBUI_IP>:9696
# Image URL must be provided without version in path
# image_url http://<OPENSTACK_WEBUI_IP>:9292
#project_id <PROJECT_ID>
# 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>
# REST operations timeout, seconds
# minimum 1, maximum 300, default 5
#timeout 20
# ID of VM in Openstack platform where current module is deployed - can
# be obtained from instance info in WEB GUI
#rubackup-vm-id <vm id>
##
## Optional parameters:
#  Admin user account info of OPENSTACK is required to run scripts
#  inside the target VM
#admin_name <admin name>
#admin_password <admin password>
#
## Name of admin's project, optional
## If this value is not set, project_id value will be used instead as
#admin's project admin_project_name NONE
## Name of admin's project domain, optional
#admin_project_domain_name NONE
#
# 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 no
## Amount of parallel workers for REST requests
# min 1, max 100, default 1
#curl_workers 1
##
## Transport to execute remote scrips: before_backup, after_backup
# possible values: virsh, ssh
# default value: virsh
#script_transport virsh
##
## User name for ssh transport
#ssh_user rubackup_service_user
## Connection timeout for ssh transport, seconds
# minimum 1, maximum 300, default 5
#ssh_connection_timeout 30
## ssh key file for ssh transport, full path only!
#ssh_key_file /root/my_keys/my_key_file
# Project's region, optional
#region NONE
## Number of retry attempts for cinder API requests in case of negative
#response from API
# minimum 0, maximum 10, default 0
#cinder_api_request_retry_number 0
## Value of a timeout in seconds to wait for between retry requests to
#cinder API in case of negative response from API
# minimum 1, maximum 600, default 1
#cinder_api_request_retry_timeout 1
## Timeout for creating volumes in openstack platform, seconds
# minimum 100, maximum 600, default 300
#volume_creation_timeout 300
## Timeout for creating snapshots in openstack platform, seconds
# minimum 100, maximum 600, default 300
#snapshot_creation_timeout 300
## Timeout for attaching and detaching volumes in openstack platform, seconds
# minimum 100, maximum 600, default 300
#volume_attachment_timeout 300
#
# Variables value
identity_url
project_id
username
password
domain
rubackup-vm-id

1. Для получения данных воспользуйтесь веб-интерфейсом платформы виртуализации OpenStack.

2. Запросите данные у администратора платформы виртуализации OpenStack.

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

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