Configuring Backups for File Server in Oracle Cloud Infrastructure

You can configure backups for file servers on OCI. The configuration wizard guides you through the configuration process, which includes creating any new entities that are needed, such as a backup plan and a cloud storage.

Before You Begin

For Oracle Database Cloud Service and Oracle Exadata Cloud Service systems in OCI, use the Oracle Console to clear the Enable Automatic Backup setting for the file servers you want to protect. If you enable automatic backups, Commvault Cloud backup or restore operations may fail.

Start the Configuration Wizard

Log on to metallic.io.

The Service Catalog page appears.
On the Files tile, click Configure, and then click File server.

The Configure File Server Backup page appears.

If you have already completed the initial setup, follow these steps:

From the navigation pane, go to Protect > Files.

The file servers Overview page appears.
On the Files tab, in the upper-right area of the page, click Add Server.

The Configure File Server page appears.
Select File server and click Next.

The Configure File Server Backup page appears.

Specify the File Server Environment

Select File server running in the cloud VM, and then from the Select vendor list, select Oracle Cloud Infrastructure.

An active trial or an active subscription is required.
Click Next.

The File Server Backup Overview page appears.
Click Next.

The Configure Permissions page appears, where you must enable IAM Role authentication.

IAM Role

Configure Oracle IAM permissions for API key-based authentication using Resource Manager template that is provided by Commvault Cloud.

Click Launch Oracle Cloud Stack Template.

The Create Stack page of the OCI website appears. Create your MetallicServiceAccount user and then follow the directions in Step 2 on the page to obtain your Tenancy OCID, API key, and fingerprint for the user.
Select I have reviewed and accept the Oracle terms of use.

The Resource Manager template creates an IAM user in the IAM group. Then, it creates and assigns an IAM policy to the group.
Verify that the Use custom Terraform providers check box is not selected.
In the Name box, enter a descriptive name for the stack.
From the Create in compartment list, select a compartment.
In the Tags section, add a tag to identify the IAM stack.
Click Next.

The Configure Variables page appears.
In the Email address for User (MetallicServiceAccount) box, enter an email address.
Click Next.

The Review page appears.
Click Create.
In the search bar at the top of the page, search for your user MetallicServiceAccount.

Your MetallicServiceAccount page appears.
Under API Keys, select Add API Key > Download Private Key.
Under the API key section, click the button with three dots.
Copy the Credential Name, Tenancy OCID, User OCID, and Fingerprint values.
Return to the Commvault Cloud configuration wizard.
For Credentials, select existing credentials or create new credentials.
Steps to create credentials
1. Click the add button .
  
  The Add credential dialog box appears.
2. In Credential name, enter a descriptive name for the credentials.
3. In Tenancy OCID, enter the OCID for the tenant.
4. In User OCID, enter OCID for the user for the hypervisor.
5. In Fingerprint, enter the fingerprint.
6. For Private key, upload the private key file.
7. In Private key password, enter the password for the private key.
8. In Description, enter a description of the credentials.
Click Next.

The region selection page appears.

Region

From the region list, select the region where the file server is located.
Click Next.

The backup gateway selection page appears.

Backup Gateway

Backup gateways connect with, discover, back up, and restore your data source (which the Commvault Cloud control panel cannot access directly). Backup gateways also move data to and from the access nodes to the storage targets. Backup gateways also perform deduplication operations before moving data to storage targets. A backup gateway is required to back up file servers without egress charges.

If you create a new backup gateway for OCI, verify that it meets the system requirements for OCI backup gateways.

Select an existing backup gateway or create a new backup gateway.
Steps to add a new backup gateway
1. Click +.
  
  The Backup gateway window appears.
2. From the Platform list, select the platform on which you want to place the backup gateway.
3. The Storage region displayed is auto-populated from the selection you made on the region selection page. If you want to change the region, you must make the change on the region selection page.
4. Click GENERATE LINK to create the link for the CloudFormation template.
5. A CloudFormation template is created based on the region and the operating system that you selected.
6. To create an instance and install the Commvault Cloud backup gateway, click the Cloud Formation link to open the console.
7. Sign in to the console.
8. Enter the parameters and click Save to register the gateway with Commvault Cloud.
9. Click OK.
Click Next.

The Cloud Storage page appears.

Cloud Storage

Primary Copy

To review the supported combinations of primary and secondary storage, see Storage Options for In-Guest Agent Based Backups.
For the primary copy of the backup data, select existing cloud storage from the Storage location list or create new cloud storage.
Steps to create cloud storage for the primary copy
1. Click +.
  
  The Add cloud storage dialog box appears.
2. From the Type list, select Air Gap Protect or Oracle Cloud Infrastructure Object Storage.
3. If you select Air Gap Protect, the Cloud storage provider, Storage Class, and Region fields are automatically populated.
4. If you select Oracle Cloud Infrastructure Object Storage, the Region field is automatically populated.
5. Enter Compartment Name and Bucket.
6. Click Save.
Click Next.

Secondary Copy

Decide whether to store a secondary copy of the backup data for long-term retention.
1. To enable backup of a secondary copy, slide the Secondary copy toggle key to the right.
2. Select existing cloud storage from the Storage location list or create new cloud storage.
Steps to create cloud storage for the secondary copy
1. Click +.
  
  The Add cloud storage dialog box appears.
2. From the Type list, select Air Gap Protect or Oracle Cloud Infrastructure Object Storage.
3. If you select Air Gap Protect, the Cloud storage provider, Storage Class, and Region fields are automatically populated.
4. If you select Oracle Cloud Infrastructure Object Storage, the Region field is automatically populated.
5. Enter Compartment Name and Bucket.
6. Click Save.
Click Next.

The Plan page appears.

Backup Plan

A backup plan specifies the storage to back up the data to and other settings such as recovery point objective (RPO) settings.

Select an existing backup plan or create a new one.
Steps to create a backup plan
1. Click the add button .
  
  The Add plan dialog box appears.
2. In the Plan name box, enter a descriptive name for the backup plan.
3. For the backup plan settings, select pre-defined settings or create custom settings:
  - To select pre-defined settings, under Retention rules, select one of the following:
    - Select Standard retention to retain the incremental backups for 1 month.
    - Select Extended retention for optimized storage where the incremental backups of primary and secondary copies are retained for 1 month, and extended retention for monthly and yearly full backups.
      
      Note
      
      The Extended retention option is available only when the secondary copy backup is selected.
  - To create custom settings, select Custom plan, and then specify the following:
    - For Retention, specify the amount of time to retain the backup jobs.
    - For Retention monthly full (Secondary copy), specify the amount of time to retain the monthly full backup on secondary copy.
    - For Retention yearly full (Secondary copy), specify the amount of time to retain the yearly full backup on secondary copy.
    - For Backups run every, specify how often to run backups.
4. Click Done.
Click Next.

The Install Packages page appears. You must select the installation method for the package.

Install Packages

Interactive Installation

To perform an interactive installation, select Interactive installation.
Download the backup client package and install it on the server you want to back up.

To install the Windows and UNIX packages, you can use the respective silent install commands.

Note

If the package is in a .tar file (for example, LinuxFileServer64.tar), the tar file must be extracted using the GNU TAR utility.
Enter your Commvault Cloud credentials in the installer to authenticate the package on the server.
For OS Type, specify the OS of the file server that you want to back up.
From the Files list, select the file server that you installed.

Tip

Click the refresh button if the list does not display the required file server.

Push Installation

To perform a push installation, select Push Installation.
Select a file server from the list of servers or create a new one.
Steps to create a file server
1. In the Name box, enter the name of the file server on which the push installation needs to be performed.
2. In the Username box, enter the username.
3. In the Password box, enter the password, and then re-enter the password to confirm it.
4. Select the OS Type of the file server.
5. If you select Unix as the OS, to use a non-standard SSH port number, move the Use a non-standard SSH port number toggle key to the right.
6. Optional: To specify the path to install the software, in Installation location, enter the path.
7. To restart the file server after the installation, move the Reboot if required toggle key to the right.
8. Click Save.
Click Next.

The Backup Content page appears.

Backup Content

You can add content by browsing, by selecting all the content, and by entering a custom path.

If the selected backup plan has backup content defined, then the same content is automatically selected. If not, all content is selected for backup, by default.
To browse for specific content, do the following:
1. Click Add, and then select Browse.
  
  The Add content dialog box appears.
2. Select the content.
3. Click Save.
To enter a custom path, do the following:
1. Click Add, and then select Custom Path.
2. In Enter custom path, enter the custom path for the content.
  
  For example, you can enter C:\Temp\abc (for Windows) or /dir1/abc (for Linux).
To exclude some of the content you selected, click Add and then, browse or enter custom paths for the content to be excluded.
Click Next.

The Summary page appears.

Summary

Review the summary.
Click Finish.