NetBackup™ Deployment Guide for Kubernetes Clusters

Last Published:
Product(s): NetBackup & Alta Data Protection (10.5)
  1. Introduction
    1. About Cloud Scale deployment
      1.  
        Decoupling of NetBackup web services from primary server
      2.  
        Decoupling of NetBackup Policy and Job Management from primary server
      3.  
        Logging strategy (fluentbit) in Cloud Scale
    2.  
      About NetBackup Snapshot Manager
    3.  
      About MSDP Scaleout
    4.  
      Required terminology
    5.  
      User roles and permissions
  2. Section I. Configurations
    1. Prerequisites
      1.  
        Preparing the environment for NetBackup installation on Kubernetes cluster
      2.  
        Prerequisites for MSDP Scaleout and Snapshot Manager (AKS/EKS)
      3. Prerequistes for Kubernetes cluster configuration
        1.  
          Config-Checker utility
        2.  
          Data-Migration for AKS
        3.  
          Webhooks validation for EKS
      4. Prerequisites for Cloud Scale configuration
        1.  
          Cluster specific settings
        2.  
          Cloud specific settings
      5.  
        Prerequisites for deploying environment operators
    2. Recommendations and Limitations
      1.  
        Recommendations of NetBackup deployment on Kubernetes cluster
      2.  
        Limitations of NetBackup deployment on Kubernetes cluster
      3.  
        Recommendations and limitations for Cloud Scale deployment
      4.  
        Limitations in MSDP Scaleout
    3. Configurations
      1.  
        Contents of the TAR file
      2.  
        Initial configurations
      3.  
        Configuring the environment.yaml file
      4. Loading docker images
        1.  
          Installing the docker images for NetBackup
        2.  
          Installing the docker images for Snapshot Manager
        3.  
          Installing the docker images and binaries for MSDP Scaleout
      5.  
        Configuring NetBackup IT Analytics for NetBackup deployment
      6. Configuring NetBackup
        1. Primary and media server CR
          1.  
            After installing primary server CR
          2.  
            After Installing the media server CR
        2.  
          Elastic media server
    4. Configuration of key parameters in Cloud Scale deployments
      1.  
        Tuning touch files
      2.  
        Setting maximum jobs per client
      3.  
        Setting maximum jobs per media server
      4.  
        Enabling intelligent catalog archiving
      5.  
        Enabling security settings
      6.  
        Configuring email server
      7.  
        Reducing catalog storage management
      8.  
        Configuring zone redundancy
      9.  
        Enabling client-side deduplication capabilities
      10.  
        Parameters for logging strategy (fluentbit)
  3. Section II. Deployment
    1. Deploying operators
      1.  
        Deploying the operators
    2. Deploying fluentbit for logging strategy
      1.  
        Deploying fluentbit for logging strategy
    3. Deploying Postgres
      1.  
        Deploying Postgres
      2.  
        Enable request logging, update configuration, and copying files from/to PostgreSQL pod
    4. Deploying Cloud Scale
      1.  
        Installing Cloud Scale
      2. Single node Cloud Scale Technology deployment
        1.  
          Steps to deploy Cloud Scale in single node
      3.  
        Restarting Cloud Scale Technology services
    5. Deploying MSDP Scaleout
      1. MSDP Scaleout configuration
        1.  
          Initializing the MSDP operator
        2.  
          Configuring MSDP Scaleout
        3.  
          Configuring the MSDP cloud in MSDP Scaleout
        4.  
          Using MSDP Scaleout as a single storage pool in NetBackup
        5.  
          Using S3 service in MSDP Scaleout
        6.  
          Enabling MSDP S3 service after MSDP Scaleout is deployed
      2.  
        Deploying MSDP Scaleout
    6. Verifying Cloud Scale deployment
      1.  
        Verifying Cloud Scale deployment
  4. Section III. Monitoring and Management
    1. Monitoring NetBackup
      1.  
        Monitoring the application health
      2.  
        Telemetry reporting
      3.  
        About NetBackup operator logs
      4.  
        Monitoring Primary/Media server CRs
      5.  
        Expanding storage volumes
      6. Allocating static PV for Primary and Media pods
        1.  
          Expanding log volumes for primary pods
        2.  
          Recommendation for media server volume expansion
        3.  
          (AKS-specific) Allocating static PV for Primary and Media pods
        4.  
          (EKS-specific) Allocating static PV for Primary and Media pods
    2. Monitoring Snapshot Manager
      1.  
        Overview
      2.  
        Configuration parameters
    3. Monitoring fluentbit
      1.  
        Monitoring fluentbit for logging strategy
    4. Monitoring MSDP Scaleout
      1.  
        About MSDP Scaleout status and events
      2.  
        Monitoring with Amazon CloudWatch
      3.  
        Monitoring with Azure Container insights
      4.  
        The Kubernetes resources for MSDP Scaleout and MSDP operator
    5. Managing NetBackup
      1.  
        Managing NetBackup deployment using VxUpdate
      2.  
        Updating the Primary/Media server CRs
      3.  
        Migrating the cloud node for primary or media servers
    6. 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
    7. Managing PostrgreSQL DBaaS
      1.  
        Changing database server password in DBaaS
      2.  
        Updating database certificate in DBaaS
    8. Managing fluentbit
      1.  
        Managing fluentbit for logging strategy
    9. Performing catalog backup and recovery
      1.  
        Backing up a catalog
      2. Restoring a catalog
        1.  
          Primary server corrupted
        2.  
          MSDP-X corrupted
        3.  
          MSDP-X and Primary server corrupted
    10. 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
          1.  
            Recovering MSDP S3 IAM configurations from cloud LSU
      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
  5. Section IV. Maintenance
    1. 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 pool
    2. PostgreSQL DBaaS Maintenance
      1.  
        Configuring maintenance window for PostgreSQL database in AWS
      2.  
        Setting up alarms for PostgreSQL DBaaS instance
    3. Patching mechanism for primary, media servers, fluentbit pods, and postgres pods
      1.  
        Overview
      2.  
        Patching of containers
    4. Upgrading
      1. Upgrading Cloud Scale Technology
        1.  
          Upgrading Cloud Scale deployment for Postgres using Helm charts
        2.  
          Upgrading Cloud Scale deployment for logging strategy (fluentbit)
    5. Cloud Scale Disaster Recovery
      1.  
        Cluster backup
      2.  
        Environment backup
      3.  
        Cluster recovery
      4.  
        Cloud Scale recovery
      5.  
        Environment Disaster Recovery
      6.  
        DBaaS Disaster Recovery
    6. Uninstalling
      1.  
        Uninstalling NetBackup environment and the operators
      2.  
        Uninstalling Postgres using Helm charts
      3.  
        Uninstalling Snapshot Manager from Kubernetes cluster
      4. Uninstalling MSDP Scalout from Kubernetes cluster
        1.  
          Cleaning up MSDP Scaleout
        2.  
          Cleaning up the MSDP Scaleout operator
    7. Troubleshooting
      1. Troubleshooting AKS and EKS issues
        1.  
          View the list of operator resources
        2.  
          View the list of product resources
        3.  
          View operator logs
        4.  
          View primary logs
        5.  
          Socket connection failure
        6.  
          Resolving an issue where external IP address is not assigned to a NetBackup server's load balancer services
        7.  
          Resolving the issue where the NetBackup server pod is not scheduled for long time
        8.  
          Resolving an issue where the Storage class does not exist
        9.  
          Resolving an issue where the primary server or media server deployment does not proceed
        10.  
          Resolving an issue of failed probes
        11.  
          Resolving token issues
        12.  
          Resolving an issue related to insufficient storage
        13.  
          Resolving an issue related to invalid nodepool
        14.  
          Resolving a token expiry issue
        15.  
          Resolve an issue related to KMS database
        16.  
          Resolve an issue related to pulling an image from the container registry
        17.  
          Resolving an issue related to recovery of data
        18.  
          Check primary server status
        19.  
          Pod status field shows as pending
        20.  
          Ensure that the container is running the patched image
        21.  
          Getting EEB information from an image, a running container, or persistent data
        22.  
          Resolving the certificate error issue in NetBackup operator pod logs
        23.  
          Pod restart failure due to liveness probe time-out
        24.  
          NetBackup messaging queue broker take more time to start
        25.  
          Host mapping conflict in NetBackup
        26.  
          Issue with capacity licensing reporting which takes longer time
        27.  
          Local connection is getting treated as insecure connection
        28.  
          Primary pod is in pending state for a long duration
        29.  
          Backing up data from Primary server's /mnt/nbdata/ directory fails with primary server as a client
        30.  
          Storage server not supporting Instant Access capability on Web UI after upgrading NetBackup
        31.  
          Taint, Toleration, and Node affinity related issues in cpServer
        32.  
          Operations performed on cpServer in environment.yaml file are not reflected
        33.  
          Elastic media server related issues
        34.  
          Failed to register Snapshot Manager with NetBackup
        35.  
          Post Kubernetes cluster restart, flexsnap-listener pod went into CrashLoopBackoff state or pods were unable to connect to flexsnap-rabbitmq
        36.  
          Post Kubernetes cluster restart, issues observed in case of containerized Postgres deployment
        37.  
          Request router logs
        38.  
          Issues with NBPEM/NBJM
        39.  
          Issues with logging strategy for Cloud Scale
      2. Troubleshooting AKS-specific issues
        1.  
          Data migration unsuccessful even after changing the storage class through the storage yaml file
        2.  
          Host validation failed on the target host
        3.  
          Primary pod goes in non-ready state
      3. Troubleshooting EKS-specific issues
        1.  
          Resolving the primary server connection issue
        2.  
          NetBackup Snapshot Manager deployment on EKS fails
        3.  
          Wrong EFS ID is provided in environment.yaml file
        4.  
          Primary pod is in ContainerCreating state
        5.  
          Webhook displays an error for PV not found
      4.  
        Troubleshooting issue for bootstrapper pod
  6. Appendix A. CR template
    1.  
      Secret
    2. MSDP Scaleout CR
      1.  
        MSDP Scaleout CR template for AKS
      2.  
        MSDP Scaleout CR template for EKS

Initial configurations

Creating Secrets

Perform the following steps to create Secrets

  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/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. Create a secret to hold the MSDP S3 root credentials if you need MSDP S3 service. The secret must include accessKey and secretKey, and must be located in the same namespace as the Environment resource.
    • accessKey must match the regex pattern ^[\w]+$ and has the length in the range [16, 128].

    • secretKey must match the regex pattern ^[\w+\/]+$ and has the length in the range [32, 128].

    It is recommended that you generate random S3 root credentials. Run the following command:

    $ kubectl msdp generate-s3-secret --namespace nb-example --s3secret s3-secret1

    Save the generated S3 root credentials at a secure place for later use.

  7. Create the Snapshot Manager server secret using kubectl from the command line:

    kubectl create secret generic cp-creds --namespace netbackup --from-literal=username="admin" --from-literal=password="CloudPoint@123"

Creating storage class

The following storage classes (disk & file based) are created automatically during helm installation: <storage class names>

  • nb-file-premium

  • nb-disk-standard

  • nb-disk-standardssd

  • nb-disk-premium

For more information refer to the following section:

More Information

Installing Cloud Scale