NetBackup™ Deployment Guide for Kubernetes Clusters

Last Published:
Product(s): NetBackup & Alta Data Protection (11.0)
  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 feature (fluentbit) in Cloud Scale
    2.  
      About NetBackup Snapshot Manager
    3.  
      Required terminology
    4.  
      User roles and permissions
  2. Section I. Configurations
    1. Prerequisites
      1.  
        Preparing the environment for NetBackup installation on Kubernetes cluster
      2.  
        Prerequisites for Snapshot Manager (AKS/EKS)
      3. Prerequisites 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
      6.  
        Prerequisites for using private registry
    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
    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 (fluentbit)
      11.  
        Managing media server configurations in Web UI
  3. Section II. Deployment
    1. Deploying Cloud Scale
      1.  
        How to deploy Cloud Scale
      2.  
        Deploying the operators
      3.  
        Deploying fluentbit for logging
      4. Deploying Postgres
        1.  
          Enable request logging, update configuration, and copying files from/to PostgreSQL pod
      5. Deploying Cloud Scale environment
        1.  
          Installing Cloud Scale environment
        2. Single node Cloud Scale Technology deployment
          1.  
            Steps to deploy Cloud Scale in single node
      6.  
        Verifying Cloud Scale deployment
      7. Post Cloud Scale deployment tasks
        1.  
          Restarting Cloud Scale Technology services
  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
    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
      4.  
        Migrating cpServer controlPlane node
    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
      4.  
        Steps for upgrading Cloud Scale from multiple media load balancer to none
    7. Managing PostrgreSQL DBaaS
      1.  
        Changing database server password in DBaaS
      2.  
        Updating database certificate in DBaaS
    8. Managing logging
      1.  
        Viewing NetBackup logs
      2.  
        Extracting NetBackup logs
    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
  5. Section IV. Maintenance
    1. PostgreSQL DBaaS Maintenance
      1.  
        Configuring maintenance window for PostgreSQL database in AWS
      2.  
        Setting up alarms for PostgreSQL DBaaS instance
    2. Patching mechanism for primary, media servers, fluentbit pods, and postgres pods
      1.  
        Overview
      2.  
        Patching of primary containers
      3.  
        Patching of media containers
      4.  
        Patching of fluentbit collector pods
      5.  
        Update containerized PostgreSQL pod
    3. Upgrading
      1. Upgrading Cloud Scale Technology
        1.  
          Prerequisites for Cloud Scale Technology upgrade
        2.  
          Upgrade the cluster
        3.  
          Upgrade the add-ons
        4.  
          Upgrade the operators
        5.  
          Upgrade fluentbit
        6.  
          Upgrade PostgreSQL database
        7.  
          Create db-cert bundle
        8.  
          Upgrade Cloud Scale
    4. 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
    5. Uninstalling
      1.  
        Uninstalling NetBackup environment and the operators
      2.  
        Uninstalling Postgres using Helm charts
      3.  
        Uninstalling fluentbit using Helm charts
      4.  
        Uninstalling Snapshot Manager from Kubernetes cluster
      5. Uninstalling MSDP Scalout from Kubernetes cluster
        1.  
          Cleaning up MSDP Scaleout
        2.  
          Cleaning up the MSDP Scaleout operator
    6. 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 issues when media server PVs are deleted
        12.  
          Resolving an issue related to insufficient storage
        13.  
          Resolving an issue related to invalid nodepool
        14.  
          Resolve an issue related to KMS database
        15.  
          Resolve an issue related to pulling an image from the container registry
        16.  
          Resolving an issue related to recovery of data
        17.  
          Check primary server status
        18.  
          Pod status field shows as pending
        19.  
          Ensure that the container is running the patched image
        20.  
          Getting EEB information from an image, a running container, or persistent data
        21.  
          Resolving the certificate error issue in NetBackup operator pod logs
        22.  
          Pod restart failure due to liveness probe time-out
        23.  
          NetBackup messaging queue broker take more time to start
        24.  
          Host mapping conflict in NetBackup
        25.  
          Issue with capacity licensing reporting which takes longer time
        26.  
          Local connection is getting treated as insecure connection
        27.  
          Backing up data from Primary server's /mnt/nbdata/ directory fails with primary server as a client
        28.  
          Storage server not supporting Instant Access capability on Web UI after upgrading NetBackup
        29.  
          Taint, Toleration, and Node affinity related issues in cpServer
        30.  
          Operations performed on cpServer in environment.yaml file are not reflected
        31.  
          Elastic media server related issues
        32.  
          Failed to register Snapshot Manager with NetBackup
        33.  
          Post Kubernetes cluster restart, flexsnap-listener pod went into CrashLoopBackoff state or pods were unable to connect to flexsnap-rabbitmq
        34.  
          Post Kubernetes cluster restart, issues observed in case of containerized Postgres deployment
        35.  
          Request router logs
        36.  
          Issues with NBPEM/NBJM
        37.  
          Issues with logging feature for Cloud Scale
        38.  
          The flexsnap-listener pod is unable to communicate with RabbitMQ
        39.  
          Job remains in queue for long time
        40.  
          Extracting logs if the nbwsapp or log-viewer pods are down
      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
  7. Appendix B. MSDP Scaleout
    1.  
      About MSDP Scaleout
    2.  
      Prerequisites for MSDP Scaleout (AKS\EKS)
    3.  
      Limitations in MSDP Scaleout
    4. 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
    5.  
      Installing the docker images and binaries for MSDP Scaleout (without environment operators or Helm charts)
    6.  
      Deploying MSDP Scaleout
    7. 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
    8. 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

Patching of primary containers

This section describes the procedure for patching the following primary containers:

  • Patching particular pod of primary server

  • Patching Init containers for all pods of primary server

  • Patching Sidecar containers for all pods of primary server

Patching particular pod of primary server

  1. Get the environment name using the following command:

    kubectl get environments -n <namespace>

  2. Using the following command, check if ServiceImageTag is present:

    kubectl get environment -n <namespace> -o=jsonpath='{$.items[0].spec.primary.serviceImageTag}'

    Depending on the output of step 2, perform one of the following steps.

    If ServiceImageTag is present (some content is there in the output) or not present (no content is there in the output). Run the following command by changing the value field (for example, <version>-patch) to the required image tag:

    See Table: Primary container keywords and examples for the list of all the primary container keywords and examples.

  3. Depending on the output of step 2, perform one of the following steps.

    If ServiceImageTag is present (some content is there in the output) or not present (no content is there in the output). Run the following command by changing the value field (for example, <version>-patch) to the required image tag:

    • If ServiceImageTag is present:

      kubectl patch environment <env-name> -n <namespace> --type=json --patch '[{"op": "replace", "path": "/spec/primary/serviceImageTag/<container keyword>", "value": "<version>-patch"}]'

      For example, kubectl patch environment <env-name> -n <namespace> --type=json --patch '[{"op": "replace", "path": "/spec/primary/serviceImageTag/primary.main", "value": "11.0-patch"}]'

      Or

    • If ServiceImageTag is not present:

      kubectl patch environment <env-name> -n <namespace> --type=json --patch '[{"op": "replace", "path": "/spec/primary/serviceImageTag", "value": {}},{"op": "replace", "path": "/spec/primary/serviceImageTag/<container keyword>", "value": "<version>-patch"}]'

      For example, kubectl patch environment <env-name> -n <namespace> --type=json --patch '[{"op": "replace", "path": "/spec/primary/serviceImageTag", "value": {}},{"op": "replace", "path": "/spec/primary/serviceImageTag/primary.main", "value": "11.0-patch"}]'

Table: Primary container keywords and examples

Profile name

Main container keyword

Init container keyword

Sidecar container keyword

Primary

primary.main

For example, netbackup/main:<version>-patch

primary.pod-dependency-init

primary.fluentbit

Nbatd

nbatd.main

For example, netbackup/nbatd-main:<version>-patch

nbatd.nbatd-init

For example, netbackup/nbatd-init:<version>-patch

  • nbatd.pbx

    For example, netbackup/pbx:<version>-patch

  • nbatd.fluentbit

  • nbatd.nbhousekeeping

    For example, netbackup/nbhousekeeping:<version>-patch

Mqbroker

nbmqbroker.main

For example, netbackup/mqbroker:<version>-patch

  • nbmqbroker.nbmqbrokerinit

    For example, netbackup/mqbroker-init:<version>-patch

  • nbmqbroker.pod-dependency-init

nbmqbroker.fluentbit

Webservice

nbwsapp.main

For example, netbackup/ws-app:<version>-patch

  • nbwsapp.nbwsinit

    For example, netbackup/ws-init:<version>-patch

  • nbwsapp.pod-dependency-init

  • nbwsapp.secure-comms

    For example, netbackup/vnetd:<version>-patch

  • nbwsapp.nbhousekeeping

    For example, netbackup/nbhousekeeping:<version>-patch

  • nbwsapp.fluentbit

Policyjob

policyjob.main

For example, netbackup/policyjobmgr:<version>-patch

policyjob.pod-dependency-init

  • policyjob.pbx

    For example, netbackup/pbx:<version>-patch

  • policyjob.fluentbit

  • policyjob.secure-comms

    For example, netbackup/vnetd:<version>-patch

  • policyjob.nbhousekeeping

    For example, netbackup/nbhousekeeping:<version>-patch

Policyjobmgr

policyjobmgr.main

For example, netbackup/policyjobmgr:<version>-patch

policyjobmgr.pod-dependency-init

  • policyjobmgr.pbx

    For example, netbackup/pbx:<version>-patch

  • policyjobmgr.secure-comms

    For example, netbackup/vnetd:<version>-patch

  • policyjobmgr.nbhousekeeping

    For example, netbackup/nbhousekeeping:<version>-patch

  • policyjobmgr.fluentbit

Requestrouter

requestrouter.main

For example, netbackup/requestrouter:<version>-patch

requestrouter.pod-dependency-init

 

Bootstrapper

bootstrapper.main

For example, netbackup/main:<version>-patch

bootstrapper.pod-dependency-init

bootstrapper.fluentbit

Log-viewer

log-viewer.main

For example, netbackup/log-viewer:<version>-patch

log-viewer.pod-dependency-init

 

Patching Init containers for all pods of primary server:

  1. Get the environment name using the following command:

    kubectl get environments -n <namespace>

  2. Use this when you want to patch a specific Init container for all the profiles (wherever applicable) of the primary server.

    Init container keyword: pod-dependency-init

    For example, the pod-dependency-init container patch image: netbackup/operator:<version>-patch

  3. Depending on the output of step 2, perform one of the following steps.

    If ServiceImageTag is present (some content is there in the output) or not present (no content is there in the output). Run the following command by changing the value field (for example, <version>-patch) to the required image tag:

    • If ServiceImageTag is present:

      kubectl patch environment <env-name> -n <namespace> --type=json --patch '[{"op": "replace", "path": "/spec/primary/serviceImageTag/<init container keyword>", "value": "<version>-patch"}]'

      For example, kubectl patch environment <env-name> -n <namespace> --type=json --patch '[{"op": "replace", "path": "/spec/primary/serviceImageTag/pod-dependency-init", "value": "11.0-patch"}]'

      Or

    • If ServiceImageTag is not present:

      kubectl patch environment <env-name> -n <namespace> --type=json --patch '[{"op": "replace", "path": "/spec/primary/serviceImageTag", "value": {}},{"op": "replace", "path": "/spec/primary/serviceImageTag/<init container keyword>", "value": "<version>-patch"}]'

      For example. kubectl patch environment <env-name> -n <namespace> --type=json --patch '[{"op": "replace", "path": "/spec/primary/serviceImageTag", "value": {}},{"op": "replace", "path": "/spec/primary/serviceImageTag/pod-dependency-init", "value": "11.0-patch"}]'

Patching Sidecar containers for all pods of primary server

  1. Get the environment name using the following command:

    kubectl get environments -n <namespace>

  2. Patching Sidecar containers for all pods of primary server:

    Use this when you want to patch a specific Sidecar container for all the profiles (wherever applicable) of the primary server.

    Sidecar containers keyword:

    • fluentbit

    • pbx

    • secure-comms

    • nbhousekeeping

    If a specific container is patched with some image (for example, nbatd.pbx: <version>-patch) and you want to patch that container universally (for example, pbx: <version>-patch1), then you have to first delete the previous entry for that container from the environment.

  3. Depending on the output of step 2, perform one of the following steps.

    If ServiceImageTag is present (some content is there in the output) or not present (no content is there in the output). Run the following command by changing the value field (for example, <version>-patch) to the required image tag:

    • If ServiceImageTag is present:

      kubectl patch environment <env-name> -n <namespace> --type=json --patch '[{"op": "replace", "path": "/spec/primary/serviceImageTag/<Sidecar containers keyword>", "value": "<version>-patch"}]'

      For example, kubectl patch environment <env-name> -n <namespace> --type=json --patch '[{"op": "replace", "path": "/spec/primary/serviceImageTag/fluentbit", "value": "11.0-patch"}]'

      Or

    • If ServiceImageTag is not present:

      kubectl patch environment <env-name> -n <namespace> --type=json --patch '[{"op": "replace", "path": "/spec/primary/serviceImageTag", "value": {}},{"op": "replace", "path": "/spec/primary/serviceImageTag/<Sidecar containers keyword>", "value": "<version>-patch"}]'

      For example, kubectl patch environment <env-name> -n <namespace> --type=json --patch '[{"op": "replace", "path": "/spec/primary/serviceImageTag", "value": {}},{"op": "replace", "path": "/spec/primary/serviceImageTag/fluentbit", "value": "11.0-patch"}]'