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

Ensure that the container is running the patched image

There are three copies of the container image present in the Kubernetes environment during deployment or patching.

The first image copy is created on a local docker instance during image load operation. To check this copy, perform the following:

  1. Run:

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

    Sample output:

    Loaded image: msdp-operator:17.0
  2. Taking the image name from step 1, run:

    $ docker image ls | grep msdp-operator

    Sample output:

    msdp-operator 17.0 353d2bd50105 2 days ago 480 MB
  3. Taking the value from step 2, run:

    $ docker inspect 353d2bd50105 | jq .[].Id

    "sha256:353d2bd50105cbc3c61540e10cf32a152432d5173bb6318b8e"

The second copy is created in Amazon Elastic Container Registry (ECR). To check this copy, perform the following:

  1. Keep the image name and version same as original, run:

    $ docker image tag msdp-operator:17.0 046777922665.dkr.ecr.us-east-2.amazonaws.com/nbuxeksdeploy.aws.io/msdp-operator:17.0

  2. Run:

    $ docker image ls | grep msdp-operator

    Sample output:

    msdp-operator  17.0 353d2bd50105 2 days ago 480 MB
      msdp-operator            17.0 046777922665.dkr.ecr.us-east-2.
    amazonaws.com/nbuxeksdeploy.aws.io/msdp-operator 
    17.0 353d2bd50105 2 days ago 480 MB /msdp-operator 17.0 
    353d2bd50105 2 days ago 480 MB 
  3. To push the image to the registry, run:

    $ docker push testregistry.<account id>.dkr.ecr.<region>.amazonaws.com/<registry>:<tag>.io/msdp-operator

    The push refers to a repository [046777922665.dkr.ecr.us-east-2.amazonaws.com/nbuxeksdeploy.aws.io/msdp-operator]

    0a504041c925: Layer already exists

    17.0: digest: 
    sha256:d294f260813599562eb5ace9e0acd91d61b7dbc53c3 size:
     2622 
  4. To verify local image digest after the push operation, run:

    $ docker inspect 353d2bd50105 | jq .[].RepoDigests

    Sample output:

    [
       "testregistry.<account id>.dkr.ecr.<region>.amazonaws.com/<registry>:<tag>.io/
    msdp-operator@sha256: d294f260813599562eb5ace9e0acd91d61b7dbc53c3"
     ]
  5. To verify image presence in the registry, run:

    $ aws ecr describe-repositories --repository-names "veritas/main_test1"

    Sample output:

     "repositories": [
            {
                "repositoryArn": "arn:aws:ecr:us-east-2:046777922665:
    repository/veritas/main_test1",
                "registryId": "046777922665",
                "repositoryName": "veritas/main_test1",
                "repositoryUri": "046777922665.dkr.ecr.us-east-2.
    amazonaws.com/veritas/main_test1",
                "createdAt": "2022-04-13T07:27:52+00:00",
                "imageTagMutability": "MUTABLE",
                "imageScanningConfiguration": {
                    "scanOnPush": false
                },
                "encryptionConfiguration": {
                    "encryptionType": "AES256"
                }
            }
        ]
  6. To verify image digest in registry, run:

    $ aws ecr describe-images --registry-id 046777922665 --repository-name "veritas/main_test1" --image-ids imageTag=latestTest5

    Sample output:

    "imageDetails": [
            {
                "registryId": "046777922665",
                "repositoryName": "veritas/main_test1",
                "imageDigest": 
    "sha256:d0095074286a50c6bca3daeddbaf264cf4006a92fa3a074daa4739cc995b36f8",
                "imageTags": [
                    "latestTest5"
                ],
                "imageSizeInBytes": 38995046,
                "imagePushedAt": "2022-04-13T15:56:07+00:00",
                "imageManifestMediaType": "application/vnd.docker.
    distribution.manifest.v2+json",
                "artifactMediaType": "application/vnd.docker.container.image.v1+json"
            }
        ]

The third copy is located on a Kubernetes node running the container after it is pulled from the registry. To check this copy, do the following:

  1. Run;

    $ kubectl get nodes -o wide

    NAME           STATUS  VERSION   INTERNAL-IP   OS-IMAGE             
    eks-agentpool-7601-vmss000 Ready  v1.21.7 10.240.0.4 Ubuntu 18.04.6 LTS   
  2. Use kubectl debug to run a container on the node:

    $ kubectl debug node/eks-nodepool1-7601-vmss000-it --image=mcr.microsoft.com/eks/fundamental/base-ubuntu:v0.0.11 root@eks-agentpool-7601-vmss000:/#

  3. You can interact with the node session from the privileged container:

    chroot /host

  4. Verify the presence of the image:

    /usr/local/bin/crictl image | grep msdp

    Sample output:

    <account id>.dkr.ecr.<region>.amazonaws.com/msdp-operator  17.0  353d2bd50105c  182MB
  5. Verify the image ID on the Kubernetes node, run:

    /usr/local/bin/crictl inspecti 353d2bd50105c | jq .[].id

    Sample output

    "sha256:353d2bd50105cbc3c61540e10cf32a152432d5173bb6318b8e"
    null
  6. Verify the image digest on the Kubernetes node, run:

    /usr/local/bin/crictl inspecti 353d2bd50105c | jq .[].repoDigests

    Sample output

    [
      "<account id>.dkr.ecr.<region>.amazonaws.com/msdp-operator@sha256:
    d294f260813599562eb5ace9e0acd91d61b7dbc53c3"
    ]
    null
How to make sure that you are running the correct image

Use the steps given above to identify image ID and Digest and compare with values obtained from the registry and the Kubernetes node running the container.

Note:

MSDP Scaleout images (uss-engine, uss-mds, uss-controller, msdp-operator) use IfNotPresent imagePullPolicy. A unique image tag is required in order for a Kubernetes node to pull an updated image.