Veritas NetBackup™ CloudPoint Install and Upgrade Guide

Last Published:
Product(s): NetBackup & Alta Data Protection (9.1.0.1)
  1. Section I. CloudPoint installation and configuration
    1. Preparing for CloudPoint installation
      1.  
        About the deployment approach
      2.  
        Deciding where to run CloudPoint
      3.  
        About deploying CloudPoint in the cloud
      4.  
        Meeting system requirements
      5. CloudPoint host sizing recommendations
        1.  
          CloudPoint sizing recommendations for cloud platforms
      6.  
        CloudPoint extension sizing recommendations
      7.  
        Creating an instance or preparing the host to install CloudPoint
      8.  
        Installing container platform (Docker, Podman)
      9.  
        Creating and mounting a volume to store CloudPoint data
      10.  
        Verifying that specific ports are open on the instance or physical host
      11.  
        Preparing CloudPoint for backup from snapshot jobs
    2. Deploying CloudPoint using container images
      1.  
        Before you begin installing CloudPoint
      2.  
        Installing CloudPoint in the Docker environment
      3.  
        Installing CloudPoint in the Podman environment
      4.  
        Verifying that CloudPoint is installed successfully
      5.  
        Restarting CloudPoint
    3. Deploying CloudPoint extensions
      1.  
        Before you begin installing CloudPoint extensions
      2.  
        Preparing to install the extension on a VM
      3.  
        Installing the CloudPoint extension on a VM
      4.  
        Preparing to install the extension on a managed Kubernetes cluster
      5.  
        Downloading the CloudPoint extension
      6.  
        Installing the CloudPoint extension on a managed Kubernetes cluster
      7.  
        Managing the extensions
    4. CloudPoint cloud plug-ins
      1.  
        How to configure the CloudPoint cloud plug-ins?
      2. AWS plug-in configuration notes
        1.  
          Prerequisites for configuring the AWS plug-in
        2.  
          Configuring AWS permissions for CloudPoint
        3.  
          AWS permissions required by CloudPoint
        4.  
          Before you create a cross account configuration
      3. Google Cloud Platform plug-in configuration notes
        1.  
          Google Cloud Platform permissions required by CloudPoint
        2.  
          Configuring a GCP service account for CloudPoint
        3.  
          Preparing the GCP service account for plug-in configuration
      4. Microsoft Azure plug-in configuration notes
        1.  
          Configuring permissions on Microsoft Azure
        2.  
          About Azure snapshots
      5. Microsoft Azure Stack Hub plug-in configuration notes
        1.  
          Configuring permissions on Microsoft Azure Stack Hub
        2.  
          Configuring staging location for Azure Stack Hub VMs to restore from backup
    5. CloudPoint storage array plug-ins
      1.  
        How to configure the CloudPoint storage array plug-ins?
      2. NetApp plug-in configuration notes
        1.  
          NetApp plug-in configuration parameters
        2.  
          Configuring a dedicated LIF for NetBackup access
        3.  
          Supported CloudPoint operations on NetApp storage
      3.  
        ACL configuration on NetApp array
      4. Nutanix Files plug-in configuration notes
        1.  
          Nutanix Files plug-in configuration prerequisites
        2.  
          Nutanix Files plug-in considerations and limitations
        3.  
          Supported CloudPoint operations on Nutanix Files File Server
        4. Troubleshooting NetBackup issues for Nutanix Files
          1.  
            Backup jobs for Nutanix Files fail due to snapshot import and export operations failures
          2.  
            Plug-in configuration may fail if the Nutanix Files version is unsupported
      5.  
        Configuring ACL for Nutanix array
      6. Dell EMC Unity array plug-in configuration notes
        1.  
          Dell EMC Unity array plug-in configuration parameters
        2.  
          Supported Dell EMC Unity arrays
        3.  
          Supported CloudPoint operations on Dell EMC Unity arrays
      7. Pure Storage FlashArray plug-in configuration notes
        1.  
          Supported Pure Storage FlashArray models
        2.  
          Supported CloudPoint operations on Pure Storage FlashArray models
      8.  
        HPE XP plug-in configuration parameters
      9. HPE RMC plug-in configuration notes
        1.  
          RMC plug-in configuration parameters
        2.  
          Supported HPE storage systems
        3.  
          Supported CloudPoint operations on HPE storage arrays
      10. HPE XP plug-in configuration notes
        1.  
          HPE XP plug-in configuration parameters
        2.  
          Supported CloudPoint operations on HPE XP storage arrays
      11. Hitachi plug-in configuration notes
        1.  
          Hitachi plug-in configuration parameters
        2.  
          Supported Hitachi storage arrays
        3.  
          Supported CloudPoint operations on Hitachi arrays
      12. Hitachi (HDS VSP 5000) plug-in configuration notes
        1.  
          Hitachi (HDS VSP 5000) plug-in configuration parameters
        2.  
          Supported CloudPoint operations on Hitachi (HDS VSP 5000) array
      13. InfiniBox plug-in configuration notes
        1.  
          InifiniBox plug-in configuration parameters
        2.  
          Supported CloudPoint operations on InfiniBox arrays
      14. Dell EMC PowerScale (Isilon) plug-in configuration notes
        1.  
          Dell EMC PowerScale (Isilon) plug-in configuration prerequisites
        2.  
          Supported CloudPoint operations on Dell EMC PowerScale (Isilon) plug-in
      15. Dell EMC PowerMax and VMax plug-in configuration notes
        1.  
          Dell EMC PowerMax and VMax plug-in configuration prerequisites
        2.  
          Supported CloudPoint operations on Dell EMC PowerMax and VMax
      16. Qumulo plug-in configuration notes
        1.  
          Qumulo plug-in configuration prerequisites
        2.  
          Qumulo plug-in considerations and limitations
        3.  
          Supported CloudPoint operations on Qumulo plug-in
    6. CloudPoint application agents and plug-ins
      1.  
        Microsoft SQL plug-in configuration notes
      2. Oracle plug-in configuration notes
        1.  
          Optimizing your Oracle database data and metadata files
      3.  
        MongoDB plug-in configuration notes
      4.  
        About the installation and configuration process
      5.  
        Preparing to install the Linux-based agent
      6.  
        Preparing to install the Windows-based agent
      7.  
        Downloading and installing the CloudPoint agent
      8.  
        Registering the Linux-based agent
      9.  
        Registering the Windows-based agent
      10.  
        Configuring the CloudPoint application plug-in
      11.  
        Configuring VSS to store shadow copies on the originating drive
      12.  
        Creating a NetBackup protection plan for cloud assets
      13.  
        Subscribing cloud assets to a NetBackup protection plan
      14. About snapshot restore
        1.  
          Process for restoring SQL AG databases
      15.  
        Restore requirements and limitations for Microsoft SQL Server
      16.  
        Restore requirements and limitations for Oracle
      17.  
        Additional steps required after an Oracle snapshot restore
      18.  
        Restore requirements and limitations for MongoDB
      19.  
        Additional steps required after a MongoDB snapshot restore
      20.  
        Steps required before restoring SQL AG databases
      21.  
        Recovering a SQL database to the same location
      22.  
        Recovering a SQL database to an alternate location
      23. Additional steps required after a SQL Server snapshot restore
        1.  
          Steps required after a SQL Server disk-level snapshot restore to new location
      24.  
        Additional steps required after restoring SQL AG databases
      25.  
        SQL snapshot or restore and granular restore operations fail if the Windows instance loses connectivity with the CloudPoint host
      26.  
        Disk-level snapshot restore fails if the original disk is detached from the instance
      27.  
        Additional steps required after restoring an AWS RDS database instance
    7. Protecting assets with CloudPoint's agentless feature
      1.  
        About the agentless feature
      2. Prerequisites for the agentless configuration
        1.  
          Configuring SMB for Windows (Optional)
        2.  
          Configuring WMI security for Windows (optional)
      3.  
        Configuring the agentless feature
      4.  
        Configuring the agentless feature after upgrading CloudPoint
    8. Volume Encryption in NetBackup CloudPoint
      1.  
        About volume encryption support in CloudPoint
      2.  
        Volume encryption for Azure
      3.  
        Volume encryption for GCP
      4.  
        Volume encryption for AWS
    9. CloudPoint security
      1.  
        Configuring security for Azure and Azure Stack
      2.  
        Configuring the cloud connector for Azure and Azure Stack
      3.  
        CA configuration for Azure Stack
      4.  
        Securing the connection to CloudPoint
  2. Section II. CloudPoint maintenance
    1. CloudPoint logging
      1.  
        About CloudPoint logging mechanism
      2. How Fluentd-based CloudPoint logging works
        1.  
          About the CloudPoint fluentd configuration file
        2.  
          Modifying the fluentd configuration file
      3.  
        CloudPoint logs
      4.  
        Agentless logs
      5.  
        Troubleshooting CloudPoint logging
    2. Upgrading CloudPoint
      1.  
        About CloudPoint upgrades
      2.  
        Supported upgrade path
      3.  
        Upgrade scenarios
      4.  
        Preparing to upgrade CloudPoint
      5. Upgrading CloudPoint
        1.  
          Upgrade in Docker environment
        2.  
          Upgrade in Podman environment
      6.  
        Upgrading CloudPoint using patch or hotfix
      7. Migrating and upgrading CloudPoint
        1.  
          Before you begin migrating CloudPoint
        2.  
          Migrate and upgrade CloudPoint on RHEL 8.3 or 8.4
      8.  
        Post-upgrade tasks
    3. Uninstalling CloudPoint
      1.  
        Preparing to uninstall CloudPoint
      2.  
        Backing up CloudPoint
      3.  
        Unconfiguring CloudPoint plug-ins
      4.  
        Unconfiguring CloudPoint agents
      5.  
        Removing the CloudPoint agents
      6.  
        Removing CloudPoint from a standalone Docker host environment
      7.  
        Removing CloudPoint extensions - VM-based or managed Kubernetes cluster-based
      8.  
        Restoring CloudPoint
    4. Troubleshooting CloudPoint
      1.  
        Troubleshooting CloudPoint

Upgrade in Docker environment

To upgrade CloudPoint server in Docker environment

  1. Download the CloudPoint upgrade installer.

    On the CloudPoint download page, click Download Now to download the CloudPoint installer.

    The CloudPoint software components are available in the form of Docker images and these images are packaged in a compressed file. The file name has the following format:

    Veritas_CloudPoint_9.x.x.x.img.gz

    The numerical sequence in the file name represents the product version.

  2. Copy the downloaded compressed image file to the computer on which you want to deploy CloudPoint.
  3. Load the image file using the following command:
    # sudo docker load -i <imagefilename>

    For example, if the version is 9.1.0.0.9349, the command syntax is as follows:

    # sudo docker load -i Veritas_CloudPoint_9.1.0.0.9349.img.gz

    Messages similar to the following appear on the command line:

    Load -i VRTScloudpoint-docker-9.1.0.0.9349.img.gz
    
    3b48714f4630: Loading layer [====================>]  26.62kB/26.62kB
    e2be05255641: Loading layer [====================>]  1.022GB/1.022GB
    f4019e787431: Loading layer [====================>]  71.16MB/71.16MB
    8fa41882618d: Loading layer [====================>]   2.56kB/2.56kB
    2eb7b5f07188: Loading layer [====================>]  433.6MB/433.6MB
    9a80f5e55187: Loading layer [====================>]  3.072kB/3.072kB
    Loaded image: veritas/flexsnap-policy:9.1.0.0.9349
    4610240a3245: Loading layer [====================>]   2.56kB/2.56kB
    009536fb1f1f: Loading layer [====================>]  4.096kB/4.096kB
    e281e184c054: Loading layer [====================>]  51.31MB/51.31MB
    01455a2a7aca: Loading layer [====================>]  38.89MB/38.89MB
    0cd7f5d9561b: Loading layer [====================>]  803.8kB/803.8kB
    cbe0c1de2aeb: Loading layer [====================>]  3.072kB/3.072kB
    bf3c086d3dc8: Loading layer [====================>]  99.56MB/99.56MB
    Loaded image: veritas/flexsnap-api-gateway:9.1.0.0.9349
    0c5d3de7e49e: Loading layer [====================>]  38.26MB/38.26MB
    ecc5f9d1a612: Loading layer [====================>]  57.34kB/57.34kB
    02b122e862b3: Loading layer [====================>]  4.327MB/4.327MB
    Loaded image: veritas/flexsnap-cloudpoint:9.1.0.0.9349
    Loaded image: veritas/flexsnap-fluentd:9.1.0.0.9349
    60b2acb680f6: Loading layer [====================>]  3.584kB/3.584kB
    f595300c08bc: Loading layer [====================>]  3.584kB/3.584kB
    Loaded image: veritas/flexsnap-mongodb:9.1.0.0.9349
    Loaded image: veritas/flexsnap-agent:9.1.0.0.9349
    Loaded image: veritas/flexsnap-scheduler:9.1.0.0.9349
    8df81d5ea017: Loading layer [====================>]   7.68kB/7.68kB
    7d0351be3c82: Loading layer [====================>]  3.072kB/3.072kB
    Loaded image: veritas/flexsnap-nginx:9.1.0.0.9349
    2ab7b82b7b67: Loading layer [====================>]  433.6MB/433.6MB
    cb5786a5d4da: Loading layer [====================>]  3.072kB/3.072kB
    Loaded image: veritas/flexsnap-coordinator:9.1.0.0.9349
    82845be8152d: Loading layer [====================>]   2.56kB/2.56kB
    4335a9dd8761: Loading layer [====================>]  433.6MB/433.6MB
    7726c32b0a94: Loading layer [====================>]  3.072kB/3.072kB
    Loaded image: veritas/flexsnap-onhostagent:9.1.0.0.9349
    ee9829847a2f: Loading layer [====================>]  10.12MB/10.12MB
    e821f4ed533d: Loading layer [====================>]   2.56kB/2.56kB
    b2ca6971711b: Loading layer [====================>]  17.92kB/17.92kB
    ac4489fdf0fb: Loading layer [====================>]  38.26MB/38.26MB
    7a3246be4423: Loading layer [====================>]  12.92MB/12.92MB
    663007ab9b7a: Loading layer [====================>]  31.74kB/31.74kB
    Loaded image: veritas/flexsnap-config:9.1.0.0.9349
    7eb7d2ecf33a: Loading layer [====================>]  12.92MB/12.92MB
    4cbef47218cf: Loading layer [====================>]  3.072kB/3.072kB
    Loaded image: veritas/flexsnap-certauth:9.1.0.0.9349
    44ed763d4f00: Loading layer [====================>]  38.29MB/38.29MB
    a6d54a76196f: Loading layer [====================>]  4.096kB/4.096kB
    e0340c5d3b40: Loading layer [====================>]  3.072kB/3.072kB
    Loaded image: veritas/flexsnap-rabbitmq:9.1.0.0.9349
    Loaded image: veritas/flexsnap-notification:9.1.0.0.9349
    45358ab4ca0b: Loading layer [====================>]  42.52MB/42.52MB
    31b87f996cd9: Loading layer [====================>]  3.072kB/3.072kB
    fe498c617335: Loading layer [====================>]  48.66MB/48.66MB
    Loaded image: veritas/flexsnap-idm:9.1.0.0.9349
    
    Loaded image: veritas/flexsnap-cloudpoint:9.1.0.0.9349

    Make a note of the loaded image name and version that appears towards the end of the status messages on the command prompt. This represents the new CloudPoint version that you wish to upgrade to. You will need this information in the subsequent steps.

    Note:

    The version displayed here is used for representation only. The actual version will vary depending on the product release you are installing.

  4. Make a note of the current CloudPoint version that is installed. You will use the version number in the next step.
  5. Verify that there are no protection policy snapshots or other operations in progress and then stop CloudPoint by running the following command:
    # sudo docker run -it --rm -v /cloudpoint:/cloudpoint 
    -v /var/run/docker.sock:/var/run/docker.sock 
    veritas/flexsnap-cloudpoint:<current_version> stop

    Here, current_version represents the currently installed CloudPoint version. Use the version number you noted in the earlier step.

    For example, if the installed CloudPoint version is 9.0.0.0.9234, the command will be as follows:

    # sudo docker run -it --rm -v /cloudpoint:/cloudpoint 
    -v /var/run/docker.sock:/var/run/docker.sock 
    veritas/flexsnap-cloudpoint:9.0.0.0.9234 stop

    Note:

    This is a single command. Ensure that you enter the command without any line breaks.

    The CloudPoint containers are stopped one by one. Messages similar to the following appear on the command line:

    Stopping the services
    Stopping container: flexsnap-agent.8a51aac1848c404ab61e4625d7b88703 ...done
    Stopping container: flexsnap-workflow-long-15 ...done
    Stopping container: flexsnap-workflow-long-14 ...done
    Stopping container: flexsnap-workflow-long-13 ...done
    Stopping container: flexsnap-workflow-long-12 ...done
    Stopping container: flexsnap-workflow-long-11 ...done
    Stopping container: flexsnap-workflow-long-10 ...done
    Stopping container: flexsnap-workflow-long-9 ...done
    Stopping container: flexsnap-workflow-long-8 ...done
    Stopping container: flexsnap-workflow-long-7 ...done
    Stopping container: flexsnap-workflow-long-6 ...done
    Stopping container: flexsnap-workflow-long-5 ...done
    Stopping container: flexsnap-workflow-long-4 ...done
    Stopping container: flexsnap-workflow-long-3 ...done
    Stopping container: flexsnap-workflow-long-2 ...done
    Stopping container: flexsnap-workflow-long-1 ...done
    Stopping container: flexsnap-workflow-long-0 ...done
    Stopping container: flexsnap-workflow-15 ...done
    Stopping container: flexsnap-workflow-14 ...done
    Stopping container: flexsnap-workflow-13 ...done
    Stopping container: flexsnap-workflow-12 ...done
    Stopping container: flexsnap-workflow-11 ...done
    Stopping container: flexsnap-workflow-10 ...done
    Stopping container: flexsnap-workflow-9 ...done
    Stopping container: flexsnap-workflow-8 ...done
    Stopping container: flexsnap-workflow-7 ...done
    Stopping container: flexsnap-workflow-6 ...done
    Stopping container: flexsnap-workflow-5 ...done
    Stopping container: flexsnap-workflow-4 ...done
    Stopping container: flexsnap-workflow-3 ...done
    Stopping container: flexsnap-workflow-2 ...done
    Stopping container: flexsnap-workflow-1 ...done
    Stopping container: flexsnap-workflow-0 ...done
    Stopping container: flexsnap-nginx ...done
    Stopping container: flexsnap-notification ...done
    Stopping container: flexsnap-policy ...done
    Stopping container: flexsnap-scheduler ...done
    Stopping container: flexsnap-idm ...done
    Stopping container: flexsnap-onhostagent ...done
    Stopping container: flexsnap-agent ...done
    Stopping container: flexsnap-coordinator ...done
    Stopping container: flexsnap-api-gateway ...done
    Stopping container: flexsnap-certauth ...done
    Stopping container: flexsnap-rabbitmq ...done
    Stopping container: flexsnap-mongodb ...done
    Stopping container: flexsnap-fluentd ...done

    Wait for all the CloudPoint containers to be stopped and then proceed to the next step.

  6. Upgrade CloudPoint by running the following command:
    # sudo docker run -it --rm -v /cloudpoint:/cloudpoint 
    -v /var/run/docker.sock:/var/run/docker.sock
    veritas/flexsnap-cloudpoint:<new_version> install

    For an unattended installation, use the following command:

    # sudo docker run -it --rm -v /cloudpoint:/cloudpoint 
    -v /var/run/docker.sock:/var/run/docker.sock
    veritas/flexsnap-cloudpoint:<new_version> install -y

    Here, new_version represents the CloudPoint version you are upgrading to.

    The -y option passes an approval for all the subsequent installation prompts and allows the installer to proceed in a non-interactive mode.

    For example, using the version number specified earlier, the command will be as follows:

    # sudo docker run -it --rm -v /cloudpoint:/cloudpoint 
    -v /var/run/docker.sock:/var/run/docker.sock
    veritas/flexsnap-cloudpoint:9.1.0.0.9349 install -y

    Note:

    This is a single command. Ensure that you enter the command without any line breaks.

  7. The new CloudPoint installer detects the existing CloudPoint containers that are running and asks for a confirmation for removing them.

    Press Y to confirm the removal of the old CloudPoint containers.

    Note:

    No inputs are required if the installer is run in a non-interactive mode.

    The installer first loads the individual service images and then launches them in their respective containers.

    Wait for the installer to display messages similar to the following and then proceed to the next step:

    Installing the services
    Configuration started at time: Sat May  1 17:27:49 UTC 2021
    docker server version: 19.03.12 Supported: true
    This is an upgrade to NetBackup CloudPoint 9.1.0.0.9349
    Previous CloudPoint version: 9.0.0.0.9234
    Removing exited container flexsnap-ipv6config ...done
    The containers
    flexsnap-agent.9eb4362a2aff43f885be984467faa230
    flexsnap-agent.0ae95311f7f74be89659e62746389bb7
    flexsnap-workflow-system-0-min
    flexsnap-workflow-general-0-min
    flexsnap-listener
    flexsnap-nginx
    flexsnap-notification
    flexsnap-policy
    flexsnap-scheduler
    flexsnap-idm
    flexsnap-onhostagent
    flexsnap-agent
    flexsnap-coordinator
    flexsnap-api-gateway
    flexsnap-certauth
    flexsnap-rabbitmq
    flexsnap-mongodb
    flexsnap-fluentd
    are running.
    Do you wish to remove them ? (y/n): y
    Removing container flexsnap-agent.9eb4362a2aff43f885be984467faa230 ...done
    Removing container flexsnap-agent.0ae95311f7f74be89659e62746389bb7 ...done
    Removing container flexsnap-workflow-system-0-min ...done
    Removing container flexsnap-workflow-general-0-min ...done
    Removing container flexsnap-listener ...done
    Removing container flexsnap-nginx ...done
    Removing container flexsnap-notification ...done
    Removing container flexsnap-policy ...done
    Removing container flexsnap-scheduler ...done
    Removing container flexsnap-idm ...done
    Removing container flexsnap-onhostagent ...done
    Removing container flexsnap-agent ...done
    Removing container flexsnap-coordinator ...done
    Removing container flexsnap-api-gateway ...done
    Removing container flexsnap-certauth ...done
    Removing container flexsnap-rabbitmq ...done
    Removing container flexsnap-mongodb ...done
    Removing container flexsnap-fluentd ...done
    Deleting network : flexsnap-network ...done
    Do you want to take a backup of the CloudPoint metadata prior to upgrade?
    (y/n): y
    Taking backup of CloudPoint metadata...done
    Backup completed successfully.
    Backup file located at /cloudpoint/backup/cloudpoint_9.0.0.0.9234.tar.gz.
    Creating network: flexsnap-network ...done
    Starting container: flexsnap-fluentd ...done
    Starting container: flexsnap-ipv6config ...done
    Starting container: flexsnap-mongodb ...done
    Starting container: flexsnap-rabbitmq ...done
    Starting container: flexsnap-certauth ...done
    Starting container: flexsnap-api-gateway ...done
    Starting container: flexsnap-coordinator ...done
    Starting container: flexsnap-listener ...done
    Starting container: flexsnap-agent ...done
    Starting container: flexsnap-onhostagent ...done
    Starting container: flexsnap-scheduler ...done
    Starting container: flexsnap-policy ...done
    Starting container: flexsnap-notification ...done
    Starting container: flexsnap-idm ...done
    Starting container: flexsnap-config ...done
    Starting container: flexsnap-nginx ...done
    Upgrade finished at time: Sat May  1 17:28:53 UTC 2021
    Before using backups from cloud snapshots, re-register CloudPoint with the
    NetBackup primary server
    
  8. (Optional) Run the following command to remove the previous version images.

    # docker rmi -f <imagename>:<oldimage_tagid>

  9. To verify that the new CloudPoint version is installed successfully:

    See Verifying that CloudPoint is installed successfully.

  10. This concludes the upgrade process. Verify that your CloudPoint configuration settings and data are preserved as is.
  11. If CloudPoint is not registered with the NetBackup primary server, you must register it now.

    Refer to the NetBackup Web UI Cloud Administrator's Guide for instructions.