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

Last Published:
Product(s): NetBackup (10.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.  
      Configuring the environment.yaml file
    5.  
      Uninstalling NetBackup environment and the operators
    6.  
      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 during data migration
    5.  
      Procedure to rollback when upgrade fails
  6. 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
  7. Upgrading MSDP Scaleout
    1.  
      Upgrading MSDP Scaleout
  8. 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
  9. 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
  10. 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
  11. Performing catalog backup and recovery
    1.  
      Backing up a catalog
    2.  
      Restoring a catalog
  12. 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
  13. 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
  14. Uninstalling MSDP Scaleout from EKS
    1.  
      Cleaning up MSDP Scaleout
    2.  
      Cleaning up the MSDP Scaleout operator
  15. 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
  16. Appendix A. CR template
    1.  
      Secret
    2.  
      MSDP Scaleout CR

Deploying the operators manually

To perform these steps, log on to the Linux workstation or VM where you have extracted the TAR file.

To deploy the operators

  1. Install the MSDP kubectl plug-in at some location which is set in the path environment variable of your shell. For example, copy the file kubectl-msdp to/usr/local/bin/.
  2. Run the following commands to load each of the product images to the local docker instance.

    $ docker load -i netbackup-main-10.1.tar.gz

    $ docker load -i netbackup-operator-10.1.tar.gz

    $ docker load -i pdcluster-17.0.tar.gz

    $ docker load -i pdde-17.0.tar.gz

    $ docker load -i pdk8soptr-17.0.tar.gz

    Run the command docker image ls to confirm that the product images are loaded properly to the docker cache.

  3. Run the following commands to re-tag the images to associate them with your container registry, keep the image name and version same as original:

    $ REGISTRY=<<AccountID>.dkr.ecr.<zone>.amazonaws.com/<registryName>>

    $ docker tag netbackup/main:10.1 ${REGISTRY}/netbackup/main:10.1

    $ docker tag netbackup/operator:10.1 ${REGISTRY}/netbackup/operator:10.1

    $ docker tag uss-engine:17.0 ${REGISTRY}/uss-engine:17.0

    $ docker tag uss-controller:17.0 ${REGISTRY}/uss-controller:17.0

    $ docker tag uss-mds:17.0 ${REGISTRY}/uss-mds:17.0

    $ docker tag msdp-operator:17.0 ${REGISTRY}/msdp-operator:17.0

  4. Run the following commands to push the images to the container registry.

    $ docker push ${REGISTRY}/netbackup/main:10.1

    $ docker push ${REGISTRY}/netbackup/operator:10.1

    $ docker push ${REGISTRY}/uss-engine:17.0

    $ docker push ${REGISTRY}/uss-controller:17.0

    $ docker push ${REGISTRY}/uss-mds:17.0

    $ docker push ${REGISTRY}/msdp-operator:17.0

  5. Create a namespace for deploying the NetBackup and MSDP Scaleout operators. These instructions use the default netbackup-operator-system namespace but a custom namespace is also supported, run:

    $ kubectl create namespace netbackup-operator-system

  6. Install the MSDP Scaleout operator in the created namespace, using this command. To run this command you must define a full image name in step 3, define a storage class for storing logs from the MSDP operator, and define node selector labels (optional) for scheduling the MSDP operator pod on specific nodes. See Prerequisites.

    $ kubectl msdp init --image ${REGISTRY}/msdp-operator:17.0 --storageclass x --namespace netbackup-operator-system -l key1=value1

  7. To verify that the MSDP Scaleout operator is running, run:

    $ kubectl get all --namespace netbackup-operator-system

    Here, we are using the namespace created in step 5.

    The msdp-operator pod should show status as Running.

  8. In this step, configure the namespace, image name, and node selector to use for the NetBackup operator image by editing the provided configuration yaml files.
    • (Optional) Perform this step only when using a custom namespace. Edit the file operator/kustomization.yaml and change `namespace` to your custom namespace. For example: namespace: my-custom-namespace

    • Edit the file operator/kustomization.yaml and change newName and newTag. For example:

        images:
             - name: netbackupoperator
               newName: example.com/netbackup/operator
               newTag: '10.1'
    • Edit the operator/patches/operator_patch.yaml file to add or remove node selectors and toleration that control what nodes Kubernetes may schedule the operator to run on. Use the key value pair same as given during node group creation. For example:

      nodeSelector:
          nbpool: nbnodes
      			# Support node taints by adding pod tolerations equal to the 
      specified nodeSelectors
      			# For Toleartion NODE_SELECTOR_KEY used as a key and 
      NODE_SELECTOR_VALUE as a value.
      tolerations:
          - key: nbpool
            operator: "Equal"
            value: nbnodes
      
  9. To install the NetBackup and Snapshot Manager operator, run the following command from the installer's root directory:

    $ kubectl apply -k operator

  10. To verify if the operators are running, run:

    $ kubectl get all --namespace netbackup-operator-system

    Verify that pod/netbackup-operator and pod/flexsnap-operator STATUS is showing as Running.