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

Allocating static PV for Primary and Media pods

When you want to use a disk with specific performance parameters, you can statically create the PV and PVC. You must allocate static PV and PVC before deploying the NetBackup server for the first time.

To allocate static PV for Media and Primary pods

  1. Create storage class in cluster.

    See How does the Config-Checker utility work.

    This newly created storage class name is used while creating PV and PVC's and should be mentioned for Catalog, Log, Data volume in the environment CR mediaServer section at the time of deployment.

    For more information on creating the storage class, see Storage class.

    For example,

    kind: StorageClass
    apiVersion: storage.k8s.io/v1
    metadata:
      name: gp2-reclaim
    provisioner: kubernetes.io/aws-ebs
    reclaimPolicy: Retain
    allowVolumeExpansion: true
    volumeBindingMode: Immediate
    parameters:
      fsType: ext4
      type: gp2
    

    For more information about the static provisioning for EFS, see Static Provisioning.

  2. Calculate number of disks required.

    The following persistent volumes are required by Media pods:

    • Data and Log volume disk per replica of media server.

    Use the following format to form PVC names.

    For primary server:

    For media server

    • data-<resourceNamePrefix_of_media>-media-<media server replica number. Count starts from 0>

    • logs-<resourceNamePrefix_of_media>-media-<media server replica number. Count starts from 0>

    Example 1

    If user wants to deploy a media server with replica count 3.

    Name of the Media PVC assuming resourceNamePrefix_of_media is testmedia.

    For this scenario, you must create total 8 disks, 8 PV and 8 PVCs.

    6 disks, 6 PV and 6 PVCs for media server.

    For data of PrimaryServer:

    For logs:

    • logs-testprimary-primary-0

    Following will be the names for media server volumes

    For data:

    • data-testmedia-media-0

    • data-testmedia-media-1

    • data-testmedia-media-2

    For log:

    • logs-testmedia-media-0

    • logs-testmedia-media-1

    • logs-testmedia-media-2

    Example 2

    If user wants to deploy a media server with replica count 5

    Names of the Media PVC assuming resourceNamePrefix_of_media is testmedia.

    For this scenario, you must create 12 disks, 12 PV and 12 PVCs

    10 disks, 10 PV and 10 PVCs for media server.

    Following will be the names for primary server volumes

    For data:

    For logs:

    Following will be the names for media server volumes

    For data:

    • data-testmedia-media-0

    • data-testmedia-media-1

    • data-testmedia-media-2

    • data-testmedia-media-3

    • data-testmedia-media-4

    For log:

    • logs-testmedia-media-0

    • logs-testmedia-media-1

    • logs-testmedia-media-2

    • logs-testmedia-media-3

    • logs-testmedia-media-4

  3. Create the required number of AWS EBS volumes and save the VolumeId of newly created volumes.

    For more information on creating EBS volumes, see EBS volumes.

    (For Primary Server volumes) Create the required number of EFS. User can use single EFS to mount catalog of primary. For example, VolumeHandle in PersistentVolume spec will be as follows:

    <file_system_id>:/catalog

  4. Create PVs for each disks.

    To create the PVs, specify the created storage class and VolumeId (ID of the EBS volumes received in step 3). The PV must be created using the claimRef field and provide PVC name for its corresponding namespace.

    For example, if you are creating PV for catalog volume, storage required is 128GB and namespace is test. PVC named catalog-testprimary-primary-0 is linked to this PV when PVC is created in the namespace test.

    apiVersion: v1
    kind: PersistentVolume
    metadata:
      name: catalog
    spec:
      accessModes:
      - ReadWriteMany
      awsElasticBlockStore:
        fsType: xfs
        volumeID: aws://us-east-2c/vol-xxxxxxxxxxxxxxxxx
      capacity:
        storage: 128Gi
      persistentVolumeReclaimPolicy: Retain
      storageClassName: gp2-retain
      volumeMode: Filesystem
      claimRef:
        apiVersion: v1
        kind: PersistentVolumeClaim
        name: catalog-testprimary-primary-0
        namespace: test
    
  5. Create PVC with correct PVC name (step 2), storage class and storage.

    For example,

    apiVersion: v1
    kind: PersistentVolumeClaim
    metadata:
    name: catalog-testprimary-primary-0
    namespace: test
    spec:
      storageClassName: gp2-retain
    accessModes:
      - ReadWriteMany
    resources:
      requests:
      storage: 128Gi
    
  6. Deploy the Operator.
  7. Use previously created storage class names for the volumes in primary section and mediaServers section in environment CR spec and deploy environment CR.