NetBackup™ Deployment Guide for Amazon Elastic Kubernetes Services (EKS) Cluster

Last Published:
Product(s): NetBackup & Alta Data Protection (10.1.1)
  1. Introduction to NetBackup on EKS
    1.  
      About NetBackup deployment on Amazon Elastic Kubernetes (EKS) cluster
    2.  
      Required terminology
    3.  
      User roles and permissions
    4.  
      About MSDP Scaleout
    5.  
      About MSDP Scaleout components
    6.  
      Limitations in MSDP Scaleout
  2. Deployment with environment operators
    1. About deployment with the environment operator
      1.  
        Prerequisites
      2.  
        Contents of the TAR file
      3.  
        Known limitations
    2.  
      Deploying the operators manually
    3.  
      Deploying NetBackup and MSDP Scaleout manually
    4.  
      Deploying NetBackup and Snapshot Manager manually
    5.  
      Configuring the environment.yaml file
    6.  
      Uninstalling NetBackup environment and the operators
    7.  
      Applying security patches
  3. Assessing cluster configuration before deployment
    1.  
      How does the webhook validation works
    2.  
      Webhooks validation execution details
    3.  
      How does the Config-Checker utility work
    4.  
      Config-Checker execution and status details
  4. Deploying NetBackup
    1.  
      Preparing the environment for NetBackup installation on EKS
    2.  
      Recommendations of NetBackup deployment on EKS
    3.  
      Limitations of NetBackup deployment on EKS
    4. About primary server CR and media server CR
      1.  
        After installing primary server CR
      2.  
        After Installing the media server CR
    5.  
      Monitoring the status of the CRs
    6.  
      Updating the CRs
    7.  
      Deleting the CRs
    8.  
      Configuring NetBackup IT Analytics for NetBackup deployment
    9.  
      Managing NetBackup deployment using VxUpdate
    10.  
      Migrating the node group for primary or media servers
  5. Upgrading NetBackup
    1.  
      Preparing for NetBackup upgrade
    2.  
      Upgrading NetBackup operator
    3.  
      Upgrading NetBackup application
    4.  
      Upgrade NetBackup from previous versions
    5.  
      Procedure to rollback when upgrade fails
  6. Deploying Snapshot Manager
    1.  
      Overview
    2.  
      Prerequisites
    3.  
      Installing the docker images
  7. Migration and upgrade of Snapshot Manager
    1.  
      Migration and updating of Snapshot Manager
  8. Deploying MSDP Scaleout
    1.  
      Deploying MSDP Scaleout
    2.  
      Prerequisites
    3.  
      Installing the docker images and binaries
    4.  
      Initializing the MSDP operator
    5.  
      Configuring MSDP Scaleout
    6.  
      Using MSDP Scaleout as a single storage pool in NetBackup
    7.  
      Configuring the MSDP cloud in MSDP Scaleout
  9. Upgrading MSDP Scaleout
    1.  
      Upgrading MSDP Scaleout
  10. Monitoring NetBackup
    1.  
      Monitoring the application health
    2.  
      Telemetry reporting
    3.  
      About NetBackup operator logs
    4.  
      Expanding storage volumes
    5.  
      Allocating static PV for Primary and Media pods
  11. Monitoring MSDP Scaleout
    1.  
      About MSDP Scaleout status and events
    2.  
      Monitoring with Amazon CloudWatch
    3.  
      The Kubernetes resources for MSDP Scaleout and MSDP operator
  12. Monitoring Snapshot Manager deployment
    1.  
      Overview
    2.  
      Logs of Snapshot Manager
    3.  
      Configuration parameters
  13. Managing the Load Balancer service
    1.  
      About the Load Balancer service
    2.  
      Notes for Load Balancer service
    3.  
      Opening the ports from the Load Balancer service
  14. Performing catalog backup and recovery
    1.  
      Backing up a catalog
    2.  
      Restoring a catalog
  15. Managing MSDP Scaleout
    1.  
      Adding MSDP engines
    2.  
      Adding data volumes
    3. Expanding existing data or catalog volumes
      1.  
        Manual storage expansion
    4.  
      MSDP Scaleout scaling recommendations
    5. MSDP Cloud backup and disaster recovery
      1.  
        About the reserved storage space
      2.  
        Cloud LSU disaster recovery
    6.  
      MSDP multi-domain support
    7.  
      Configuring Auto Image Replication
    8. About MSDP Scaleout logging and troubleshooting
      1.  
        Collecting the logs and the inspection information
  16. About MSDP Scaleout maintenance
    1.  
      Pausing the MSDP Scaleout operator for maintenance
    2.  
      Logging in to the pods
    3.  
      Reinstalling MSDP Scaleout operator
    4.  
      Migrating the MSDP Scaleout to another node group
  17. Uninstalling MSDP Scaleout from EKS
    1.  
      Cleaning up MSDP Scaleout
    2.  
      Cleaning up the MSDP Scaleout operator
  18. Uninstalling Snapshot Manager
    1.  
      Uninstalling Snapshot Manager from EKS
  19. Troubleshooting
    1.  
      View the list of operator resources
    2.  
      View the list of product resources
    3.  
      View operator logs
    4.  
      View primary logs
    5.  
      Pod restart failure due to liveness probe time-out
    6.  
      Socket connection failure
    7.  
      Resolving an invalid license key issue
    8.  
      Resolving an issue where external IP address is not assigned to a NetBackup server's load balancer services
    9.  
      Resolving the issue where the NetBackup server pod is not scheduled for long time
    10.  
      Resolving an issue where the Storage class does not exist
    11.  
      Resolving an issue where the primary server or media server deployment does not proceed
    12.  
      Resolving an issue of failed probes
    13.  
      Resolving token issues
    14.  
      Resolving an issue related to insufficient storage
    15.  
      Resolving an issue related to invalid nodepool
    16.  
      Resolving a token expiry issue
    17.  
      Resolve an issue related to KMS database
    18.  
      Resolve an issue related to pulling an image from the container registry
    19.  
      Resolving an issue related to recovery of data
    20.  
      Check primary server status
    21.  
      Pod status field shows as pending
    22.  
      Ensure that the container is running the patched image
    23.  
      Getting EEB information from an image, a running container, or persistent data
    24.  
      Resolving the certificate error issue in NetBackup operator pod logs
    25.  
      Resolving the primary server connection issue
    26.  
      Primary pod is in pending state for a long duration
    27.  
      Host mapping conflict in NetBackup
    28.  
      NetBackup messaging queue broker take more time to start
    29.  
      Local connection is getting treated as insecure connection
    30.  
      Issue with capacity licensing reporting which takes longer time
    31.  
      Backing up data from Primary server's /mnt/nbdata/ directory fails with primary server as a client
    32.  
      Wrong EFS ID is provided in environment.yaml file
    33.  
      Primary pod is in ContainerCreating state
    34.  
      Webhook displays an error for PV not found
  20. Appendix A. CR template
    1.  
      Secret
    2.  
      MSDP Scaleout CR

Migration and updating of Snapshot Manager

Migrating Snapshot Manager

Users can manually migrate Snapshot Manager registered with NetBackup to Kubernetes Service cluster environment by performing the following steps:

  1. Disable Snapshot Manager from NetBackup.

  2. Stop services on the Snapshot Manager VM.

  3. Create and attach a volume to the Snapshot Manager VM:

    • Create a new volume from AWS cloud console in the same region where nodegroup of NetBackup is there.

      Note:

      Copy and save the volume ID which would be used later.

    • Attach the volume to Snapshot Manager VM. Create a file system and mount the volume:.

      For example,

      mkdir /mnt/test/
      
      mkfs.ext4 /dev/xvdg
      
      mount /dev/xvdg /mnt/test/
      
      mount | grep xvdg
    • To check the mount point, use the following command:

      df -h

    • Copy the contents from /cloudpoint/mongodb to the new volume.

      For example, cp -r /cloudpoint/mongodb/* /mnt/test/

    • Copy flexsnap.conf and bp.conf configuration files to the VM from where cluster is accessible.

    • Unmount and detach the volume from VM as follows:

      • To unmount: umount /mnt/test/

      • To detach navigate to the console and detach.

  4. From Cluster Access VM perform the following steps:

    • Create configuration maps using the following command:

      kubectl create cm --from-file=<path to flexsnap.conf > -n <environment namespace>

      kubectl create cm nbuconf --from-file=<path to bp.conf>  -n <environment namespace>

    • Create Snapshot Manager credential Secret using the following command:

      kubectl create secret generic cp-creds --from-literal=username='<username>' --from-literal=password='<password>' -n <environment-namespace>

    • Create static PV and PVCs using the volume.

    • Create StorageClass volume for EBS:

      apiVersion: storage.k8s.io/v1
      kind: StorageClass
      metadata:
        name: gp2-reclaim
      parameters:
        fsType: ext4
        type: gp2
      provisioner: kubernetes.io/aws-ebs
      reclaimPolicy: Retain
      allowVolumeExpansion: true
      volumeBindingMode: WaitForFirstConsumer
    • Create StorageClass volume for EFS:

      kind: StorageClass
      apiVersion: storage.k8s.io/v1
      metadata:
        name: efs-sc
      provisioner: efs.csi.aws.com
      parameters:
        provisioningMode: efs-ap
        fileSystemId: <EFS ID>
        directoryPerms: "700"
      reclaimPolicy: Retain
      volumeBindingMode: Immediate

      Note:

      It is recommended to use a separate EFS for Snapshot Manager deployment and primary server catalog.

    • Create mongodb Persistent Volume and Persistent Volume Claim as follows:

      mongodb_pv.yaml: 
       
      apiVersion: v1
      kind: PersistentVolume
      metadata:
        name: mongodb-pv  <pv name>
      spec:
        capacity:
          storage: 30Gi
        accessModes:
          - ReadWriteOnce
        awsElasticBlockStore:
          volumeID: aws://us-east-2a/vol-00de395edff9fa8fb  <need to give in this format aws://region/volumeID >
          fsType: ext4
        persistentVolumeReclaimPolicy: Retain
        storageClassName: gp2-reclaim  <storageclass name>
        volumeMode: Filesystem
        claimRef:
          apiVersion: v1
          kind: PersistentVolumeClaim
          name: <PVC name>
          namespace: <netbackup-environment>  
       
      mongodb-pvc.yaml: 
      kind: PersistentVolumeClaim
      apiVersion: v1
      metadata:
        name: mongodb-pvc
        namespace: <netbackup-environment>
      spec:
        accessModes:
          - ReadWriteOnce
        storageClassName: gp2-reclaim <Storage class name>
        resources:
          requests:
            storage: 30Gi
        volumeName: mongodb-pv <PV name> 
      

      For more information, refer to Leveraging AWS EBS for Kubernetes Persistent Volumes.

    • Create mongodb Persistent Volume and Persistent Volume Claim by applying the above yamls file as follows:

      kubectl apply -f <path_to_mongodb_pv.yaml>
      
      kubectl apply -f <path_to_mongodb_pvc.yaml> -n <environment-namespace>
    • Ensure that the newly created PVC is bound to the PV.

      For example, kubectl get pvc -n <netbackup-environment> | grep mongodb

  5. Edit the environment.yaml file to upgrade NetBackup (primary/media/MSDP) and add section for Snapshot Manager as follows in the environment.yaml file:

    cpServer:
      - name: cp-cluster-deployment
        tag: <version>
        containerRegistry: <container registry
        credential:
          secretName: cp-creds
        networkLoadBalancer:
          annotations:
            ipAddr: <IP address>
            fqdn: <FQDN>
        storage:
          log:
            capacity: <log size>
            storageClassName: <EFS based storage class>
          data:
            capacity: <mongodb PV size>
            storageClassName: <mongodb PV storage class>
        nodeSelector:
          #controlPlane:
            #nodepool: <Control node pool>
            #labelKey: <Control node label key>
            #labelValue: <Control node label value>
          dataPlane:
            nodepool: <Data node pool>
            labelKey: <Data node label key>
            labelValue: <Data node label value> 
    
  6. Apply the environment.yaml file using the following command:

    kubectl apply -f <path to environment.yaml> -n <environment-namespace>

  7. Re-register the Snapshot Manger from WebUI using the edit option of existing Snapshot Manager entry and provide reissue token if the Snapshot Manager name (fqdn/ip) is same as VM deployment. For more information on reissuing the token, refer to the following section:

    “Reissue token”

    Note:

    Automatic cloud provider additions would be skipped, if there was any AWS plugin addition present pre-migration. User can manually add the cloud with specific region if needed. Ensure that cluster region is configured with the plugin, as it is required to obtain the cluster details and correctly calculate the capability of Snapshot Manager.

After migration, duplicate plug-in entries might be displayed in the NetBackup Web UI. Manually delete these duplicated plugin information from the /usr/openv/var/global/CloudPoint_plugin.conf file.

Updating Snapshot Manager

User can update few parameters on the existing deployed Snapshot Manager by making changes in the cpServer section of environment.yaml file and apply it.

Only data size field can be changed in cpServer section of CR. For update operation to work, set the value of allowVolumeExpansion parameter to true in the storage classes used.

The following table lists the parameters that can be modified during update of Snapshot Manager:

Parameters

Edit during update

Edit during upgrade

name

No

No

tag

No

Yes

containerRegistry

No

Yes

credential: secretName

No

No

networkLoadBalancer: annotations

No

Yes

networkLoadBalancer: fqdn

No

No

networkLoadBalancer: ipAddr

No

Yes

data.capacity

Yes

Yes

data.storageClassName

No

No

cpServer.NodeSelector.ControlPlane

No

Yes

cpServer.NodeSelector.DataPlane

No

Yes

proxySettings: vx_http_proxy

No

Yes

proxySettings: vx_https_proxy

No

Yes

proxySettings: vx_no_proxy

No

Yes