Cohesity Cloud Scale Technology Manual Deployment Guide for Kubernetes Clusters

Last Published:
Product(s): NetBackup (11.1.0.2)
  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.  
        Decoupling of NetBackup Database Manager from primary server
      4.  
        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.  
        Configuring the cloudscale-values.yaml file
      3.  
        Configuring an External Certificate Authority for Web UI port 443
      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
        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.  
        Prerequisites for Cloud Scale deployment
      3.  
        Deploying the operators
      4. Deploying Cloud Scale using Helm chart
        1.  
          Installing Cloud Scale environment
        2. Single node Cloud Scale Technology deployment
          1.  
            Steps to deploy Cloud Scale in single node
      5.  
        Deploying Cloud Scale using kubectl plugin
      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.  
        Snapshot Manager manual certificate renewal in Cloud Scale
    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 Cloud Scale
          1.  
            Upgrade Cloud Scale using the kubectl plugin
          2.  
            Manual upgrade of Cloud Scale using the Superchart
        4.  
          Configuring NetBackup IT Analytics for NetBackup deployment
    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 Cloud Scale Technology
    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 cloudscale-values.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
        41.  
          Helm installation failed with bundle error
        42.  
          Deployment fails with private container registry and Postgres fails to pull the images
      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 cloudscale-values.yaml file
        4.  
          Primary pod is in ContainerCreating state
        5.  
          Webhook displays an error for PV not found
        6.  
          Cluster Autoscaler initialization issue
        7.  
          Catalog backup job fails with an error (Status 9202)
      4.  
        Troubleshooting issue for bootstrapper pod
      5.  
        Troubleshooting issues for kubectl plugin
  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

Installing Cloud Scale environment

To install NetBackup using Helm charts on Kubernetes cluster, perform the following:

  1. Download the NetBackup TAR package from Cohesity Download Center which contains the container images and the Helm chart for NetBackup Kubernetes application.
  2. Deploy the operators. For more information on deploying the operators, refer to the following section:

    See Deploying the operators.

  3. Perform the following steps to deploy the cloudscale-values.yaml file:

    • Use the following command to save the environment chart values to a file:

      helm show values cloudscale-<version>.tgz > cloudscale-values.yaml

    • Edit the chart values to fit the required environment:

      vi cloudscale-values.yaml

    • Use the following command to apply the cloudscale-values.yaml file:

      helm upgrade --install cloudscale cloudscale-<version>.tgz -f cloudscale-values.yaml --namespace netbackup

    For example,

    helm show values cloudscale-11.1.x.x.xxxx.tgz > cloudscale-values.yaml
$
$ vi cloudscale-values.yaml
$

    The output for the above example would be as follows:

    environment:
  corePattern: '''/corefiles/core.%e.%p.%t'''
  cpServer:
    name: cpserver-1
    networkLoadBalancer:
      fqdn: nbux-xx-xxx-xx-xx.vxindia.veritas.com
      ipAddr: xx.xxx.xx.xx
    nodeSelector:
      controlPlane:
        labelKey: pool
        labelValue: primary
      dataPlane:
        labelKey: pool
        labelValue: cp
    proxySettings: null
    storage:
      data:
        capacity: 30Gi
        storageClassName: nb-disk-standardssd
      log:
        capacity: 5Gi
        storageClassName: nb-file-premium
    tag: 11.1.0.0-1035-11.1-0045
  createServiceAccount: false
  drInfoSecretName: null
  emailServerConfigmapName: null
  enabled: true
  loadBalancerAnnotations:
    service.beta.kubernetes.io/azure-load-balancer-internal-subnet: LB-RESERVED
  mediaServers:
  - name: media1
    nodeSelector:
      labelKey: pool
      labelValue: media
    replicas: 1
    storage:
      data:
        capacity: 50Gi
        storageClassName: nb-disk-standardssd
      log:
        capacity: 5Gi
        storageClassName: nb-disk-standardssd
  msdpScaleouts:
    annotations:
      msdp.veritas.com/baas: "false"
    credential:
      secretName: msdp-secret1
    ipList:
    - fqdn: nbux-xx-xxx-xx-xx.vxindia.veritas.com
      ipAddr: xx.xxx.xx.xx
    kms:
      keyGroup: example-key-group
      keySecret: example-key-secret
    loadBalancerAnnotations: null
    name: dedupe1
    nodeSelector:
      labelKey: pool
      labelValue: msdp
    replicas: 1
    secret:
      credential:
        password: Y123abCdEf
        username: devuser
      kms:
        passphrase: Y123abC@dEf12345
        username: devuser
    storage:
      dataVolumes:
      - capacity: 5Gi
        storageClassName: nb-disk-premium
      log:
        capacity: 5Gi
        storageClassName: nb-disk-premium
    tag: 21.1-0033-11.1-0045
  name: nbu
  primary:
    credSecretName: primary-credential-secret
    kmsDBSecret: kms-secret
    networkLoadBalancer:
      ipList:
      - fqdn: nbux-xx-xxx-xx-xx.vxindia.veritas.com
        ipAddr: xx.xxx.xx.xx
    nodeSelector:
      labelKey: pool
      labelValue: primary
    secret:
      credential:
        password: Gyp.s8m123
        username: devuser
      kms:
        HMKID: hmkid123
        HMKpassphrase: HMK@passphrase123
        KPKID: kpkid123
        KPKpassphrase: KPK@passphrase123
    storage:
      catalog:
        autoVolumeExpansion: false
        capacity: 100Gi
        storageClassName: nb-file-premium
      data:
        capacity: 30Gi
        storageClassName: nb-disk-standardssd
      log:
        capacity: 10Gi
        storageClassName: nb-disk-standardssd
  tag: 11.1-0045-11.1-0045
fluentbit:
  cleanup:
    highWatermark: 90
    image:
      name: netbackup/fluentbit-log-cleanup
      tag: 11.1-0045-11.1-0045
    lowWatermark: 60
    retentionCleanupTime: "04:00"
    retentionDays: 7
    utilizationCleanupFrequency: 60
  collectorNodeSelector:
    node_selector_key: pool
    node_selector_value: primary
  enabled: true
  image:
    name: netbackup/fluentbit
    pullPolicy: IfNotPresent
    tag: 11.1-0024-DR2
  metricsPort: 2020
  namespaces:
  - netback
  - netbackup-operator-system
  tolerations:
  - key: pool
    value: primary
  - key: pool
    value: msdp
  - key: pool
    value: cp
  - key: pool
    value: media
  volume:
    pvcStorage: 100Gi
    storageClassName: nb-disk-premium
global:
  containerRegistry: nbuk8sreg.azurecr.io
  dbSecretName: dbsecret
  environmentNamespace: netbackup
  timezone: null
postgresql:
  clientSecretName: postgresql-client-crt
  createCerts: true
  dataDir: /netbackup/postgresqldb
  dbAdminName: postgres
  dbPort: 13785
  defaultPostgresqlHostName: nb-postgresql
  enabled: true
  image:
    name: netbackup/postgresql
    pullPolicy: Always
    tag: 16.10.2.0-0001-11.1-0045
  initialDbAdminPassword: postgres
  logDestination: file
  nodeSelector:
    key: pool
    value: primary
  pgbouncerPort: 13787
  postgresqlUpgrade:
    env:
      dataDir: /netbackup/postgresqldb
    image:
      name: netbackup/postgresql-upgrade
      pullPolicy: Always
      tag: 16.10.2.0-0001-11.1-0045
    replicas: 1
    securityContext:
      runAsUser: 0
    volume:
      mountPathData: /netbackup/postgresqldb
      timezone: null
      volumeClaimName: nb-psql-pvc
  replicas: 1
  securityContext:
    runAsUser: 0
  serverSecretName: postgresql-server-crt
  service:
    serviceName: nb-postgresql
  tolerations:
  - key: pool
    value: primary
  volume:
    mountPathData: /netbackup/postgresqldb
    pvcStorage: 30Gi
    secretMountPath: /netbackup/postgresql/keys/server
    storageClassName: nb-disk-premium
    volumeClaimName: nb-psql-pvc
    volumeDefaultMode: 416

Note:

By default, Helm stores the input values in a Kubernetes secret. Hence to avoid the values being discovered by anyone, customers must reset the database password after Cloud Scale deployment.