...
Table of Contents |
---|
Introduction
Abiquo supports version of 5.3 of Rubrik.
You can use Rubrik with:
VMware vCloud Director
VMware vCenter
...
Changes to the Rubrik integration
Abiquo 5.4.4
The abiquo.rubrik.vcenter.id property is deprecated in Abiquo 5.4.4 and you should remove it
The abiquo.backup.rubrik.sla property will now replace the default Rubrik SLA domains (Gold, Silver, Bronze).
From Abiquo 5.4.4+ you must define ALL the default and custom domains that you wish to use in Rubrik. See #Rubrik configuration properties reference
Abiquo 6.0.0
Optional abiquo.backup.policy.sync.delay property to set on the Abiquo Server in the
abiquo.properties
file.
Specify how often to run the backup policy synchronization in milliseconds. The default value represents 24 hours.
...
Requirements
When you use Rubrik with vCloud Director
, toYou must configure the endpoint in Rubrik properties
To create the Backup manager in Abiquo, you must enter Rubrik credentials
and vCloud
credentials separated by a hash (
#
) or a custom separator configured in
Rubrik properties
For Rubrik, Abiquo backup policies must have the policy policy Code set set to a valid Rubrik SLA Domain (default or custom)
Users can add one backup policy only to a VM or they can request an immediate backup
...
Create custom SLA domains in Rubrik
The default Abiquo configuration includes the default Rubrik SLA Domains: Gold
, Silver
, and Bronze
.
To use custom SLA domains, first create them in Rubrik.
Then save the names of ALL the SLA domains you will use to configure them to Abiquo.
...
Configure Rubrik properties
To configure the Rubrik backup integration properties:
Log in to the Abiquo Remote Services server.
Go to the
/opt/abiquo/
...
config
folder and create a
...
rubrik.
...
properties
file.Make the tomcat user the owner of this file.
This is the default location, but you can configure
...
another location of
...
the file in Abiquo properties
Edit this properties file and add properties as described in the following steps
If you are using Rubrik with vCloud Director, you must set the endpoint for vCloud, for example:
Code Block abiquo.rubrik.vcloud.endpoint=https://myvclouddirector.example.com
For vCloud, configure each datacenter and its corresponding vCenter. Use the same index (integer) for a datacenter and its vCenter. The datacenter is the Name of an Abiquo public cloud region of the vCloud. To obtain the vCenter ID, obtain the Rubrik ID of a VM running on the vCenter from Rubrik. The format of the Rubrik ID is:
VirtualMachine:::vCenterId-mobIdVM
, so for example:VirtualMachine:::ee92b229-0dff-4632-b94e-eb9f581e1cff-vm-18662
. In this case, the vCenter ID isee92b229-0dff-4632-b94e-eb9f581e1cff.
For exampleCode Block #abiquo.rubrik.infrastructure.datacenter.1=VCD Madrid Enterprise 1 #abiquo.rubrik.infrastructure.vcenter.1=ee92b229-0dff-4632-b94e-eb9f581e1cff
If you are using anything other than all three default
Gold
,Silver
, andBronze
SLA domains, set the sla property to define ALL your domain names. The value of the sla property is a comma separated list. This list will replace the default domains.Code Block abiquo.backup.rubrik.sla=Gold,Platinum,Palladium
You can add any of the other properties from the Rubrik configuration properties reference below as required. Don't forget to remove the hash
#
comment symbol from the start of each property.
...
Configure Abiquo Properties
To activate the Rubrik plugin and define the location of the configuration file:
Log in to the Abiquo Remote Services server
Edit the abiquo.properties file.
Set the path to the plugin properties file using the following property.
Code Block abiquo.backup.rubrik.config.path=/opt/abiquo/config/rubrik.properties
Optionally, configure other rubrik properties for nars and virtualfactory as required:
Abiquo configuration properties for
nars
Abiquo configuration properties for
virtual factory
Optionally, log in to the Abiquo API Server, and configure how often to run the backup policy synchronization check
Code Block # Delay between executions of the backup policy check (milliseconds). # The default represents 24 hours. #abiquo.backup.policy.sync.delay=86400000
...
Configure all backup jobs with policy codes
In Abiquo, create a Backup policy for each type of backup.
For the policy Code, enter the Rubrik SLA domain to use.
When a user assigns a backup policy to a VM, if Abiquo cannot find the Rubrik SLA Domain to match a backup policy code, then it will not be able to create a new backup job in Rubrik and the VM backups will not run.
...
Rubrik configuration properties reference
This section contains the configuration properties for the Rubrik integration. The Configure Rubrik Properties section describes the required and recommended properties.
Code Block | ||
---|---|---|
| ||
# Log level for feign client #abiquo.rubrikclient.feign.logger.level=INFO ??? # TimeoutsTimeout for client to connect, andto readthe from Rubrik API. To disable the timeout, set the value to 0 #abiquo.rubrikclient.timeout.connectionInSeconds=300 # Timeout for client to read from Rubrik #abiquo.rubrikclient.timeout.readInSeconds=300 ???API. To disable the timeout, set the value to 0 #abiquo.rubrikclient.followRedirects=false timeout.readInSeconds=300 # TimeMaximum ???time to performwait afor task ???to finish in Rubrik API #abiquo.rubrik.task.max.minutes=30 # Interval between checks if task is finished in Rubrik API #abiquo.rubrik.task.period.minutes=1 # TimeoutsTimeout for client to connect, andto read from vCloud API. To disable athe timeout, set the value to 0 #abiquo.rubrik.vcloudclient.timeout.connectionInSeconds=300 # Timeout for client to read from the vCloud API. To disable the timeout, set the value to 0 #abiquo.rubrik.vcloudclient.timeout.readInSeconds=300 # For vCloud, character to split user into backup system and vCloud user #abiquo.rubrik.credentials.splitter.user=# # For vCloud, character to split password into backup system and vCloud password #abiquo.rubrik.credentials.splitter.pass=# # Number of backup results #abiquo.rubrik.clients.pagesize=50 # ??? isn't this in the backup manager #abiquo.rubrik.vcloud.endpoint= # In addition to the default Gold, Silver, and Bronze SLA Domains # List of custom SLA Domains that you already configured in Rubrik #abiquo.backup.rubrik.sla= # ???For ID of the vCenter that Rubrik is attached to #abiquo.rubrik.vcenter.id= |
Configure Abiquo Properties
To activate the Rubrik plugin and define the location of the configuration file:
Log in to the Abiquo Remote Services server
- Edit the abiquo.properties file.
- Set the path to the plugin properties file using the following property.
Code Block |
---|
abiquo.backup.rubrik.config.path=/opt/abiquo/config/rubrik.properties |
Configure all backup jobs with policy codes
For Rubrik, you MUST enter an Abiquo policy Code for each backup.
Abiquo ALWAYS uses the backup policy Code attribute to identify the Rubrik SLA domain to use.
The default Abiquo configuration includes the default Rubrik SLA Domains: Gold, Silver, and Bronze
If you are using custom SLA domains, your system administrator must use the abiquo.backup.rubrik.sla property to add their names as a comma separated list.
For example:
Code Block |
---|
#abiquo.backup.rubrik.sla=Platinum,Palladium |
When a user assigns a backup policy to a VM, if Abiquo cannot find the Rubrik SLA Domain to match a backup policy code, then it will not be able to create a new backup job in Rubrik and the VM backups will not run.
Table of plugin properties
For vCenter, you do not need to set any properties for Rubrik because all of these properties have default values.
If you change the Rubrik properties, to reload the properties in Abiquo, you must restart the Tomcat server.
...
abiquo.rubrikclient.feign.logger.level
...
String
...
FULL
...
abiquo.rubrikclient.timeout.connectionInSeconds
...
Long
...
300
...
abiquo.rubrikclient.timeout.readInSeconds
...
Long
...
300
...
abiquo.rubrikclient.followRedirects
...
Boolean
...
false
...
abiquo.rubrik.task.max.minutes
...
Long
...
30
...
abiquo.rubrik.task.period.minutes
...
Long
...
1
...
abiquo.rubrik.vcloudclient.timeout.connectionInSeconds
...
Int
...
300
...
abiquo.rubrik.vcloudclient.timeout.readInSeconds
...
Int
...
300
...
abiquo.rubrik.credentials.splitter.user
...
String
...
abiquo.rubrik.credentials.splitter.pass
...
String
...
abiquo.rubrik.clients.pagesize
...
String
...
50
...
abiquo.rubrik.vcloud.endpoint
...
String
...
...
abiquo.backup.rubrik.sla
...
String
...
...
abiquo.rubrik.vcenter.id
...
String
...
Abiquo 5.4.4+, with vCloud, configure each datacenter and its corresponding vCenter.
# Use the same index (integer) for a datacenter and its vCenter.
# The datacenter is the Name of an Abiquo public cloud region of the vCloud.
# To obtain the vCenter ID, obtain the Rubrik ID of a VM running on the vCenter from Rubrik.
# The format of the Rubrik ID is: VirtualMachine:::vCenterId-mobIdVM
# For example: VirtualMachine:::ee92b229-0dff-4632-b94e-eb9f581e1cff-vm-18662
# In this case, the vCenter ID is ee92b229-0dff-4632-b94e-eb9f581e1cff
#abiquo.rubrik.infrastructure.datacenter.<index>=
#abiquo.rubrik.infrastructure.vcenter.<index>= |