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

Deploying NetBackup and Snapshot Manager manually

After the operators are deployed as mentioned in the following section, you can deploy the NetBackup and Snapshot Manager environment:

To deploy NetBackup primary, media and Snapshot Manager components

  1. Create a Kubernetes namespace where your new NetBackup environment will run. Run the following command:

    kubectl create namespace nb-example

    Where, nb-example is the name of the namespace. The Primary, Media, and Snapshot Manager application namespace must be different from the one used by the operators. It is recommended to use two namespaces. One for the operators, and a second one for the applications.

  2. Create a secret to hold the Snapshot Manager credentials. The secret must include fields for username and password. If you are creating the secret by YAML, the type should be opaque or basic-auth.

    For example:

    apiVersion: v1
    stringData:
      password: p@ssw0rd
      username: cpuser
    kind: Secret
    metadata:  
      name: cp-creds
      namespace: ns-155
    type: Opaque
    

    You can also use this command to create a secret.

    kubectl create secret generic cp-credentials --namespace nb-example --from-literal=username='cpuser' --from-literal=password='p@ssw0rd'

  3. Configure the samples/environment.yaml file according to your requirements. This file defines a primary server, media servers, and Snapshot Manager servers.See Configuring the environment.yaml file. for details.
  4. Apply the environment.yaml file, using the same application namespace created in the above step.

    kubectl apply --namespace nb-example --filename environment.yaml

    Use this command to verify the new environment resource in your cluster:

    kubectl get --namespace nb-example environments

    After a few minutes, NetBackup finishes starting up the primary server, media servers and Snapshot Manager servers in the sequence that you configured in the environment resource. Snapshot Manager is registered with NetBackup and cloud provider is configured automatically.

    Run the following command:

    kubectl get --namespace netbackup-environment all,environments,primaryservers,cpservers,mediaservers

    The output would be displayed as follows:

    $ kubectl get all,environments,primaryservers,mediaservers,
    cpservers,msdpscaleouts -n netbackup-environment
    NAME                                               READY   STATUS    RESTARTS   AGE
    pod/flexsnap-agent
    -33e649abd383410ea618751f7b2eb8ae-598b8b747-957xd   1/1     Running   0          28m
    pod/flexsnap-agent
    -688d478bc8-hxgrk                                   1/1     Running   0          43m
    pod/flexsnap-api-gateway
    -69cbbfc844-f6whb                                   1/1     Running   0          43m
    pod/flexsnap-certauth
    -6f65894b69-njfhf                                   1/1     Running   0          44m
    pod/flexsnap-coordinator
    -749649c7-fgs4t                                     1/1     Running   0          43m
    pod/flexsnap-fluentd-collector
    -7445f6fb9f-bqfqg                                   1/1     Running   0          43m
    pod/flexsnap-fluentd-csvfz                          1/1     Running   0          43m
    pod/flexsnap-fluentd-ht7w8                          1/1     Running   0          43m
    pod/flexsnap-fluentd-lkdgt                          1/1     Running   0          43m
    pod/flexsnap-fluentd-rzvrv                          1/1     Running   0          43m
    pod/flexsnap-fluentd-spgkc                          1/1     Running   0          43m
    pod/flexsnap-listener-664674-phjnd                  1/1     Running   0          43m
    pod/flexsnap-mongodb-f6b744df5-p4hfv                1/1     Running   0          43m
    pod/flexsnap-nginx-8647f57db8-rzkt5                 1/1     Running   0          43m
    pod/flexsnap-notification-7db95868f5-dpx7z          1/1     Running   0          43m
    pod/flexsnap-rabbitmq-0                             1/1     Running   0          43m
    pod/flexsnap-scheduler-68d8b75d75-5q4fk             1/1     Running   0          43m
    pod/nbux-marketplace-10-239-207-44.
    vxindia.veritas.com                                 1/1     Running   0          72m
    pod/nbux-marketplace-10-239-207-45.
    vxindia.veritas.com                                 2/2     Running   0          68m
    pod/nbux-marketplace-10-239-207-46.
    vxindia.veritas.com                                 2/2     Running   0          64m
    pod/nbux-marketplace-10-239-207-47.
    vxindia.veritas.com                                 2/2     Running   0          60m
    pod/nbux-eks-dedupe1-uss-agent-56r7h                1/1     Running   0          73m
    pod/nbux-eks-dedupe1-uss-agent-hvfw7                1/1     Running   0          73m
    pod/nbux-eks-dedupe1-uss-agent-jx46x                1/1     Running   0          73m
    pod/nbux-eks-dedupe1-uss-agent-pz7w8                1/1     Running   0          73m
    pod/nbux-eks-dedupe1-uss-agent-r2kkt                1/1     Running   0          73m
    pod/nbux-eks-dedupe1-uss-agent-vx8gc                1/1     Running   0          73m
    pod/nbux-eks-dedupe1-uss-controller-0               1/1     Running   0          73m
    pod/nbux-eks-dedupe1-uss-controller-1               1/1     Running   0          72m
    pod/nbux-eks-dedupe1-uss-mds-1                      1/1     Running   0          75m
    pod/nbux-eks-dedupe1-uss-mds-2                      1/1     Running   0          74m
    pod/nbux-eks-dedupe1-uss-mds-3                      1/1     Running   0          73m
    pod/nbux-eks-media1-media-0                         1/1     Running   0          55m
    pod/nbux-eks-primary-0                              1/1     Running   0          101m
    
    NAME                               TYPE           CLUSTER-IP     EXTERNAL-IP   PORT(S)                                                                                                                                                                                            AGE
    service/flexsnap-api-gateway      ClusterIP      172.20.92.70     <none>      8472/TCP                                                                                                                                                                                           43m
    service/flexsnap-certauth         ClusterIP      172.20.222.22    <none>      9000/TCP                                                                                                                                                                                           43m
    service/flexsnap-fluentd-service  ClusterIP      172.20.141.61    <none>      24224/TCP                                                                                                                                                                                          43m
    service/flexsnap-mongodb          ClusterIP      172.20.157.102   <none>      27017/TCP                                                                                                                                                                                          43m
    service/flexsnap-nginx            LoadBalancer   172.20.187.1   
                            nbux-eks-cpserver-1-2b677a3f6b6ffe48.elb.us-west-2.amazonaws.com  
                                                                443:31318/TCP,5671:31902/TCP                                                                                                                                                                       43m
    service/flexsnap-rabbitmq         ClusterIP      172.20.33.99     <none>      5671/TCP                                                                                                                                                                                           43m
    service/ip-10-239-207-44-host-nbux-marketplace-10-239-207-44-vxindia-ve   
    LoadBalancer   172.20.186.216   k8s-ns155-ip102392-8d0152d6a0-8d77c9a84d1dd6a0.
    elb.us-west-2.amazonaws.com   10082:30397/TCP,10102:31873/TCP,10086:32374/TCP,
    443:30732/TCP,111:30721/TCP,662:32206/TCP,875:32361/TCP,892:31540/TCP,2049:30676/TCP,
    45209:31944/TCP,58329:30149/TCP,139:31587/TCP,445:31252/TCP   73m
    service/ip-10-239-207-45-host-nbux-marketplace-10-239-207-45-vxindia-ve   
    LoadBalancer   172.20.23.36     k8s-ns155-ip102392-410db5113c-791da4601d58039f.
    elb.us-west-2.amazonaws.com   10082:31116/TCP,10102:31904/TCP,10086:32468/TCP,
    443:32693/TCP,111:32658/TCP,662:31151/TCP,875:30175/TCP,892:
    31126/TCP,2049:31632/TCP,45209:32602/TCP,58329:31082/TCP,139:31800/TCP,445:30795/TCP 
      73m
    service/ip-10-239-207-46-host-nbux-marketplace-10-239-207-46-vxindia-ve   
    LoadBalancer   172.20.6.179     k8s-ns155-ip102392-1c160eed54-c975ee450ede1c20.
    elb.us-west-2.amazonaws.com   10082:31927/TCP,10102:31309/TCP,10086:30285/TCP,
    443:32648/TCP,111:32348/TCP,662:32170/TCP,875:31854/TCP,892:30842/TCP,2049:31357/TCP,
    45209:30002/TCP,58329:32408/TCP,139:30882/TCP,445:32017/TCP   73m
    service/ip-10-239-207-47-host-nbux-marketplace-10-239-207-47-vxindia-ve   
    LoadBalancer   172.20.221.124   k8s-ns155-ip102392-bb1f5b1cbe-22e4275c1af33239.
    elb.us-west-2.amazonaws.com   10082:30137/TCP,10102:30727/TCP,10086:32649/TCP,
    443:30474/TCP,111:32690/TCP,662:31740/TCP,875:30437/TCP,892:32532/TCP,2049:32641/TCP,
    45209:31259/TCP,58329:31070/TCP,139:32393/TCP,445:30296/TCP   73m
    service/nbux-eks
    -dedupe1-uss-controller     ClusterIP      172.20.197.231   <none>     10100/TCP                                                                                                                                                                                          74m
    service/nbux-eks
    -dedupe1-uss-mds            ClusterIP      None             <none>     2379/TCP,2380/TCP                                                                                                                                                                                  75m
    service/nbux-eks
    -dedupe1-uss-mds-client     ClusterIP      172.20.226.45    <none>     2379/TCP                                                                                                                                                                                           75m
    service/nbux-eks
    -media1-media-0             LoadBalancer   172.20.146.140   
    nbux-eks-media1-media-0-1a525c3f2587c8cf.elb.us-west-2.amazonaws.com  
                                                              13782:31414/TCP,1556:31562/TCP                                                                                                                                                                     56m
    service/nbux-eks-primary    LoadBalancer   172.20.108.104   
    nbux-eks-primary-c0f9de7ce7e231cd.elb.us-west-2.amazonaws.com   
    13781:30252/TCP,13782:31446/TCP,1556:31033/TCP,443:31517/TCP,8443:32237/
                                                                    TCP,22:30436/TCP  101m
    NAME                DESIRED  CURRENT  READY  UP-TO-DATE  AVAILABLE  NODE SELECTOR  AGE
    daemonset.apps/
    flexsnap-fluentd      5         5       5       5            5         <none>      43m
    daemonset.apps/
    nbux-eks-
    dedupe1-uss-agent     6         6       6       6            6         agentpool
                                                                           =msdpxpool  73m
    NAME                              READY   UP-TO-DATE   AVAILABLE   AGE
    deployment.apps/
    flexsnap-agent                     1/1     1            1          43m
    deployment.apps/
    flexsnap-agent-
    33e649abd383410ea618751f7b2eb8ae   1/1     1            1           28m
    deployment.apps/
    flexsnap-api-gateway               1/1     1            1           43m
    deployment.apps/
    flexsnap-certauth                  1/1     1            1           44m
    deployment.apps/
    flexsnap-coordinator               1/1     1            1           43m
    deployment.apps/
    flexsnap-fluentd-collector         1/1     1            1           43m
    deployment.apps/
    flexsnap-listener                  1/1     1            1           43m
    deployment.apps/
    flexsnap-mongodb                   1/1     1            1           43m
    deployment.apps/
    flexsnap-nginx                     1/1     1            1           43m
    deployment.apps/
    flexsnap-notification              1/1     1            1           43m
    deployment.apps/
    flexsnap-scheduler                 1/1     1            1           43m
    NAME                                     DESIRED   CURRENT    READY      AGE
    replicaset.apps/
    flexsnap-agent-
    33e649abd383410ea618751f7b2eb8ae-598b8b747   1         1         1       28m
    replicaset.apps/
    flexsnap-agent-688d478bc8                    1         1         1       43m
    replicaset.apps/
    flexsnap-api-gateway-69cbbfc844              1         1         1       43m
    replicaset.apps/
    flexsnap-certauth-6f65894b69                 1         1         1       44m
    replicaset.apps/
    flexsnap-coordinator-749649c7                1         1         1       43m
    replicaset.apps/
    flexsnap-fluentd-collector-7445f6fb9f        1         1         1       43m
    replicaset.apps/
    flexsnap-listener-664674                     1         1         1       43m
    replicaset.apps/
    flexsnap-mongodb-f6b744df5                   1         1         1       43m
    replicaset.apps/
    flexsnap-nginx-8647f57db8                    1         1         1       43m
    replicaset.apps/
    flexsnap-notification-7db95868f5             1         1         1       43m
    replicaset.apps/
    flexsnap-scheduler-68d8b75d75                1         1         1       43m
    NAME                              READY   AGE
    statefulset.apps/
    flexsnap-rabbitmq                 1/1     43m
    statefulset.apps/
    nbux-eks-dedupe1-uss-controller   2/2     73m
    statefulset.apps/
    nbux-eks-media1-media             1/1     55m
    statefulset.apps/
    nbux-eks-primary                  1/1     101m
    NAME                              READY   AGE    STATUS
    environment.netbackup.
    veritas.com/nbux-eks              4/4     102m   Success
    NAME                              TAG     AGE    STATUS
    primaryserver.netbackup.
    veritas.com/nbux-eks        10.1.1.0085   102m   Success
    NAME                             TAG        AGE    PRIMARY SERVER           STATUS
    mediaserver.netbackup.
    veritas.com/nbux-eks-media1   10.1.1.0085   56m   nbux-marketplace
                                              -10-239-207-42.vxindia.veritas.com  Success
    NAME                              TAG             AGE   STATUS
    cpserver.netbackup.
    veritas.com/nbux-eks-cpserver-1   10.1.1.0.1073   44m   Success
    NAME                              AGE   TAG         SIZE   READY
    msdpscaleout.msdp.
    veritas.com/nbux-eks-dedupe1      75m   17.1.0085    4      4