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

Installing the CloudPoint extension on a managed Kubernetes cluster

Before you install the CloudPoint extension:

To install the extension

  1. Ensure that you have downloaded the extension script cp_extension_start.sh.

    See Downloading the CloudPoint extension.

    Note:

    Do not create the authentication token yet, as it is valid only for 180 seconds.

  2. If the host from which you want to install the extension is not the same host where your CloudPoint is installed, load the CloudPoint container images on the extension host (flexsnap-cloudpoint, flexsnap-listener, flexsnap-workflow, flexsnap-fluentd, flexsnap-datamover)

    The image names are in the following format:

    Example: veritas/flexsnap-cloudpoint

  3. Create image tags to map the source image with the target image, so that you can push the images to the Azure container registry you created earlier in the preparation steps.

    See Preparing to install the extension on a managed Kubernetes cluster.

    Gather the following parameters beforehand:

    Parameter

    Description

    container_registry_path

    To obtain the container registry path, go to your container registry in Azure and from the Overview pane, copy the 'Login server'.

    Example: mycontainer.azurecr.io

    tag

    CloudPoint image version.

    Example: 9.0.1.0.9129

    • To tag the images, run the following command for each image, depending on the container platform running on your host:

      For Docker: # docker tag source_image:tag target_image:tag

      For Podman: # podman tag source_image:tag target_image:tag

      Where,

      • the source image tag is: veritas/flexsnap-cloudpoint:tag>

      • the target image tag is: <container_registry_path>/<source_image_name>:<CloudPoint_version_tag>

    Example:

    # docker tag veritas/flexsnap-cloudpoint:9.0.1.0.9129 mycontainer.azurecr.io/veritas/flexsnap-cloudpoint:9.0.1.0.9129
    # docker tag veritas/flexsnap-listener:9.0.1.0.9129 mycontainer.azurecr.io/veritas/flexsnap-listener:9.0.1.0.9129
    # docker tag veritas/flexsnap-fluentd:9.0.1.0.9129 mycontainer.azurecr.io/veritas/flexsnap-fluentd:9.0.1.0.9129
    # docker tag veritas/flexsnap-workflow:9.0.1.0.9129 mycontainer.azurecr.io/veritas/flexsnap-workflow:9.0.1.0.9129
    # docker tag veritas/flexsnap-datamover:9.0.1.0.9129 mycontainer.azurecr.io/veritas/flexsnap-datamover:9.0.1.0.9129
  4. Then to push the images to the container registry, run the following command for each image, depending on the container platform running on your host:

    For Docker: # docker push target_image:tag

    For Podman: # podman push target_image:tag

    Example:

    # docker push mycontainer.azurecr.io/veritas/flexsnap-cloudpoint:9.0.1.0.9129
    # docker push mycontainer.azurecr.io/veritas/flexsnap-listener:9.0.1.0.9129
    # docker push mycontainer.azurecr.io/veritas/flexsnap-fluentd:9.0.1.0.9129
    # docker push mycontainer.azurecr.io/veritas/flexsnap-workflow:9.0.1.0.9129
    # docker push mycontainer.azurecr.io/veritas/flexsnap-datamover:9.0.1.0.9129
    
  5. Once the images are pushed to the container registry, execute the extension script cp_extension_start.sh that was downloaded earlier, from the host where kubectl is installed. The script can be executed either by providing all the required input parameters in one command, or in an interactive way where you will be prompted for input.

    Gather the following parameters before running the script:

    Parameter

    Description

    cloudpoint_ip

    Provide IP address or FQDN of the main CloudPoint host.

    target_image:tag

    Target image tag created for the flexsnap-cloudpoint image in step 3.

    Example: 'mycontainer.azurecr.io/veritas/flexsnap-cloudpoint:9.0.1.0.9129'

    namespace

    CloudPoint namespace that was created earlier in the preparation steps.

    tag_key=tag_val

    tag_key and tag_val can be retrieved by using these commands:

    1. Get the name of the node:

      # kubectl get nodes | grep <node_name>

    2. Get the tag key=value label:

      # kubectl describe node <node_name> -n <namespace> | grep -i labels

    Output example: agentpool=cpuserpool

    secret_name

    Kubernetes secret that was created earlier in the preparation steps.

    Example: mysecret

    fileshare_name

    You can find the name of your file share in your storage account in the Azure portal. It is recommended that your storage account and the Kubernetes cluster should be in the same region

    Example: mysharename

    workflow_token

    Authentication token created from the NetBackup Web UI - Add extension dialog.

    See Downloading the CloudPoint extension.

    Run the script as an executable file:

    • Permit the script to run as an executable:

      # chmod +x cp_extension_start.sh

    • Run the installation command with all the input parameters described in the above table:

      # ./cp_extension_start.sh install -c <cloudpoint_ip> -i <target_image:tag> -n <namespace> -p <tag_key=tag_val> -s <secret_name> -f <fileshare_name> -t <workflow_token>

      Example:

      # ./cp_extension_start.sh install 
      -c 10.20.xx.xxx 
      -i mycontainer.azurecr.io/veritas/flexsnap-cloudpoint:9.0.1.0.9271 
      -n cloudpoint-system 
      -p agentpool=cpuserpool 
      -s mysecret 
      -f mysharename 
      -t workflow-3q3ou4jxiircp9tk0eer2g9jx7mwuypwz10k4i3sms2e7k4ee7-.....

    Run the script as an interactive file:

    • Run the following command:

      # ./cp_extension_start.sh install

    • When the script runs, provide the input parameters as described in the above table:

    CloudPoint IP or fully-qualified domain name: 10.20.xx.xxx
    Veritas CloudPoint image repository path. Format=<Login-server/image:tag>:
    mycontainer.azurecr.io/veritas/flexsnap-cloudpoint:9.0.1.0.9255
    CloudPoint extension namespace: cloudpoint-system
    Node pool with format key=value: agentpool=cpuserpool
    Azure Fileshare Secret: mysecret
    Azure Fileshare Name: mysharename
    CloudPoint extension token:
    
    Getting CloudPoint service file ...done
    Getting CloudPoint CRD file ...done
    Azure Fileshare Secret Validation ...done
    
    Starting CloudPoint service deployment
    
    namespace/cloudpoint-system configured
    
    deployment.apps/flexsnap-cloudpoint created
    
    serviceaccount/cloudpoint-acc created
    
    clusterrole.rbac.authorization.k8s.io/cloudpoint-cloudpoint-system unchanged
    
    clusterrolebinding.rbac.authorization.k8s.io/cloudpoint-rolebinding-cloudpoint-system unchanged
    
    customresourcedefinition.apiextensions.k8s.io/cloudpoint-servers.veritas.com created
    
    CloudPoint service deployment ...done
    
    customresourcedefinition.apiextensions.k8s.io/cloudpoint-servers.veritas.com condition met
    
    Generating CloudPoint Custom Resource Definition object
    
    cloudpointrule.veritas.com/cloudpoint-config-rule created
    
    CloudPoint extension installation ...done
    

    Note:

    The output examples have been formatted to fit the screen.

This concludes the CloudPoint extension installation on a managed Kubernetes cluster (in Azure cloud).

To verify that the extension is installed successfully:

  • Verify that the success message is displayed at the command prompt.

  • Verify that the extension is listed on the NetBackup Web UI.

    Go to Cloud > CloudPoint Servers tab > click Advanced settings > go to CloudPoint extensions tab and verify.

  • Run the following command and verify that there are four pods, namely, flexsnap-cloudpoint-xxx, flexsnap-fluentd-xxx, flexsnap-listener-xxx, flexsnap-fluentd-collector-xxx, flexsnap-datamover-xxxx in Running state:

    # kubectl get pods -n <namespace>

    Example: # kubectl get pods -n cloudpoint-system