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

About the Load Balancer service

Key features of the Load Balancer service:

  • Load balancer services are created in primary server and media server deployment that lets you access the NetBackup application from public domains.

  • In primary server or media server CR spec, networkLoadBalancer section is used for handling the IP address and DNS name allocation for load balancer services. This section combines to sub fields type, annotations, and ipList whereas these fields are optional. If ipList is provided in CR spec, IP address count must match the replica count in case of media server CR whereas in case of primary server CR, only one IP address needs to be mentioned.

  • In CR yaml, networkLoadBalancer is an optional field. If not defined in CR yaml, by default value of type is Private and services are added with annotations service.beta.kubernetes.io/azure-load-balancer-internal: "true". In this case, by default internal load balancer is selected for deployment.

  • If networkLoadBalancer section is not defined, by default internal load balancer with dynamic IP address allocation are done. In this case, DNS names for the services can be obtained from HostName in CR status using the kubectl describe <CR name> -n <namespace> command.

    • Whenever, HostName in CR status is not in FQDN format, you must add entry of hostname and its corresponding IP address in /etc/host to access the primary server and its corresponding IP address in hosts file of computer accessing the primary server. Hosts file is present at the following location:

      • For Linux: /etc/hosts

      • For Windows: c:\Windows\System32\Drivers\etc\hosts

    • In case of media server, FQDN per media server replica is generated using resourcePrefix mentioned in media server CR and listed under status attributes media server-name of the media server CR.

  • In this deployment, it is recommended to use internal load balancer using type as Private with static IP allocation and DNS name allocation.

    For details about internal load balancer, see Microsoft documentation.

    However, if type is public, then external load balancer is used and for more details to create and use public loadbalancer, see Microsoft documentation.

  • The networkLoadBalancer section can be used to provide static IP address and DNS name allocation to the loadbalancer services. For more information to create and use static loadbalancer, see Microsoft documentation.

    Static IP addresses and FQDN if used must be created before being used. Refer below sections for different allowed scenarios.

    • Case 1: Internal load balancer with static IP address allocation

      • Example: In Primary section in environment CR

        networkLoadBalancer:
              ipList:
                - ipAddr: 10.123.45.123

        In media server section in environment CR

        networkLoadBalancer:
           ipList:
            - ipAddr: 10.123.45.124
            - ipAddr: 10.123.45.125

        In this case, number of IP addresses for primary server should be one, and for media server, the number of IP addresses should match with the replica count mentioned in CR spec. Dynamically created FQDN mentioned in CR status attribute is used directly as DNS name for primary/media server services.

      • Example: In primary CR

        In this case, the number of IP addresses for primary server should be one, and for media server, it should match with the replica count mentioned in CR spec. IP address and DNS name mentioned in CR spec is used as DNS name for primary/media server services.

        networkLoadBalancer:
              ipList:
                - ipAddr: 10.123.45.123
                  fqdn: abc.eastus.cloudapp.azure.com
        

        In media server section in environment CR

        networkLoadBalancer:
              ipList:
                - fqdn: xyz.eastus.cloudapp.azure.com
                  ipAddr: 10.123.45.124
                - fqdn: pqr.eastus.cloudapp.azure.com
                  ipAddr: 10.123.45.125
        
    • Case 2: Internal load balancer and dynamic IP address allocation

      • Example: In primary/media CR

        In this case, IP address and DNS name are allocated dynamically and internal load balancer is used. User needs to add entry of Hostname (FQDN) mentioned in CR status attribute and IP address allocated to load balancer service in /etc/hosts location on Linux machine. While c:\Windows\System32\Drivers\etc\hosts location on Windows computer to access primary server webUI.

    • Case 3: Internal load balancer for different subnet with dynamic IP

      In this case, IP addresses for load balancer service are allocated dynamically. The subnet mentioned in annotations is bound to internal load balancer service.

      • Example: In primary CR

        networkLoadBalancer:
        annotations:
        - service.beta.kubernetes.io/
        azure-load-balancer-internal-subnet: "apps-subnet"
        

        Media CR

        networkLoadBalancer:
        annotations:
        - service.beta.kubernetes.io/
        azure-load-balancer-internal-subnet: "apps-subnet"
    • Case 4: Internal load balancer for different subnet with static IP

      In this case, load balancer service gets assigned with the static IP addresses mentioned in the ipList, DNS name is generated dynamically, and gets bound to the subnet given in the annotations.

      • Example: In primary section in environment CR,

        networkLoadBalancer:
          annotations:
          - service.beta.kubernetes.io/azure-load-balancer-
        internal-subnet: apps-subnet
          ipList:
          - ipAddr: 10.123.45.123

        Media server section in environment CR

        networkLoadBalancer:
          annotations:
          - service.beta.kubernetes.io/azure-load-balancer-
        internal-subnet: apps-subnet
          ipList:
          - ipAddr: 10.123.45.125
          - ipAddr: 10.123.45.124
    • Case 5: Pre-allocation of static IP address and FQDN from resource group

      In this case, it is required to provide the network resource group in annotations. This resource group is the resource group of load balancer public IPs that are in the same resource group as the cluster infrastructure (node resource group). This static FQDN and IP address must be valid in case of pod failure or upgrades scenarios as well.

      In case user wants to use public load balancer, add type: Public in networkLoadBalancer section in primary and media server section in environment CR.

      • Example: In primary CR,

        networkLoadBalancer:
          type: Public
          annotations:
          - service.beta.kubernetes.io/azure-load-balancer-
        resource-group:<name of network resource-group>
          ipList:
          - fqdn: primary.eastus.cloudapp.azure.com
            ipAddr: 40.123.45.123

        Media server section in environment CR -

        networkLoadBalancer:
          annotations:
          - service.beta.kubernetes.io/azure-load-balancer-
        resource-group: ""<name of network resource-group>""
          ipList:
          - fqdn: media-1.eastus.cloudapp.azure.com
            ipAddr: 40.123.45.123
          - fqdn: media-2.eastus.cloudapp.azure.com
            ipAddr: 40.123.45.124
Preferred annotations

Table: Preferred annotations

Annotations

Value

Description

service.beta.kubernetes.io/ azure-load-balancer- internal

true or false

Specify whether the load balancer should be internal.

Added by default when type is selected as Private in load balancer service annotations.

service.beta.kubernetes.io/ azure-load-balancer- internal-subnet

Name of the subnet

Specify which subnet the internal load balancer should be bound to.

service.beta.kubernetes.io/ azure-load-balancer -resource-group

Name of the resource group

Specify the resource group of load balancer public IPs that are not in the same resource group as the cluster infrastructure (node resource group).

Default ports used in the Load Balancer service
  • Primary server:

    • 1556

      Used as bidirectional port. Primary server to/from media servers and primary server to/from client require this TCP port for communication.

    • 8443

      Used to inbound to java nbwmc on the primary server.

    • 443

      Used to inbound to vnet proxy tunnel on the primary server. Also, this is used Nutanix workload, communication from primary server to the deduplication media server.

    • 13781

      The MQBroker is listening on TCP port 13781. NetBackup client hosts - typically located behind a NAT gateway - be able to connect to the message queue broker (MQBroker) on the primary server.

    • 13782

      Used by primary server for bpcd process.

    • Port 22

      Used by NetBackup IT Analytics data collector for data collection.

  • Media server:

    • 1556

      Used as bidirectional port. Primary server to/from media servers and primary server to/from client require this TCP port for communication.

    • 13782

      Used by media server for bpcd process.