NetBackup™ Snapshot Manager for Cloud Install and Upgrade Guide

Last Published:
Product(s): NetBackup & Alta Data Protection (11.0)
  1. Introduction
    1.  
      About the deployment approach
    2.  
      Deciding where to run NetBackup Snapshot Manager for Cloud
    3.  
      About deploying NetBackup Snapshot Manager in the cloud
  2. Section I. NetBackup Snapshot Manager for Cloud installation and configuration
    1. Preparing for NetBackup Snapshot Manager for Cloud installation
      1.  
        Meeting system requirements
      2.  
        NetBackup Snapshot Manager host sizing recommendations
      3.  
        NetBackup Snapshot Manager extension sizing recommendations
      4.  
        Creating an instance or preparing the host to install NetBackup Snapshot Manager
      5.  
        Installing container platform (Docker, Podman)
      6.  
        Creating and mounting a volume to store NetBackup Snapshot Manager data
      7.  
        Verifying that specific ports are open on the instance or physical host
      8.  
        Preparing NetBackup Snapshot Manager for backup from snapshot jobs
      9.  
        OCI - iptables rules for backup from snapshot jobs
    2. Deploying NetBackup Snapshot Manager for Cloud using container images
      1.  
        Before you begin installing NetBackup Snapshot Manager
      2.  
        Installing NetBackup Snapshot Manager in the Docker/Podman environment
      3.  
        Installing NetBackup Snapshot Manager on CIS Level 2 v2 configured host
      4.  
        Securing the connection to NetBackup Snapshot Manager
      5.  
        Verifying that NetBackup Snapshot Manager is installed successfully
      6.  
        Restarting NetBackup Snapshot Manager
    3. Deploying NetBackup Snapshot Manager for Cloud extensions
      1.  
        Before you begin installing NetBackup Snapshot Manager extensions
      2.  
        Downloading the NetBackup Snapshot Manager extension
      3. Installing the NetBackup Snapshot Manager extension on a VM
        1.  
          Prerequisites to install the extension on VM
        2.  
          Installing the extension on a VM
      4. Installing the NetBackup Snapshot Manager extension on a managed Kubernetes cluster (AKS) in Azure
        1.  
          Prerequisites to install the extension on a managed Kubernetes cluster in Azure
        2.  
          Installing the extension on Azure (AKS)
      5. Installing the NetBackup Snapshot Manager extension on a managed Kubernetes cluster (EKS) in AWS
        1.  
          Prerequisites to install the extension on a managed Kubernetes cluster in AWS
        2. Installing the extension on AWS (EKS)
          1.  
            Install extension using the extension script
      6. Installing the NetBackup Snapshot Manager extension on a managed Kubernetes cluster (GKE) in GCP
        1.  
          Prerequisites to install the extension on a managed Kubernetes cluster in GCP
        2.  
          Installing the extension on GCP (GKE)
      7.  
        Install extension using the Kustomize and CR YAMLs
      8.  
        Managing the extensions
    4. NetBackup Snapshot Manager for cloud providers
      1.  
        Why to configure the NetBackup Snapshot Manager cloud providers?
      2. AWS plug-in configuration notes
        1.  
          Prerequisites for configuring the AWS plug-in
        2.  
          Before you create a cross account configuration
        3.  
          Prerequisites for application consistent snapshots using AWS Systems Service Manager
        4.  
          Prerequisites for configuring AWS plug-in using VPC endpoint
        5.  
          AWS permissions required by NetBackup Snapshot Manager
        6.  
          Configuring AWS permissions for NetBackup Snapshot Manager
      3. Google Cloud Platform plug-in configuration notes
        1. Prerequisites for configuring the GCP plug-in using Credential and Service Account option
          1.  
            Additional prerequisites for configuring the GCP plug-in using Service Account option
        2.  
          Google Cloud Platform permissions required by NetBackup Snapshot Manager
        3.  
          Preparing the GCP service account for plug-in configuration
        4.  
          Configuring a GCP service account for NetBackup Snapshot Manager
        5.  
          GCP cross-project configuration
        6.  
          GCP shared VPC 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
        3.  
          About Azure Stack Hub snapshots
      6. OCI plug-in configuration notes
        1.  
          Limitation of NetBackup OCI support
        2.  
          Prerequisite for configuring the OCI plug-in
        3.  
          OCI configuration parameters
        4.  
          Configuring host support for OCI
        5.  
          OCI permissions required by NetBackup Snapshot Manager
      7.  
        Cloud Service Provider endpoints for DBPaaS
    5. Configuration for protecting assets on cloud hosts/VM
      1.  
        Deciding which feature (on-host agent or agentless) of NetBackup Snapshot Manager is to be used for protecting the assets
      2. Protecting assets with NetBackup Snapshot Manager's on-host agent feature
        1. Installing and configuring NetBackup Snapshot Manager agent
          1.  
            Downloading and installing the NetBackup Snapshot Manager agent
          2. Linux-based agent
            1.  
              Preparing to install the Linux-based agent
            2.  
              Registering the Linux-based agent
          3. Windows-based agent
            1.  
              Preparing to install the Windows-based agent
            2.  
              Registering the Windows-based agent
        2. Configuring the NetBackup Snapshot Manager application plug-in
          1.  
            Configuring an application plug-in
          2. Microsoft SQL plug-in
            1.  
              Microsoft SQL plug-in configuration requirements
            2.  
              Restore requirements and limitations for Microsoft SQL Server
            3.  
              Steps required before restoring SQL AG databases
            4.  
              Additional steps required after restoring SQL AG databases
            5. Additional steps required after a SQL Server instance snapshot restore
              1.  
                Steps required after a SQL Server host-level restore
              2.  
                Steps required after a SQL Server instance disk-level snapshot restore to new location
          3. Oracle plug-in
            1. Oracle plug-in configuration requirements
              1.  
                Optimizing your Oracle database data and metadata files
            2.  
              Restore requirements and limitations for Oracle
            3.  
              Additional steps required after an Oracle snapshot restore
      3. Protecting assets with NetBackup Snapshot Manager's agentless feature
        1.  
          Prerequisites for the agentless configuration
        2.  
          Configuring the agentless feature
        3.  
          Configuring the agentless feature after upgrading NetBackup Snapshot Manager
    6. Snapshot Manager for cloud catalog backup and recovery
      1.  
        About using script
      2.  
        NetBackup Snapshot Manager data backup
      3.  
        NetBackup Snapshot Manager data recovery
    7. NetBackup Snapshot Manager for cloud assets protection
      1. NetBackup protection plan
        1.  
          Creating a NetBackup protection plan for cloud assets
        2.  
          Subscribing cloud assets to a NetBackup protection plan
      2.  
        Assigning tags on snapshots and Restore Point Collection
      3.  
        Configuring VSS to store shadow copies on the originating drive
    8. Volume encryption in NetBackup Snapshot Manager for cloud
      1.  
        About volume encryption support in NetBackup Snapshot Manager
      2.  
        Volume encryption for Azure
      3.  
        Volume encryption for GCP
      4.  
        Volume encryption for AWS
      5.  
        Volume encryption for OCI
    9. NetBackup Snapshot Manager for Cloud security
      1.  
        Configuring security for Azure Stack
      2.  
        Configuring the cloud connector for Azure Stack
      3.  
        CA configuration for Azure Stack
  3. Section II. NetBackup Snapshot Manager for Cloud maintenance
    1. NetBackup Snapshot Manager for Cloud logging
      1.  
        About NetBackup Snapshot Manager logging mechanism
      2. How Fluentd-based NetBackup Snapshot Manager logging works
        1.  
          About the NetBackup Snapshot Manager fluentd configuration file
        2.  
          Modifying the fluentd configuration file
      3.  
        NetBackup Snapshot Manager logs
      4.  
        Agentless logs
      5.  
        Troubleshooting NetBackup Snapshot Manager logging
    2. Upgrading NetBackup Snapshot Manager for Cloud
      1.  
        About NetBackup Snapshot Manager for Cloud upgrades
      2.  
        Supported upgrade path
      3.  
        Upgrade scenarios
      4.  
        Preparing to upgrade NetBackup Snapshot Manager
      5.  
        Upgrading NetBackup Snapshot Manager
      6.  
        Upgrading NetBackup Snapshot Manager using patch or hotfix
      7.  
        Applying operating system patches on NetBackup Snapshot Manager host
      8. Migrating and upgrading NetBackup Snapshot Manager
        1.  
          Before you begin migrating NetBackup Snapshot Manager
        2.  
          Migrate and upgrade NetBackup Snapshot Manager on RHEL 8.x and 9.x
      9.  
        GCP configuration for migration from zone to region
      10. Post-upgrade tasks
        1.  
          Upgrading NetBackup Snapshot Manager extensions
        2.  
          Post upgrade limitations
      11.  
        Post-migration tasks
    3. Uninstalling NetBackup Snapshot Manager for Cloud
      1.  
        Preparing to uninstall NetBackup Snapshot Manager
      2.  
        Backing up NetBackup Snapshot Manager
      3.  
        Unconfiguring NetBackup Snapshot Manager plug-ins
      4.  
        Unconfiguring NetBackup Snapshot Manager agents
      5.  
        Removing the NetBackup Snapshot Manager agents
      6.  
        Removing NetBackup Snapshot Manager from a standalone Docker host environment
      7.  
        Removing NetBackup Snapshot Manager extensions - VM-based or managed Kubernetes cluster-based
      8.  
        Restoring NetBackup Snapshot Manager
    4. Troubleshooting NetBackup Snapshot Manager for Cloud
      1.  
        Troubleshooting NetBackup Snapshot Manager
      2.  
        SQL snapshot or restore and granular restore operations fail if the Windows instance loses connectivity with the NetBackup Snapshot Manager host
      3.  
        Disk-level snapshot restore fails if the original disk is detached from the instance
      4.  
        Discovery is not working even after assigning system managed identity to the control node pool
      5.  
        Performance issue with GCP backup from snapshot
      6.  
        Post migration on host agents fail with an error message
      7.  
        File restore job fails with an error message
      8.  
        Acknowledgment not received for datamover
      9.  
        Google Cloud Platform does display the Snapshot ID of the disk
      10.  
        Application state of the connected/configured cloud VM(s) displays an error after upgrading to NetBackup Snapshot Manager version 11.x
      11.  
        Backup and restore jobs fail with timeout error
      12.  
        GCP restore with encryption key failed with an error message
      13.  
        Amazon Redshift clusters and databases not available after discovery
      14.  
        Shared VPC subnet not visible
      15.  
        Container manager may not spawn the ephemeral registration container timely
      16.  
        GCP restore from VM fails to obtain firewall rules
      17.  
        Parameterised VM restore fails to retrieve encryption keys
      18.  
        Restore from snapshot of a VM with security type Trusted Launch fails
      19.  
        Snapshot Manager failed to retrieve the specified cloud domain(s), against the specified plugin instance
      20.  
        Issues with SELinux configuration
      21.  
        Performance issues with OCI backup from snapshot and restore from backup copy
      22.  
        Connection to Amazon Linux 2023 or Alma Linux machines fail
      23.  
        Single file restore from snapshot copy fails with an error
      24.  
        MS SQL application backup, restore, or SFR job on Windows cloud VM fails with an error
      25.  
        Status 49 error appears
      26.  
        Restore from backup fails with an error
      27.  
        (For AWS) If the specified AMI is not subscribed in the given region an error message appears
      28.  
        Restore of Azure Disk Encrypted VM fails with an error

Installing the extension on Azure (AKS)

Before you install the NetBackup Snapshot Manager extension on a managed Kubernetes cluster (AKS) in Azure:

To install the extension

  1. Download the extension script nbu_flexsnap_extension.tar.

    See Downloading the NetBackup Snapshot Manager 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 NetBackup Snapshot Manager is installed, load the NetBackup Snapshot Manager container images on the extension host (flexsnap-deploy, flexsnap-core, flexsnap-fluentd, flexsnap-datamover)

    The image names are in the following format:

    Example: veritas/flexsnap-deploy

  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. For more information, see Prerequisites to install the extension on a managed Kubernetes cluster in Azure.

    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

    NetBackup Snapshot Manager image version.

    Example: 11.0.x.x-xxxx

    • 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-deploy:tag>

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

      Example:

      # docker tag veritas/flexsnap-deploy:11.0.x.x-xxxx 
      mycontainer.azurecr.io/veritas/flexsnap-deploy:11.0.x.x-xxxx
      # docker tag veritas/flexsnap-core:11.0.x.x-xxxx 
      mycontainer.azurecr.io/veritas/flexsnap-core:11.0.x.x-xxxx
      # docker tag veritas/flexsnap-fluentd:11.0.x.x-xxxx 
      mycontainer.azurecr.io/veritas/flexsnap-fluentd:11.0.x.x-xxxx
      # docker tag veritas/flexsnap-datamover:11.0.x.x-xxxx 
      mycontainer.azurecr.io/veritas/flexsnap-datamover:11.0.x.x-xxxx
  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-deploy:11.0.x.x-xxxx
    # docker push mycontainer.azurecr.io/veritas/
    flexsnap-core:11.0.x.x-xxxx
    # docker push mycontainer.azurecr.io/veritas/
    flexsnap-fluentd:11.0.x.x-xxxx
    # docker push mycontainer.azurecr.io/veritas/
    flexsnap-datamover:11.0.x.x-xxxx
  5. Once the images are pushed to the container registry, execute the extension script cp_extension.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

    snapshotmanager_ip

    Provide IP address or FQDN of the main NetBackup Snapshot Manager host.

    target_image:tag

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

    Example: mycontainer.azurecr.io/veritas/flexsnap-deploy:11.0.x.x-xxxx

    namespace

    NetBackup Snapshot Manager 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

    storage_class

    Kubernetes storage class that was created earlier in the preparation steps.

    Example: cloudpoint-sc

    Size in GB

    Volume size to be provisioned as per your scaling requirements.

    workflow_token

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

    See Downloading the NetBackup Snapshot Manager extension.

    Note:

    While deploying NetBackup Snapshot Manager Kubernetes extension, create a storage class and provide it as an input to the NetBackup Snapshot Manager extension installation script. By default file properties are open, hence it is recommended to create storage class by providing custom attributes in order to maintain the file/folder permissions created on extension under /cloudpoint directory. For more information, see Create a storage class section of the Azure product documentation.

    Run the script as an executable file:

    • Permit the script to run as an executable:

      # chmod +x cp_extension.sh

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

      ./cp_extension.sh install -c <snapshotmanager_ip> -i <target_image:tag> -n <namespace> -p <tag_key=tag_val> -s <storage_class> -t <workflow_token> -k <Size (In GiB)>

      Example:

      ./cp_extension.sh install
      Snapshot Manager image repository path. Format=<Login-server/image:tag>:
       cpautomation.azurecr.io/veritas/flexsnap-deploy:11.0.x.x-xxxx
      Snapshot Manager extension namespace: snapshot-manager
      Snapshot Manager IP or fully-qualified domain name: <ip-address>
      Node group/pool label with format key=value: agentpool=extpool
      Storage class name: azurefile
      Size in GiB (minimum 30 GiB, Please refer NetBackup Snapshot Manager 
      Install and Upgrade Guide for PV size): 50
      Snapshot Manager extension token:
      This is a fresh NetBackup Snapshot Manager Extension Installation
      
      Starting Snapshot Manager service deployment
      customresourcedefinition.apiextensions.k8s.io/
      cloudpoint-servers.veritas.com unchanged
      serviceaccount/cloudpoint-acc created
      clusterrole.rbac.authorization.k8s.io/cloudpoint-cloudpoint-yj created
      clusterrolebinding.rbac.authorization.k8s.io/
      cloudpoint-rolebinding-cloudpoint-yj created
      deployment.apps/flexsnap-operator created
      Snapshot Manager service deployment ...done
      
      Generating Snapshot Manager Custom Resource Definition object
      Waiting for deployment "flexsnap-operator" rollout to finish: 
      0 of 1 updated replicas are available...
      deployment "flexsnap-operator" successfully rolled out
      cloudpointrule.veritas.com/cloudpoint-config-rule created
      Snapshot Manager extension installation ...
      Operator operations passed
      Waiting for all components to come up ...Done
      Waiting for all components to come up ...Done
      

    Run the script as an interactive file:

    • Run the following command:

      # ./cp_extension.sh install

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

      ./cp_extension.sh install
      Snapshot Manager image repository path. Format=<Login-server/image:tag>: 
      cpautomation.azurecr.io/veritas/flexsnap-deploy:11.0.x.x-xxxx
      Snapshot Manager extension namespace: snapshot-manager
      Snapshot Manager IP or fully-qualified domain name: <ip-address>
      Node group/pool label with format key=value: agentpool=extpool
      Storage class name: azurefile
      Size in GiB (minimum 30 GiB, Please refer NetBackup Snapshot Manager 
      Install and Upgrade Guide for PV size): 50
      Snapshot Manager extension token:
      This is a fresh NetBackup Snapshot Manager Extension Installation
      
      Starting Snapshot Manager service deployment
      customresourcedefinition.apiextensions.k8s.io/
      cloudpoint-servers.veritas.com unchanged
      serviceaccount/cloudpoint-acc created
      clusterrole.rbac.authorization.k8s.io/
      cloudpoint-cloudpoint-yj created
      clusterrolebinding.rbac.authorization.k8s.io/
      cloudpoint-rolebinding-cloudpoint-yj created
      deployment.apps/flexsnap-operator created
      Snapshot Manager service deployment ...done
      
      Generating Snapshot Manager Custom Resource Definition object
      Waiting for deployment "flexsnap-operator" rollout to finish:
       0 of 1 updated replicas are available...
      deployment "flexsnap-operator" successfully rolled out
      cloudpointrule.veritas.com/cloudpoint-config-rule created
      Snapshot Manager extension installation ...
      Operator operations passed
      Waiting for all components to come up ...Done
      Waiting for all components to come up ...Done
      

    Note:

    The output examples have been formatted to fit the screen.

This concludes the NetBackup Snapshot Manager 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 > NetBackup Snapshot Manager tab > click Advanced settings > go to NetBackup Snapshot Manager extensions tab and verify.

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

    # kubectl get pods -n <namespace>

    Example: # kubectl get pods -n cloudpoint-system