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

Procedure to rollback when upgrade fails

Note:

The rollback procedure in this section can be performed only after assuming that the customer has taken catalog backup before performing the upgrade.

Perform the following steps to rollback from upgrade failure and install the NetBackup version prior to upgrade

  1. Delete the environment CR object using the following command and wait until all the underlying resources are cleaned up:

    kubectl delete environment.netbackup.veritas.com <environment name> -n <namespace>

    For example, primary server CR, media server CR, MSDP CR and their underlined resources.

  2. Delete the new operator which is deployed during upgrade using the following command:

    kubectl delete -k <new-operator-directory>

    This will delete the new operator and new CRDs.

  3. Apply the NetBackup operator directory which was preserved (the directory which was used to install operator before upgrade) using the following command:

    kubectl apply -k <operator_directory>

  4. Get names of PV attached to primary server PVC (data, catalog and log) using the following command:

    kubectl get pvc -n <namespace> -o wide

  5. Delete the primary server PVC (data, catalog and log) using the following command:

    kubectl delete pvc <pvc-name> -n <namespace>

  6. Delete the PV linked to primary server PVC using the following command:

    kubectl delete pv <pv-name> command

  7. Edit the preserved environment.yaml file (from older version of NetBackup package directory) and remove keySecret section from MSDP Scaleout section. Also change the CR spec paused: false to paused: true for every object in MSDP Scaleout and media servers section.
  8. Apply the edited environment.yaml file using the following command:

    kubectl apply -f <environment.yaml>

  9. After the primary server pod is in ready state (1/1), change the CR spec from paused: false to paused: true in environment.yaml file of the primary server section and reapply the environment.yaml using the following command:

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

  10. Exec into the primary server pod using the following command:

    kubectl exec -it -n <PrimaryServer/MediaServer-CR-namespace> <primary-pod-name> -- /bin/bash

    • Increase the debug logs level on primary server.

    • Create a DRPackages directory at the persisted location using mkdir /mnt/nblogs/DRPackages folder.

    • Change ownership of the DRPackages folder to service user using the following command:

      chown nbsvcusr:nbsvcusr /mnt/nblogs/DRPackages

  11. Copy the earlier copied DR files to primary pod at /mnt/nblogs/DRPackages using the following command:

    kubectl cp <Path_of_DRPackages_on_host_machine> <primary-pod-namespace>/<primary-pod-name>:/mnt/nblogs/DRPackages

  12. Execute the following steps in the primary server pod:
    • Change ownership of the files in /mnt/nblogs/DRPackages using the following command:

      chown nbsvcusr:nbsvcusr <filename>

    • Deactivate NetBackup health probes using the following command:

      /opt/veritas/vxapp-manage/nbu-health deactivate

    • Stop the NetBackup services using the following command:

      /usr/openv/netbackup/bin/bp.kill_all

    • Execute the following command:

      nbhostidentity -import -infile /mnt/nblogs/DRPackages/<filename>.drpkg

    • Restart all the NetBackup services using the following command:

      /usr/openv/netbackup/bin/bp.start

  13. Verify if the security settings are enabled.
  14. Add respective media server entry in host properties using NetBackupAdministration Console as follows:

    Navigate to NetBackup Management > Host properties > Master Server > Add Additional server and add media server.

  15. Restart the NetBackup services in primary server pod and external media server as follows:
    • Exec into the primary server pod using command:

      kubectl exec -it -n <PrimaryServer/MediaServer-CR-namespace> <primary-pod-name> -- /bin/bash

    • Run the following command to stop all the services:

      /usr/openv/netbackup/bin/bp.kill_all

      After stopping all the services, restart the services using the following command:

      /usr/openv/netbackup/bin/bp.start_all

    • Run the following command to stop all the NetBackup services:

      /usr/openv/netbackup/bin/bp.kill_all

      After stopping all the services, restart the NetBackup services using the following command:

      /usr/openv/netbackup/bin/bp.start_all

  16. Configure a storage unit on external media server that is used during catalog backup.
  17. Perform catalog recovery from NetBackup Administration Console.

    For more information, refer to the VeritasTM NetBackup Troubleshooting Guide

  18. Exec into the primary server pod using the following command:

    kubectl exec -it -n <PrimaryServer/MediaServer-CR-namespace> <primary-pod-name> -- /bin/bash

    • Stop the NetBackup services using the following command:

      /usr/openv/netbackup/bin/bp.kill_all

    • Start the NetBackup services using the following command:

      /usr/openv/netbackup/bin/bp.start_all

    • Activate NetBackup health probes using the following command:

      /opt/veritas/vxapp-manage/nbu-health activate

  19. Restart the NetBackup operator pod, where user must delete the pod using the following command:

    kuebctl delete <operator-pod-name> -n <namespace>

    Kubernetes will start new pod after deletion.

  20. Pause the reconciler for primary, media servers, and msdp scaleouts in the following sequence:
    • Change CR spec paused: true to paused: false in environment.yaml file of the primary section and re-apply environment.yaml file using the following command:

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

      Wait till primary server is in ready state.

    • Change CR spec paused: true to paused: false in environment.yaml file of the msdp scaleouts section and re-apply environment.yaml file using the following command:

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

      Wait till primary server is in ready state.

    • Change CR spec paused: true to paused: false in environment.yaml file of the media servers section and re-apply environment.yaml file using the following command:

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

      Wait till primary server is in ready state.

  21. Verify the rollback is successful by performing backups and recovery jobs.