Configure Rubrik backup plugin

Introduction

Abiquo supports version 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 abiquo.properties.
Specify, in milliseconds, how often to run the backup policy syncronization. The default value represents 24 hours.

Requirements

When you use Rubrik with vCloud Director
- You 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 Code 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.
1. 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:
```
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 is ee92b229-0dff-4632-b94e-eb9f581e1cff. For example
```
#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, and Bronze 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.
```
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.
```
abiquo.backup.rubrik.config.path=/opt/abiquo/config/rubrik.properties
```
Optionally, configure other rubrik properties for nars and virtualfactory as required:
1. Abiquo configuration properties#nars
2. Abiquo configuration properties#virtualfactory

Optionally, Log in to the Abiquo API Server, and configure how often to run the backup policy synchronization check

# 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.

# Log level for feign client
#abiquo.rubrikclient.feign.logger.level=INFO

# Timeout for client to connect to the Rubrik API. To disable the timeout, set the value to 0 
#abiquo.rubrikclient.timeout.connectionInSeconds=300

# Timeout for client to read from Rubrik API. To disable the timeout, set the value to 0 
#abiquo.rubrikclient.timeout.readInSeconds=300 

# Maximum time to wait for 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 

# Timeout for client to connect to vCloud API. To disable the 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 

# 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 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>=