Skip to main content

How can we help you?

Druva Documentation

Deploy and register a Phoenix Backup Store

Phoenix Editions: File:/tick.png Business File:/cross.png Enterprise File:/tick.png Elite

Druva Phoenix backs up the Oracle RMAN backups created by Oracle Recovery Manager (RMAN). When the Oracle Database Administrator triggers a backup using RMAN, RMAN creates an Oracle RMAN backup and stores it on a specified target location. Deploy the Phoenix Backup Store and create a backup mount on the Phoenix Backup Store that serves as the RMAN target location.

You can create a Phoenix Backup Store on an Ubuntu server, AWS EC2 instance, or a virtual machine. Druva provides the following deployment packages:

  • A Debian package that is installed on an Ubuntu server that can work as a Phoenix Backup Store, or can be deployed on an Amazon EC2 instance with Ubuntu as its operating system and can work as the Phoenix Backup Store
  • An Open Virtual Appliance package that is deployed on a VMware setup to create a virtual machine and use the virtual machine as the Phoenix Backup Store

Oracle_Deployment1.png

After you deploy the package:

  • The Ubuntu server, AWS EC2 instance, or the virtual machine becomes the Phoenix Backup Store that works as an NFS server.
  • A mount created on the Phoenix Backup Store is configured as a location to store Oracle RMAN backups.

Before you begin

Before you deploy the package and create the Phoenix Backup Store:

  • Ensure that the Ubuntu server, AWS EC2 instance, or the virtual machine meets the hardware and software requirements specified in the system requirements article.
  • To deploy a Debian package on an Amazon EC2 instance, read the recommended configuration for the AWS EC2 instance.
  • Ensure that the Phoenix Backup Store  uses Ubuntu 18.04. 
  • Set up the Phoenix Backup Store in your IT infrastructure so that the RMAN can access the mount on it and store the backups it creates.
  • Ensure that Internet access is enabled for the Phoenix Backup Store.
  • Read the quick steps article.

Step 1: Download the Phoenix Backup Store package and generate activation token

The Phoenix Backup Store package is available on the Druva downloads page. In addition, you can download the package when you generate the activation token. If you want to:

  • Set up the Phoenix Backup Store on an Ubuntu server, download the Debian package. 
  • Set up the Phoenix Backup Store as a virtual machine, download the Open Virtual Appliance (OVA) package.

To generate the activation token: 

  1. Log in to the Phoenix Management Console.
  2. From the top menu, select the Organization where you want to configure the Phoenix Backup Store.
    The Organization page appears. 
  3. On the Organization page, click Protect > Oracle on the top menu bar. 
    The Oracle page appears. 
  4. On the Oracle page, click Register Phoenix Backup Store.
    The Register Phoenix Backup Store wizard appears.
  5. In the Install Package section of the wizard, use the Click here link to launch the downloads page and download the package. If you have already downloaded the package, click Next.
  6. In the Generate Activation Token section of the wizard, provide:
    Field Description
    Token Description Specify a description to help you identify the token.
    This token can activate <the number of> stores Specify the number of Phoenix Backup Stores that can be activated using this token.
    The token expires in Specify the number of days after which the token cannot be used for activating a Phoenix Backup Store.
  7. Click Next
  8. In the Store Activation section, Druva provides the activation token that you use to activate the Phoenix Backup Store. Copy the activation token, save it to a text file, and click Finish. You can also navigate to Manage > Tokens from the top menu bar to get the activation token again. 

After you generate an activation token, deploy the Debian or OVA package to set up Phoenix Backup Store.

Step 2: Deploy the Debian package or OVA and register the Phoenix Backup Store

  • To retain the DNS resolution, add a DNS server entry to the 50-cloud-init.yaml as shown in the following screenshot, and save the changes made.
    nameserver1.png
  • You can set the hostname by running the hostnamectl command:
    hostnamectl set-hostname <hostnameofthePBS>

Deploy the Debian package on an Amazon EC2 instance with Ubuntu as its operating system

The Debian package that you download is installed on the EC2 instance to use it as a Phoenix Backup Store. The mount created on the Phoenix Backup Store serves as the location to store Oracle RMAN backups. 

Prerequisites

  • Read the system requirements to use an EC2 instance as a Phoenix Backup Store and create an EC2 instance on the AWS Management Console with the recommended settings.
  • Select the General Purpose SSD (gp2) Volume type instead of the Throughput Optimized HDD (st1) for better performance.
  • Create the EC2 instance with only one disk for the operating system. 
  • Create and attach at least three volumes for the following resources
    • Two volumes for ZFS pools
    • One volume for the restore mount

    Note: Ensure that you create volumes in the same availability zone as that of the EC2 instance.

Procedure

  1. Connect to the EC2 instance terminal. 
  2. Run the following command to update the apt package.
    sudo apt-get update

    Phoenix Backup Store requires ZFS and NFS packages that are dependent on the latest Advanced Packaging Tool (apt). Ensure that you run the command to update the apt package.

  3. Install the ZFS package. The command to install the ZFS package is:
    sudo apt install zfsutils-linux=0.7.5-1*
  4. Install the NFS kernel package. The command to install the NFS kernel package is:
    sudo apt install nfs-kernel-server=1:1.3.4-2.1*
    Note: If you run into an error at this step, ensure that you have updated the apt package. Refer to step 2.
  5. Create partitions on one of the disks using the fdisk command and choose the default values of the sector to use the whole disk.

    For example:
    fdisk /dev/xvdf
     
  6. Create a file system  on the disk using the following command:
    mkfs.ext4 <partition path>

    For example:
    mkfs.ext4 /dev/xvdf1

    Note: Note the UUID of the partition created using either of the following commands:

    • blkid
    • ls -l /dev/disk/by-uuid/

    We recommend you to add the UUID entry to the fstab so that the partition gets automatically mounted on the machine’s next reboot.
    For example:
    UUID=<uuid_of_xvdf1> /mnt/restores ext4 defaults 0 0

  7. Run the following command to create the default directory for restore:
    mkdir /mnt/restores 

    Note: Do not perform Steps 7 and 8 for Phoenix Backup Store deployments that use AMI or OVA because the /mnt/restores file system is already built into these deployments.

    Proceed with Steps 7 and 8 only for deploying Phoenix Backup Store using the Debian package.

  8. Run the following command to mount the restore disk at the /mnt/restores path:
    mount -a
  9. On the terminal, run the dpkg command with the path to the Debian package to install it.
    sudo dpkg -i <path-to-the-Phoenix-Backup-Store-debian-package>

    For example:
    sudo dpkg -i /home/test-usr/Downloads/druva-phoenix-backupstore-4.7.6-110.amd64.deb

    Ensure that you provide the correct path to the location of the Debian package and its name.
    These steps install the ZFS package,  the NFS kernel, and the Druva binaries that Druva Phoenix needs to create the Phoenix Backup Store. 

  10. After the package is installed, perform the following steps to create a ZFS pool using the disks on the Ubuntu server:
    1. To create a ZFS pool, run the following command:
      zpool_config_no_raid.sh <disk-name-of-EBS-volume1> <disk-name-of-EBS-volume2> ... 

      For this example, the command to use the EBS volumes xvdh and xvdg is:
      zpool_config_no_raid.sh xvdh xvdg
       
    2. You can run the lsblk command to get the EBS volume names. The following example shows the output of the lsblk command on EC2 instance: 
      root@ec2-instance:/opt/Druva/Phoenix/PhoenixBackupStore/bin# lsblk​​​​​

      The output of the command looks like:
      ubuntu@ip-172-31-80-145:~$ lsblk
      NAME    MAJ:MIN RM  SIZE RO TYPE MOUNTPOINT
      loop0     7:0    0 55.5M  1 loop /snap/core18/1997
      loop1     7:1    0 33.3M  1 loop /snap/amazon-ssm-agent/3552
      loop2     7:2    0 55.5M  1 loop /snap/core18/1988
      loop3     7:3    0 31.1M  1 loop /snap/snapd/11036
      loop4     7:4    0 32.3M  1 loop /snap/snapd/11588
      xvda    202:0    0   15G  0 disk
      └─xvda1 202:1    0   15G  0 part /
      xvdf    202:80   0   10G  0 disk
      └─xvdf1 202:81   0   10G  0 part /mnt/restores
      xvdg    202:96   0   10G  0 disk
      ├─xvdg1 202:97   0   10G  0 part
      └─xvdg9 202:105  0    8M  0 part
      xvdh    202:112  0   10G  0 disk
      ├─xvdh1 202:113  0   10G  0 part
      └─xvdh9 202:121  0    8M  0 part

      In the output, the block devices that have the type listed as disk correspond to the EBS volumes of the EC2 instance. This is an example output and the device names can change based on the configuration and settings of your EC2 instance. Ensure that you use the correct device names based on your EC2 instance. For example, if you are using a Nitro-based instance, the EBS volumes can get names such as nvme0n1 and nvme1n1. In such a case, use the names of the EBS volumes as listed in the output of the lsblk command that you run on your EC2 instance.

      Disk name of an EBS volume may change if it is detached from the EC2 instance and then re-attached. 

      The above disk names are examples. Ensure that you provide the correct disk names when you create a ZFS pool.  To create a ZFS pool with RAIDZ configuration:

      • Use zpool_config_raidz1.sh in place of zpool_config_no_raid.sh

      • RAIDZ configuration requires at least three disks.

      • The scripts are stored under the /opt/Druva/Phoenix/PhoenixBackupStore/bin folder on the Phoenix Backup Store.

  11. Run the following command to restart the Phoenix Backup Store service:

    sudo service PhoenixBackupStore restart

  12.  After installing the package and configuring the ZFS pool, run the activation command with the token you generated above to activate the Phoenix Backup Store:

    Note: Ensure that ZFS pool is created before you activate the Phoenix Backup Store.

The Phoenix Backup Store is deployed and registered with Druva. You must now configure the Phoenix Backup Store and RMAN hosts to backup databases.

Deploy the Debian package on an Ubuntu server and register the Phoenix Backup Store

The Debian package that you download is deployed on an Ubuntu server to create the Phoenix Backup Store. The mount created on the Phoenix Backup Store serves as the location to store Oracle RMAN backups. 

Prerequisite

Ensure that the package is accessible on the Ubuntu server. 

Procedure

  1. Connect to the Ubuntu server using PuTTy or launch the terminal on the Ubuntu server. 
  2. Run the following command to update the apt package.
    sudo apt-get update
    Phoenix Backup Store requires ZFS and NFS packages that are dependent on the latest Advanced Packaging Tool (apt). Ensure that you run the command to update the apt package.
  3. Install the ZFS package on the Ubuntu server. The command to install the ZFS package is:

    sudo apt install zfsutils-linux=0.7.5-1*

  4. Install the NFS kernel package. The command to install the NFS kernel package is:
    sudo apt install nfs-kernel-server=1:1.3.4-2.1*
    Note: If you run into an error at this step, ensure that you have updated the apt package. Refer to step 2.
  5. Create partitions on one of the disks using the fdisk command and choose the default values of the sector to use the whole disk.
    For example:
    fdisk /dev/xvdf
  6. Create a file system  on the disk using the following command:
    mkfs.ext4 <partition path>

    For example:
    mkfs.ext4 /dev/xvdf1

    Note: Note the UUID of the partition created using either of the following commands:

    • blkid
    • ls -l /dev/disk/by-uuid/

    We recommend you to add the UUID entry to the fstab so that the partition gets automatically mounted on the machine’s next reboot.
    For example:
    UUID=<uuid_of_xvdf1> /mnt/restores ext4 defaults 0 0

  7. Run the following command to create the default directory for restore:
    mkdir /mnt/restores 

  8. Run the following command to mount the restore disk at the /mnt/restores path:
    mount -a
  9. On the terminal, run the dpkg command with the path to the Debian package to install it.sudo dpkg -i <path-to-the-Phoenix-Backup-Store-debian-package>
    For example:
    sudo dpkg -i /home/test-usr/Downloads/druva-phoenix-backupstore-4.7.6-110.amd64.deb
    Ensure that you provide the correct path to the location of the Debian package and its name.

    These steps install the ZFS package,  the NFS kernel, and the Druva binaries that Druva Phoenix needs to create the Phoenix Backup Store. 

  10. [Optional] If the Ubuntu server on which you are deploying a Phoenix Backup Store Debian package is a VMware virtual machine, perform the following steps to set disk.EnableUUID = True on the virtual machine:

    1. On the vSphere client that is connected to the vCenter/ESXi host, select the virtual machine that you are configuring as a Phoenix Backup Store and then turn it off.

    2. Select the virtual machine on the vSphere client, and then click Edit Settings

    3. In the Virtual Machine Properties dialog, select the Options tab.

    4. In the Options tab, select General under Advanced on the left pane.  

    5. On the right pane, click Configuration Parameters... in the Configuration Parameters section. The Configuration Parameters dialog appears.

    6. In the Configuration Parameters dialog that appears, update the value of the parameter with the name disk.EnableUUID to true and then click OK
      If disk.EnableUUID parameter is not listed under the Name column, click the Add Row button to add it and then set its value to true.

    7. Turn the virtual machine on.

  11. After the package is installed, perform the following steps to create a ZFS pool using the disks on the Ubuntu server:
    1. To get the disk IDs, run the following command on the command line terminal:
      ls -l /dev/disk/by-id/ 
      The output of the command looks like:

      drwxr-xr-x 2 root root 460 Jan  2 07:21 ./
      drwxr-xr-x 7 root root 140 Jan  2 07:21 ../
      lrwxrwxrwx 1 root root   9 Jan  2 07:17 ata-VMware_Virtual_SATA_CDRW_Drive_00000000000000000001 -> ../../sr0
      lrwxrwxrwx 1 root root   9 Jan  2 07:21 scsi-36000c291a9ac60a4f33cfce60c7b3860 -> ../../sdc
      lrwxrwxrwx 1 root root   9 Jan  2 07:21 scsi-36000c29484ebb93eaece5ac0dc845d08 -> ../../sdb
      lrwxrwxrwx 1 root root   9 Jan  2 07:17 scsi-36000c29b9dce7313dfdb13871518563a -> ../../sdd
      lrwxrwxrwx 1 root root   9 Jan  2 07:17 scsi-36000c29f3116f1d4f65e63c182d3ecf0 -> ../../sda
      lrwxrwxrwx 1 root root  10 Jan  2 07:17 scsi-36000c29f3116f1d4f65e63c182d3ecf0-part1 -> ../../sda1
      lrwxrwxrwx 1 root root  10 Jan  2 07:17 scsi-36000c29f3116f1d4f65e63c182d3ecf0-part2 -> ../../sda2
      lrwxrwxrwx 1 root root   9 Jan  2 07:21 wwn-0x6000c291a9ac60a4f33cfce60c7b3860 -> ../../sdc
      lrwxrwxrwx 1 root root   9 Jan  2 07:21 wwn-0x6000c29484ebb93eaece5ac0dc845d08 -> ../../sdb
      lrwxrwxrwx 1 root root   9 Jan  2 07:17 wwn-0x6000c29b9dce7313dfdb13871518563a -> ../../sdd
      lrwxrwxrwx 1 root root   9 Jan  2 07:17 wwn-0x6000c29f3116f1d4f65e63c182d3ecf0 -> ../../sda
      lrwxrwxrwx 1 root root  10 Jan  2 07:17 wwn-0x6000c29f3116f1d4f65e63c182d3ecf0-part1 -> ../../sda1
      lrwxrwxrwx 1 root root  10 Jan  2 07:17 wwn-0x6000c29f3116f1d4f65e63c182d3ecf0-part2 -> ../../sda2

    2. To create a ZFS pool, run the following command:
      ./zpool_config_no_raid.sh <disk-id-of-disk1> <disk-id-of-disk2> ... 
      For this example, the command to use the disks sdb and sdc is:
      ./zpool_config_no_raid.sh scsi-36000c29484ebb93eaece5ac0dc845d08 scsi-36000c291a9ac60a4f33cfce60c7b3860
    3. The above disk IDs are examples. Ensure that you provide the correct disk IDs when you create a ZFS pool.  To create a ZFS pool with RAIDZ configuration:

  • Use zpool_config_raidz1.sh in place of zpool_config_no_raid.sh
  • RAIDZ configuration requires at least three disks.
  • The scripts are stored under the /opt/Druva/Phoenix/PhoenixBackupStore/bin folder on the Phoenix Backup Store.
  1. Run the following command to restart the Phoenix Backup Store service:
    sudo service PhoenixBackupStore restart

  2. After installing the package and configuring the ZFS pool, run the activation command with the token you generated above to activate the Phoenix Backup Store:

    PhoenixBackupStoreControl activate <govcloud> <activation_token>

    Example activation command for Public cloud:

    PhoenixBackupStoreControl activate ExampleToken1234

    Example activation command for Gov cloud:

    PhoenixBackupStoreControl activate govcloud ExampleToken1234
    Ensure that you replace example values with real values. In the above syntax,  replace ExampleToken1234 with the token that you generate. 

    Note: Ensure that ZFS pool is created before you activate the Phoenix Backup Store.

The Phoenix Backup Store is deployed and registered with Druva. You must now configure the Phoenix Backup Store and RMAN hosts to backup databases. 

Deploy the OVA package on a VMware setup and register the Phoenix Backup Store virtual machine

In addition to the Debian package, Druva provides an open virtual appliance (OVA) package that you can use to create a Phoenix Backup Store on a VMware setup. The OVA package that you download is deployed on a VMware setup to create the Phoenix Backup Store virtual machine. The mount created on the Phoenix Backup Store serves as the location to store Oracle RMAN backups. 

Before you begin

Ensure that the OVA package is downloaded.

Procedure

To deploy the Phoenix Backup Store OVA on a VMware setup, see Deploy an OVF or OVA template [External link to VMware documentation].

Note: When the vSphere client prompts you to review the deployment details in the fourth step of the deployment process, ensure that you click Next. The vSphere client shows this warning due to the advanced configuration options that Druva adds in the OVA package to ensure that the virtual disks get a static disk-ID which is required for creating a ZFS pool.
ova_deploy_warning2.png

The OVA package can be deployed for vCenter/ESXi version 6.0 or later. When you deploy the OVA, assign the right amount of storage for backup and restore based on the sizing calculated, and assign a static IP address to the  Phoenix Backup Store.

After you deploy the Phoenix Backup Store OVA, start the virtual machine and connect to the virtual machine using PuTTy or any other remote utility. To log in to the Phoenix Backup Store enter the default credentials:

  • root as the username
  • PBS@123 as the password

After logging in, perform the following steps on the terminal:

  1. Create a ZFS pool using the virtual disks. The following procedure describes how to create a ZFS pool.
    1. To get the disk IDs, run the following command on the command line terminal:

      ls -l /dev/disk/by-id/

      The output of the command looks like:

      drwxr-xr-x 2 root root 460 Jan  2 07:21 ./
      drwxr-xr-x 7 root root 140 Jan  2 07:21 ../
      lrwxrwxrwx 1 root root   9 Jan  2 07:17 ata-VMware_Virtual_SATA_CDRW_Drive_00000000000000000001 -> ../../sr0
      lrwxrwxrwx 1 root root   9 Jan  2 07:21 scsi-36000c291a9ac60a4f33cfce60c7b3860 -> ../../sdc
      lrwxrwxrwx 1 root root   9 Jan  2 07:21 scsi-36000c29484ebb93eaece5ac0dc845d08 -> ../../sdb
      lrwxrwxrwx 1 root root   9 Jan  2 07:17 scsi-36000c29b9dce7313dfdb13871518563a -> ../../sdd
      lrwxrwxrwx 1 root root   9 Jan  2 07:17 scsi-36000c29f3116f1d4f65e63c182d3ecf0 -> ../../sda
      lrwxrwxrwx 1 root root  10 Jan  2 07:17 scsi-36000c29f3116f1d4f65e63c182d3ecf0-part1 -> ../../sda1
      lrwxrwxrwx 1 root root  10 Jan  2 07:17 scsi-36000c29f3116f1d4f65e63c182d3ecf0-part2 -> ../../sda2
      lrwxrwxrwx 1 root root   9 Jan  2 07:21 wwn-0x6000c291a9ac60a4f33cfce60c7b3860 -> ../../sdc
      lrwxrwxrwx 1 root root   9 Jan  2 07:21 wwn-0x6000c29484ebb93eaece5ac0dc845d08 -> ../../sdb
      lrwxrwxrwx 1 root root   9 Jan  2 07:17 wwn-0x6000c29b9dce7313dfdb13871518563a -> ../../sdd
      lrwxrwxrwx 1 root root   9 Jan  2 07:17 wwn-0x6000c29f3116f1d4f65e63c182d3ecf0 -> ../../sda
      lrwxrwxrwx 1 root root  10 Jan  2 07:17 wwn-0x6000c29f3116f1d4f65e63c182d3ecf0-part1 -> ../../sda1
      lrwxrwxrwx 1 root root  10 Jan  2 07:17 wwn-0x6000c29f3116f1d4f65e63c182d3ecf0-part2 -> ../../sda2

    2. To create a ZFS pool, run the following command:

      ./zpool_config_no_raid.sh <disk-id-of-disk1> <disk-id-of-disk2> ...

      For this example, the command to use the disks sdb and sdc is:

      ./zpool_config_no_raid.sh scsi-36000c29484ebb93eaece5ac0dc845d08 scsi-36000c291a9ac60a4f33cfce60c7b3860
      The above disk IDs are examples. Ensure that you provide the correct disk IDs when you create a ZFS pool. The OVA that Druva provides comes with three disks. However, the first two disks with the storage capacity of 100 GB each are for backup and the third disk with the storage capacity of 200 GB is for restore. Ensure that you do not use the third disk with 200 GB storage capacity for creating the ZFS pool. 

    3. To create a ZFS pool with RAIDZ configuration:

      • Use zpool_config_raidz1.sh in place of zpool_config_no_raid.sh

      • RAIDZ configuration requires at-least three disks. Since the OVA ships with two disks for backup and one disk for restore, add a fourth virtual disk with the storage capacity of 100 GB and use the fourth disk along with the first and second disk. The Phoenix Backup Store uses the third disk with the storage capacity of 200 GB for restore. Ensure that you do not use the third disk with 200 GB storage capacity for creating the ZFS pool.
        To add a new disk, perform the following steps on the vSphere client:

        1. Right-click the PBS virtual machine and click Edit Settings.

        2. Add a new virtual disk with storage capacity 100 GB or more as per your storage requirement.

        3. Click OK.

        4. Right-click the Phoenix Backup Store virtual machine and click Power > Power On to start the Phoenix Backup Store.  

      • The scripts are stored under the /opt/Druva/Phoenix/PhoenixBackupStore/bin folder on the Phoenix Backup Store. Perform the following steps: 

        1. Run the following commands:

          1. cd /opt/Druva/Phoenix/PhoenixBackupStore/bin 

          2. ./zpool_config_raidz1.sh <disk-id-of-disk1> <disk-id-of-disk2> <disk-id-of-disk3> 

        2. Wait for the pool to be created.

  2. Run the following command to restart the Phoenix Backup Store service. 

    sudo service PhoenixBackupStore restart 

  3. Run the activation command with the token you generated above to activate the Phoenix Backup Store:

    PhoenixBackupStoreControl activate <govcloud> <activation_token>

    Example activation command for Public cloud:

    PhoenixBackupStoreControl activate ExampleToken1234

    Example activation command for Gov cloud:

    PhoenixBackupStoreControl activate govcloud ExampleToken1234
    Ensure that you replace example values with real values. In the above syntax,  replace ExampleToken1234 with the token that you generate. 

    Note: Ensure that ZFS pool is created before you activate the Phoenix Backup Store.

The Phoenix Backup Store is deployed and registered with Druva. You must now configure the Phoenix Backup Store and RMAN hosts to backup databases. 

Configure the Phoenix Backup Store to use a web-proxy

Phoenix Backup Store connects to the Druva Cloud through the internet. If your network infrastructure uses a web-proxy, configure the Phoenix Backup Store to use the web-proxy to establish a connection with the Druva Cloud. 

Before you begin

Before you begin, ensure that the Phoenix Backup Store service is running.

Procedure

  1. Open the command line prompt on the Phoenix Backup Store.
  2. Run the following command:
    PhoenixBackupStoreControl set_proxy_details -t proxy_type -i proxy_IP:port -u proxy_user -p proxy_password  
    
    Attribute Details
    Proxy_type Druva supports the following proxy types:
    • http
    • socks4
    • socks5
    Proxy_IP Valid IP of proxy server.
    Port Respective proxy port number.
    Proxy_user Valid proxy user name. Enter * for an unauthenticated proxy. 
    Proxy_password Valid proxy password. Enter * for an unauthenticated proxy. 

The Phoenix Backup Store is now configured to use the web-proxy. In addition:

  • Use escape sequence if the value of an attribute contains special characters.
  • Ensure that all the parameters are present.
  • The command fails if any input parameter is missing or not entered in the prescribed order.