Veritas NetBackup™ CloudPoint Install and Upgrade Guide

Last Published:
Product(s): NetBackup (10.0)
  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.  
        Downloading the CloudPoint extension
      3.  
        Preparing to install the extension on a VM
      4.  
        Installing the CloudPoint extension on a VM
      5.  
        Preparing to install the extension on a managed Kubernetes cluster (AKS) in Azure
      6.  
        Preparing to install the extension on a managed Kubernetes cluster (EKS) in AWS
      7.  
        Install extension using the Kustomize and CR YAMLs
      8.  
        Installing the CloudPoint extension on Azure (AKS)
      9. Installing the CloudPoint extension on AWS (EKS)
        1.  
          Install extension using the extension script
      10.  
        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. FUJITSU AF/DX plug-in configuration notes
        1.  
          FUJITSU AF/DX plug-in configuration parameters
        2.  
          Supported CloudPoint operations on FUJITSU AF/DX models
      8. NetApp NAS plug-in configuration notes
        1.  
          NetApp NAS plug-in configuration parameters
        2.  
          Supported CloudPoint operations on NetApp NAS models
      9. Dell EMC PowerStore plug-in configuration notes
        1.  
          Dell EMC PowerStore plug-in configuration parameters
        2.  
          Supported CloudPoint operations on Dell EMC PowerStore models
      10. Dell EMC PowerStore NAS plug-in configuration notes
        1.  
          Dell EMC PowerStore NAS plug-in configuration parameters
        2.  
          Supported CloudPoint operations on Dell EMC PowerStore NAS models
      11. Dell EMC PowerFlex plug-in configuration notes
        1.  
          Dell EMC PowerFlex plug-in configuration parameters
        2.  
          Supported CloudPoint operations on Dell EMC PowerFlex models
      12. Dell EMC XtremIO SAN plug-in configuration notes
        1.  
          Dell EMC XtremIO SAN plug-in configuration parameters
        2.  
          Supported CloudPoint operations on Dell EMC XtremIO SAN models
      13. Pure Storage FlashArray plug-in configuration notes
        1.  
          Supported Pure Storage FlashArray models
        2.  
          Supported CloudPoint operations on Pure Storage FlashArray models
      14. Pure Storage FlashBlade plug-in configuration notes
        1.  
          Pure Storage FlashBlade plug-in configuration parameters
        2.  
          Supported CloudPoint operations on Pure Storage FlashBlade models
      15. IBM Storwize plug-in configuration notes
        1.  
          IBM Storwize plug-in configuration parameters
        2.  
          Supported CloudPoint operations on IBM Storwize models
      16. 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
      17. HPE XP plug-in configuration notes
        1.  
          HPE XP plug-in configuration parameters
        2.  
          Supported CloudPoint operations on HPE XP storage arrays
      18. Hitachi plug-in configuration notes
        1.  
          Hitachi plug-in configuration parameters
        2.  
          Supported Hitachi storage arrays
        3.  
          Supported CloudPoint operations on Hitachi arrays
      19. 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
      20. InfiniBox plug-in configuration notes
        1.  
          InifiniBox plug-in configuration parameters
        2.  
          Supported CloudPoint operations on InfiniBox arrays
      21. 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
      22. 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
      23. 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.  
        About the installation and configuration process
      4.  
        Preparing to install the Linux-based agent
      5.  
        Preparing to install the Windows-based agent
      6.  
        Downloading and installing the CloudPoint agent
      7.  
        Registering the Linux-based agent
      8.  
        Registering the Windows-based agent
      9.  
        Configuring the CloudPoint application plug-in
      10.  
        Configuring VSS to store shadow copies on the originating drive
      11.  
        Creating a NetBackup protection plan for cloud assets
      12.  
        Subscribing cloud assets to a NetBackup protection plan
      13.  
        Restore requirements and limitations for Microsoft SQL Server
      14.  
        Restore requirements and limitations for Oracle
      15.  
        Additional steps required after an Oracle snapshot restore
      16.  
        Steps required before restoring SQL AG databases
      17.  
        Recovering a SQL database to the same location
      18.  
        Recovering a SQL database to an alternate location
      19. Additional steps required after a SQL Server snapshot restore
        1.  
          Steps required after a SQL Server disk-level snapshot restore to new location
      20.  
        Additional steps required after restoring SQL AG databases
      21.  
        SQL snapshot or restore and granular restore operations fail if the Windows instance loses connectivity with the CloudPoint host
      22.  
        Disk-level snapshot restore fails if the original disk is detached from the instance
      23.  
        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.5 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

Installing CloudPoint in the Docker environment

Note:

When you deploy CloudPoint, you may want to copy the commands below and paste them in your command line interface. If you do, replace the information in these examples that is different from your own: the product and build version, the download directory path, and so on.

To install CloudPoint

  1. Download the CloudPoint image to the system on which you want to deploy CloudPoint. Go to the Veritas support site:

    https://www.veritas.com/content/support/en_US/downloads

    Note:

    You must log on to the support site to download

    From the Products drop-down, select NetBackup and select the required version from the Version drop-down. Click Explore. Click Base and upgrade installers.

    The CloudPoint image name resembles the following format:

    VRTScloudpoint-docker-x.x.x.x.x.img.gz

    Note:

    The actual file name may vary depending on the release version.

  2. Change directories to where you have downloaded the CloudPoint image.
  3. Type the following command to load the image into Docker:

    # sudo docker load -i CloudPoint_image_name

    For example:

    # sudo docker load -i Veritas_CloudPoint_10.0.0.9818.img.gz

    Messages similar to the following appear on the command line:

    538bd068cab5: Loading layer [================>]  38.26MB/38.26MB
    ed4b778f8d1d: Loading layer [================>]  1.166GB/1.166GB
    c8b269899686: Loading layer [================>]  49.15kB/49.15kB
    Loaded image: veritas/flexsnap-cloudpoint:10.0.0.0.9818

    Make a note of the loaded image name and version that appears on the last line of the output. The version represents the CloudPoint product version that is being installed. You will specify these details in the next step.

  4. Type the following command to run the CloudPoint container:
    # sudo docker run -it --rm 
    -v /<full_path_to_volume_name>:/<full_path_to_volume_name> 
    -v /var/run/docker.sock:/var/run/docker.sock 
    veritas/flexsnap-cloudpoint:<version> install

    If the CloudPoint host is behind a proxy server, use the following command instead:

    # sudo docker run -it --rm 
    -v /<full_path_to_volume_name>:/<full_path_to_volume_name> 
    -e VX_HTTP_PROXY=<http_proxy_value>
    -e VX_HTTPS_PROXY=<https_proxy_value>
    -e VX_NO_PROXY=<no_proxy_value>
    -v /var/run/docker.sock:/var/run/docker.sock 
    veritas/flexsnap-cloudpoint:<version> install

    Replace the following parameters as per your environment:

    Parameter

    Description

    <full_path_to_volume_name>

    Represents the path to the CloudPoint data volume, which typically is /cloudpoint.

    <version>

    Represents the CloudPoint product version that you noted in the earlier step.

    <http_proxy_value>

    (required only if the instance uses a proxy server)

    Represents the value to be used as the HTTP proxy for all connections.

    For example, "http://proxy.mycompany.com:8080/".

    <https_proxy_value>

    (required only if the instance uses a proxy server)

    Represents the value to be used as the HTTPS proxy for all connections.

    For example, "https://proxy.mycompany.com:8080/".

    <no_proxy_value>

    (required only if the instance uses a proxy server)

    Represents the addresses that are allowed to bypass the proxy server. You can specify host names, IP addresses, and domain names in this parameter.

    Use commas to separate multiple entries. For example, "localhost,mycompany.com,192.168.0.10:80".

    Note:

    If CloudPoint is being deployed in the cloud, ensure that you set the following values in this parameter:

    • For an AWS instance, add the following:

      169.254.169.254

    • For a GCP virtual machine, add the following:

      169.254.169.254,metadata,metadata.google.internal

    • For an Azure virtual machine, add the following:

      169.254.169.254

    CloudPoint uses these addresses to gather instance metadata from the instance metadata service.

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

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

    If using a proxy server, then using the examples provided in the table earlier, the command syntax is as follows:

    # sudo docker run -it --rm -v /cloudpoint:/cloudpoint -e VX_HTTP_PROXY="http://proxy.mycompany.com:8080/" -e VX_HTTPS_PROXY="https://proxy.mycompany.com:8080/" -e VX_NO_PROXY="localhost,mycompany.com,192.168.0.10:80" -v /var/run/docker.sock:/var/run/docker.sock veritas/flexsnap-cloudpoint:10.0.0.9818 install

    Note:

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

    The installer displays messages similar to the following:

    Installing the services
    Configuration started at time: Fri Mar 13 06:11:42 UTC 2020
    WARNING: No swap limit support
    Docker server version: 18.09.1
    This is a fresh install of CloudPoint 10.0.0.9818
    Checking if a 1.0 release container exists ...
    CloudPoint currently is not configured. 
    Starting initial services before configuration.
    Creating network: flexsnap-network ...done
    Starting docker container: flexsnap-fluentd ...done
    Creating docker container: flexsnap-mongodb ...done
    Creating docker container: flexsnap-rabbitmq ...done
    Creating docker container: flexsnap-certauth ...done
    Creating docker container: flexsnap-api-gateway ...done
    Creating docker container: flexsnap-coordinator ...done
    Creating docker container: flexsnap-agent ...done
    Creating docker container: flexsnap-onhostagent ...done
    Creating docker container: flexsnap-scheduler ...done
    Creating docker container: flexsnap-policy ...done
    Creating docker container: flexsnap-notification ...done
    Creating docker container: flexsnap-idm ...done
    Starting docker container: flexsnap-config ...done
    Creating self signed keys and certs for nginx ...done
    Starting docker container: flexsnap-nginx ...done

    In this step, CloudPoint does the following:

    • Creates and runs the containers for each of the CloudPoint services.

    • Creates self-signed keys and certificates for nginx.

    Note the following:

    • If you do not specify the volume as -v full_path_to_volume_name:/full_path_to_volume_name, the container writes to the Docker host file system.

  5. Provide the following details when prompted on the command prompt:

    Parameter

    Description

    Admin username

    Specify a user name for the CloudPoint administrator user account.

    Admin password

    Specify a password for the admin user.

    Confirm Admin password

    Confirm the admin user password.

    Host name for TLS certificate

    Specify the IP address or the Fully Qualified Domain Name (FQDN) of the CloudPoint host.

    If you connect to the host using different names (for example, myserver, myserver.mydomain, or myserver.mydomain.mycompany.com), then ensure that you add all the names here if you want to enable CloudPoint access using those names.

    Use commas to specify multiple entries. The names you specify here must point to the same CloudPoint host.

    The specified names or IP address are added to the list of host names to use for configuring CloudPoint. The installer uses these names to generate a server certificate for the CloudPoint host.

    Port

    Specify the port through which the CloudPoint server can communicate. Default is port 443.

    The installer then displays messages similar to the following:

    Configuring admin credentials ...done
    Waiting for CloudPoint configuration to complete (22/22) ...done
    Configuration complete at time Fri Mar 13 06:15:43 UTC 2020!
  6. This concludes the CloudPoint deployment process. The next step is to register the CloudPoint server with the Veritas NetBackup primary server.

    If CloudPoint is deployed in the cloud, refer to the NetBackup Web UI Cloud Administrator's Guide for instructions. If CloudPoint is deployed on-premise, refer to the NetBackup Snapshot Client Administrator's Guide for instructions.

Note:

If you ever need to restart CloudPoint, use the docker run command so that your environmental data is preserved.

See Restarting CloudPoint.