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

Last Published:
Product(s): NetBackup & Alta Data Protection (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 NetBackup and MSDP Scaleout manually

After the operators are deployed, you can deploy the NetBackup and MSDP Scaleout environment.

To deploy NetBackup primary, media, and MSDP Scaleout components:

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

    kubectl create namespace nb-example

    Where, nb-example is the name of the namespace. The Primary, Media, and MSDP Scaleout 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 primary server credentials. Those credentials are configured in the NetBackup primary server, and other resources in the NetBackup environment use them to communicate with and configure the primary server. 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
           kind: Secret
           metadata:
             name: primary-credentials
             namespace: nb-example
           type: kubernetes.io/basic-auth
           stringData:
             username: nbuser
             password: p@ssw0rd

    You can also use this command to create a secret.

    $ kubectl create secret generic primary-credentials --namespace nb-example --from-literal=username='nbuser' --from-literal=password='p@ssw0rd'

  3. Create a KMS DB secret to hold Host Master Key ID (`HMKID`), Host Master Key passphrase (`HMKpassphrase`), Key Protection Key ID (`KPKID`), and Key Protection Key passphrase (`KPKpassphrase`) for NetBackup Key Management Service. If creating the secret by YAML, the type should be _opaque_. For example:
     apiVersion: v1
           kind: Secret
           metadata:
             name: example-key-secret
             namespace: nb-example
           type: Opaque
           stringData:
             HMKID: HMKID
             HMKpassphrase: HMKpassphrase
             KPKID: KPKID
             KPKpassphrase: KPKpassphrase

    You can also create a secret using kubectl from the command line:

    $ kubectl create secret generic example-key-secret --namespace nb-namespace --from-literal=HMKID="HMKID" --from-literal=HMKpassphrase="HMKpassphrase" --from-literal=KPKID="KPKID" --from-literal=KPKpassphrase="KPKpassphrase"

    For more details on NetBackup deduplication engine credential rules, see: https://www.veritas.com/content/support/en_US/article.100048511

  4. Create a secret to hold the MSDP Scaleout credentials for the storage server. The secret must include fields for `username` and `password` and must be located in the same namespace as the Environment resource. If creating the secret by YAML, the type should be _opaque_ or _basic-auth_. For example:
    apiVersion: v1
           kind: Secret
           metadata:
             name: msdp-secret1
             namespace: nb-example
           type: kubernetes.io/basic-auth
           stringData:
             username: nbuser
             password: p@ssw0rd

    You can also create a secret using kubectl from the command line:

    $ kubectl create secret generic msdp-secret1 --namespace nb-example --from-literal=username='nbuser' --from-literal=password='p@ssw0rd'

    Note:

    You can use the same secret for the primary server credentials (from step 2) and the MSDP Scaleout credentials, so the following step is optional. However, to use the primary server secret in an MSDP Scaleout, you must set the `credential.autoDelete` property to false. The sample file includes an example of setting the property. The default value is true, in which case the secret may be deleted before all parts of the environment have finished using it.

  5. (Optional) Create a secret to hold the KMS key details. Specify KMS Key only if the KMS Key Group does not already exist and you need to create.

    Note:

    When reusing storage from previous deployment, the KMS Key Group and KMS Key may already exist. In this case, provide KMS Key Group only.

    If creating the secret by YAML, the type should be _opaque_. For example:

    apiVersion: v1
           kind: Secret
           metadata:
             name: example-key-secret
             namespace: nb-example
           type: Opaque
           stringData:
             username: nbuser
             passphrase: 'test passphrase'

    You can also create a secret using kubectl from the command line:

    $ kubectl create secret generic example-key-secret --namespace nb-example --from-literal=username="nbuser" --from-literal=passphrase="test passphrase"

    You may need this key for future data recovery. After you have successfully deployed and saved the key details. It is recommended that you delete this secret and the corresponding key info secret.

  6. Configure the samples/environment.yaml file according to your requirements. This file defines a primary server, media servers, and scale out MSDP Scaleout storage servers. See Configuring the environment.yaml file. for details.
  7. Apply the environment yaml file, using the same application namespace created in step 1.

    $ 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

    The output should look like:

    NAME                 AGE
    environment-sample   2m

    After a few minutes, NetBackup finishes starting up on the primary server, and then the media servers and MSDP Scaleout storage servers you configured in the environment resource start appearing. Run:

    $ kubectl get --namespace nb-example all,environments,primaryservers,mediaservers,msdpscaleouts

    The output should show:

    • All pod status as Ready and Running

      NAME                        READY   STATUS    
      pod/dedupe1-uss-controller- 1/1     Running  
      pod/dedupe1-uss-mds-1       1/1     Running   
    • For msdpscaleout SIZE = READY, for example: 4=4.

      NAME                                     SIZE   READY
      msdpscaleout.msdp.veritas.com/dedupe1     4      4
    • environment.netbackup should show STATUS as Success

      NAME                                                   STATUS
      environment.netbackup.veritas.com/environment-sample   Success
  8. To start using your newly deployed environment sign-in to NetBackup web UI. Open a web browser and navigate to https://<primaryserver>/webui/login URL.

    The primary server is the host name or IP address of the NetBackup primary server.

    You can retrieve the primary server's hostname by using the command:

    $ kubectl describe primaryserver.netbackup.veritas.com/<primary server CR name>--namespace <namespace_name>

Refer to Deploying MSDP Scaleout from the guide NetBackup™ Deployment Guide for Amazon Elastic Kubernetes Services (EKS) Cluster