NetBackup™ for Kubernetes Administrator's Guide

Last Published:
Product(s): NetBackup & Alta Data Protection (10.5)
  1. Overview of NetBackup for Kubernetes
    1.  
      Overview
    2.  
      Features of NetBackup support for Kubernetes
  2. Deploying and configuring the NetBackup Kubernetes operator
    1.  
      Prerequisites for NetBackup Kubernetes Operator deployment
    2.  
      Deploy service package on NetBackup Kubernetes operator
    3.  
      Port requirements for Kubernetes operator deployment
    4.  
      Upgrade the NetBackup Kubernetes operator
    5.  
      Delete the NetBackup Kubernetes operator
    6.  
      Configure NetBackup Kubernetes data mover
    7.  
      Automated configuration of NetBackup protection for Kubernetes
    8. Configure settings for NetBackup snapshot operation
      1.  
        Kubernetes operators supported configuration parameters
      2.  
        Prerequisites for backup from snapshot and restore from backup operations
      3.  
        DTE client settings supported in Kubernetes
      4.  
        Customization of datamover properties
    9.  
      Troubleshooting NetBackup servers with short names
    10.  
      Data mover pod schedule mechanism support
    11.  
      Validating accelerator storage class
  3. Deploying certificates on NetBackup Kubernetes operator
    1.  
      Deploy certificates on the Kubernetes operator
    2.  
      Perform Host-ID-based certificate operations
    3.  
      Perform ECA certificate operations
    4.  
      Identify certificate types
  4. Managing Kubernetes assets
    1.  
      Add a Kubernetes cluster
    2. Configure settings
      1.  
        Change resource limits for Kuberentes resource types
      2.  
        Configure autodiscovery frequency
      3.  
        Configure permissions
    3.  
      Add protection to the assets
    4. Scan for malware
      1.  
        Assets by workload type
  5. Managing Kubernetes intelligent groups
    1.  
      About intelligent group
    2.  
      Create an intelligent group
    3.  
      Delete an intelligent group
    4.  
      Edit an intelligent group
  6. Managing Kubernetes policies
    1.  
      Create a policy
  7. Protecting Kubernetes assets
    1.  
      Protect an intelligent group
    2.  
      Remove protection from an intelligent group
    3.  
      Configure backup schedule
    4.  
      Configure backup options
    5.  
      Configure backups
    6.  
      Configure Auto Image Replication (A.I.R.) and duplication
    7.  
      Configure storage units
    8.  
      Volume mode support
    9.  
      Configure application consistent backup
  8. Managing image groups
    1. About image groups
      1.  
        Image expire
      2.  
        Image copy
  9. Protecting Rancher managed clusters in NetBackup
    1.  
      Add Rancher managed RKE cluster in NetBackup using automated configuration
    2.  
      Add Rancher managed RKE cluster manually in NetBackup
  10. Recovering Kubernetes assets
    1.  
      Explore and validate recovery points
    2.  
      Restore from snapshot
    3.  
      Restore from backup copy
  11. About incremental backup and restore
    1.  
      Incremental backup and restore support for Kubernetes
  12. Enabling accelerator based backup
    1.  
      About NetBackup Accelerator support for Kubernetes workloads
    2.  
      Controlling disk space for track logs on primary server
    3.  
      Effect of storage class behavior on Accelerator
    4.  
      About Accelerator forced rescan
    5.  
      Warnings and probable reason for Accelerator backup failures
  13. Enabling FIPS mode in Kubernetes
    1.  
      Enable Federal Information Processing Standards (FIPS) mode in Kubernetes
  14. About Openshift Virtualization support
    1.  
      OpenShift Virtualization support
    2.  
      Application consistent virtual machines backup
    3.  
      Troubleshooting for virtualization
  15. Troubleshooting Kubernetes issues
    1.  
      Error during the primary server upgrade: NBCheck fails
    2.  
      Error during an old image restore: Operation fails
    3.  
      Error during persistent volume recovery API
    4.  
      Error during restore: Final job status shows partial failure
    5.  
      Error during restore on the same namespace
    6.  
      Datamover pods exceed the Kubernetes resource limit
    7.  
      Error during restore: Job fails on the highly loaded cluster
    8.  
      Custom Kubernetes role created for specific clusters cannot view the jobs
    9.  
      Openshift creates blank non-selected PVCs while restoring applications installed from OperatorHub
    10.  
      NetBackup Kubernetes operator become unresponsive if PID limit exceeds on the Kubernetes node
    11.  
      Failure during edit cluster in NetBackup Kubernetes 10.1
    12.  
      Backup or restore fails for large sized PVC
    13.  
      Restore of namespace file mode PVCs to different file system partially fails
    14.  
      Restore from backup copy fails with image inconsistency error
    15.  
      Connectivity checks between NetBackup primary, media, and Kubernetes servers.
    16.  
      Error during accelerator backup when there is no space available for track log
    17.  
      Error during accelerator backup due to track log PVC creation failure
    18.  
      Error during accelerator backup due to invalid accelerator storage class
    19.  
      Error occurred during track log pod start
    20.  
      Failed to setup the data mover instance for track log PVC operation
    21.  
      Error to read track log storage class from configmap

Upgrade the NetBackup Kubernetes operator

You can upgrade the NetBackup Kubernetes operator deployment using Helm commands.

Example:

helm upgrade veritas-netbackupkops ./netbackupkops-helm-chart -n netbackup

Add note to backup configmap values if they are changed. Upgrade resets the helm values to default. Old configmap must be patched again after upgrade.

Important notes
  • All components (NBU Primary, Media, Kubernetes operators, and Data mover) must be same version.

  • Existing policies continue to take backups but must be restored manually until the Kubernetes operator is updated.

Note:

This is applicable to the NetBackup version 9.1 to 10.x upgrade

To upgrade the NetBackup Kubernetes operator

  1. Download the tar package from Veritas Support website: https://www.veritas.com/support
  2. Extract the package to the home directory. The netbackupkops-helm-chart folder must be in the home directory.
  3. To list all cluster contexts, run the command: kubectl config get-contexts
  4. To switch to the cluster where you want to deploy the operator service, run the command:kubectl config use-context <cluster-context-name>
  5. To change the current directory to your home directory, run the command: cd ~
  6. NetBackup supports any Container Image Repositories complied to OCI standards. you can use any tools to push the operators and data mover images. If you use a private docker registry, follow the instructions in this step to create a secret nb-docker-cred in NetBackup namespace. Otherwise, skip to the next step.
    • To load the image to the docker cache and push the image to the docker image repository, run the commands:

      • Load the tar file for Netbackup Kubernetes operator.

        <docker load -i <nameof the tar file> ./>

      • Tag the loaded docker image as per requirement.

        docker tag <imagename:tagof the loadedimage> <repo-name/image-name:tag-name>

      • Push the image to a repository from where Kubernetes can fetch the image at the time of NetBackup Kubernetes operator deployment.

        docker push <repo-name/image-name:tag-name>

    Note:

    In the example, a docker is used for reference. You can use any other CLI tool that provides equivalent functionality.

  7. Edit the netbackupkops-helm-chart/values.yaml in a text editor:

    • Replace the image value in the manager section with your image name and tag in the format reponame/image-name:tag-name.

    • Replace the datamover image in the netbackup_config_pod section with datamover image name and tag.

  8. To upgrade the NetBackup Kubernetes operator, run the command:

    helm upgrade <plugin-name> <chart-path> -n <namespace>

    Example:

    helm upgrade veritas-netbackupkops ./netbackupkops-helm-chart -n netbackup

    Note:

    Upgrading the NetBackup Kubernetes operator will reset the Helm values to their defaults. Ensure that you back up the old configmap and reapply any patches if the values change after the upgrade.