NetBackup™ Deployment Guide for Azure Kubernetes Services (AKS) Cluster

Last Published:
Product(s): NetBackup (10.0.0.1)
  1. Introduction to NetBackup on AKS
    1.  
      About NetBackup deployment on Azure Kubernetes Services (AKS) 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 using the deploy.sh file
    3.  
      Deploying the operators manually
    4.  
      Deploying NetBackup and MSDP Scaleout manually
    5.  
      Configuring the environment.yaml file
    6.  
      Uninstalling NetBackup environment and the operators
    7.  
      Applying security patches
  3. Assessing cluster configuration before deployment
    1.  
      How does the Config-Checker utility work
    2.  
      Config-Checker execution and status details
  4. Deploying NetBackup
    1.  
      Preparing the environment for NetBackup installation on AKS
    2.  
      Recommendations of NetBackup deployment on AKS
    3.  
      Limitations of NetBackup deployment on AKS
    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 pool for primary or media servers
  5. Upgrading NetBackup
    1.  
      Preparing for NetBackup upgrade
    2.  
      Upgrading NetBackup operator
    3.  
      Upgrading NetBackup application
    4.  
      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 Azure Container insights
    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 pool
  14. Uninstalling MSDP Scaleout from AKS
    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 inconsistency in file ownership
    18.  
      Resolve an issue related to KMS database
    19.  
      Resolve an issue related to pulling an image from the container registry
    20.  
      Resolving an issue related to recovery of data
    21.  
      Check primary server status
    22.  
      Pod status field shows as pending
    23.  
      Ensure that the container is running the patched image
    24.  
      Getting EEB information from an image, a running container, or persistent data
    25.  
      Resolving the certificate error issue in NetBackup operator pod logs
  16. Appendix A. CR template
    1.  
      Secret
    2.  
      MSDP Scaleout CR

Monitoring with Azure Container insights

You can use Azure Container insights to collect Prometheus metrics to monitor pods in MSDP Scaleout.

To configure Azure Container insights

  1. Enable Azure Container insights.

    See Azure documentation.

  2. Download the template ConfigMap YAML file and save it as container-azm-ms-agentconfig.yaml.
  3. Add the YAML file with the following sample configuration:
    prometheus-data-collection-settings: |-
    
    [prometheus_data_collection_settings.cluster]
    interval = "1m"
    
    fieldpass = ["msdpoperator_reconcile_total",
                 "msdpoperator_reconcile_failed",
                 "msdpoperator_operator_run",
                 "msdpoperator_diskFreeLess5GBEngines_total",
                 "msdpoperator_diskFreeMiBytesInEngine",
                 "msdpoperator_diskFreeLess10GBClusters_total",
                 "msdpoperator_totalDiskFreePercentInCluster",
                 "msdpoperator_diskFreePercentInEngine",
                 "msdpoperator_pvcFreePercentInCluster",
                 "msdpoperator_unhealthyEngines_total",
                 "msdpoperator_createdPods_total"]
    
    monitor_kubernetes_pods = true
    
    # Add the namespace of MSDP operator in the follow list. 
    It's "msdp-operator-system" by default.
    
    monitor_kubernetes_pods_namespaces = 
    ["msdp-operator-system"]

    Table: Supported Prometheus metrics list in MSDP Scaleout lists the Prometheus metrics that MSDP Scaleout supports.

  4. Apply the ConfigMap.

    kubectl apply -f container-azm-ms-agentconfig.yaml

    The configuration change takes a few minutes and all omsagent pods in the cluster restart.

    The default namespace of prometheus metrics is prometheus.

  5. Add alert rules for the integrated metrics.

    Add related log query, add new alert rule for the selected query, and alert group/action for it.

    For example,

    If the free space size of the MSDP Scaleout engines is lower than 1 GB in past 5 minutes, alert the users.

    Log query:

    InsightsMetrics
    
    | where Name == "msdpoperator_diskFreeMiBytesInEngine"
    | where Namespace == "prometheus"
    | where TimeGenerated > ago(5m)
    | where Val <= 1000000
    | where Val > 0

    If multiple MSDP Scaleouts are deployed in the same AKS cluster, use the filter to search the results. For example, search the MSDP engines with the free space size lower than 1GB in the namespace sample-cr-namespace

    Log query:

    InsightsMetrics
    | where Name == "msdpoperator_diskFreeMiBytesInEngine"
    | where Namespace == "prometheus"
    | where TimeGenerated > ago(5m)
    | where Val <= 1000000
    | where Val > 0
    | extend Tags = parse_json(Tags)
    | where Tags.msdpscalout_ns == "sample-cr-namespace"

MSDP Scaleout supports the following Prometheus metrics:

Table: Supported Prometheus metrics list in MSDP Scaleout

Metrics

Type

Filters

Description

msdpoperator_reconcile_total

Counter

N/A

The total of the reconcile loops msdp-operator run.

msdpoperator_reconcile_failed

Counter

N/A

The total of the reconcile loops msdp-operator failed to run.

msdpoperator_operator_run

Counter

N/A

The total of the running operator.

msdpoperator_diskFreeLess5GBEngines_total

Gauge

InsightsMetrics.Tags.msdpscalout_ns

The checked number of the engines which have free spaces lower than 5GB.

msdpoperator_diskFreeMiBytesInEngine

Gauge

InsightsMetrics.Tags.msdpscalout_ns

The free space of current engine in MiBytes.

msdpoperator_diskFreeLess10GBClusters_total

Gauge

InsightsMetrics.Tags.msdpscalout_ns

The checked number of the msdpscaleout apps which have free spaces lower than 10GB.

msdpoperator_totalDiskFreePercentInCluster

Gauge

InsightsMetrics.Tags.msdpscalout_ns

The percent of the msdpscaleout apps that have free spaces. For example, 0.95 means 95%

msdpoperator_diskFreePercentInEngine

Gauge

InsightsMetrics.Tags.msdpscalout_ns

The percent of the current engines, which have free spaces.

msdpoperator_pvcFreePercentInCluster

Gauge

InsightsMetrics.Tags.msdpscalout_ns, InsightsMetrics.Tags.component

The percent of the used PVC, which have free spaces.

msdpoperator_unhealthyEngines_total

Gauge

InsightsMetrics.Tags.msdpscalout_ns

The total of unhealthy engines.

msdpoperator_createdPods_total

Gauge

InsightsMetrics.Tags.msdpscalout_ns, InsightsMetrics.Tags.component

The total of created msdpscaleout pods.