General Parameters

The following OpenStack Plugin parameters impact Backup and Restore Jobs as well as the Query bconsole commands.

Openstack General Parameters
Parameter	Values	Default	Description
proxy_server	`<String>`		UUID or name of the proxy server used to run the Bacula File Daemon with the Openstack Plugin. This parameter is required.
abort_on_error	`[= <0 or 1>]`	`0`	Specifies whether the plugin should abort on fatal errors during backup or restore. This parameter is optional.
OS_USERNAME	`<String>`		Specifies the username to access the Openstack API.
OS_PASSWORD	`<String>`		Specifies the password to access the Openstack API
OS_AUTH_URL	`<String>`		Specifies the endpoint to access the Openstack API
OS_USER_DOMAIN_NAME	`<String>`		Specifies the domain that accesses the Openstack API
OS_PROJECT_NAME	`<String>`		Specifies the project that accesses the Openstack API
openrc	`<String>`	`/opt/bacula/etc/openstack.conf`	Specifies the path to an OpenStack RC file to automatically gather connection information.
verbose	`[= <0 or 1>]`	`0`	This parameter activate verbose output in Bacula joblog.
debug	`[0 - 9]`	`0`	Specifies the debug level. `0` is no debug, `9` is the highest level. Warnings and errors are always sent to the joblog and if any debug level is set, those messages are sent to the debug file as well. For the OpenStack Plugin, `1` displays debug level message, `2` displays trace level message. Any value higher than `2` displays additional information about external libraries that handle those values on their own. This parameter is optional.

Note

Parameters sent from the restore object have precedence over everything. Parameters sent from the CLI have precedence over parameters from the configuration file.

Plugin Parameters in the OpenStack RC File

Usually, to manage the OpenStack environment using the OpenStack command-line client, a file called OpenStack RC file can be used to set the required environment variables to access the OpenStack project API. More details about the contents and how the OpenStack RC file can be generated can be found in the OpenStack documentation: https://docs.openstack.org/newton/user-guide/common/cli-set-environment-variables-using-openstack-rc.html

This is an example of an OpenStack RC file for the demo OpenStack project:

unset OS_SERVICE_TOKEN
export OS_USERNAME=demo
export OS_PASSWORD='thisIsAPassword'
export PS1='[\u@\h \W(keystone_demo)]\$ '
export OS_AUTH_URL=http://1.1.11.111:2222/v3

export OS_PROJECT_NAME=demo
export OS_USER_DOMAIN_NAME=Default
export OS_PROJECT_DOMAIN_NAME=Default
export OS_IDENTITY_API_VERSION=3

This file can be used as a configuration file for the Bacula OpenStack Plugin to automatically fetch the values for the OS_USERNAME, OS_PASSWORD, OS_AUTH_URL, OS_USER_DOMAIN_NAME, and OS_PROJECT_NAME plugin options.

When using an OpenStack RC file with the required environment variables with the Bacula OpenStack Plugin, the openrc=<pathToOpenStackRCfile> parameter must be configured. By default, the plugin will check if there is the /opt/bacula/etc/openstack.conf as the OpenStack RC file if the openrc option is not configured.

Warning

The OpenStack RC file downloaded from the OpenStack dashboard requires user interaction for proper functionality. To ensure the plugin operates correctly, it is recommended to modify the downloaded OpenStack RC file by commenting out the lines echo "Please enter your OpenStack Password for project $OS_PROJECT_NAME as user $OS_USERNAME: ", read -sr OS_PASSWORD_INPUT, and export OS_PASSWORD=$OS_PASSWORD_INPUT, while adding OS_PASSWORD_INPUT=<password_value> with the appropriate password value.