NetBackup™ Web UI Kubernetes Administrator's Guide

Last Published:
Product(s): NetBackup (10.1.1)
  1. Overview of NetBackup for Kubernetes
    1.  
      Overview
    2.  
      Features of NetBackup support for Kubernetes
  2. Deploying and configuring the NetBackup Kubernetes operator
    1.  
      Deploy service package on NetBackup Kubernetes operator
    2.  
      Port requirements for Kubernetes operator deployment
    3.  
      Upgrade the NetBackup Kubernetes operator
    4.  
      Delete the NetBackup Kubernetes operator
    5.  
      Configure NetBackup Kubernetes datamover
    6. 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
    7.  
      Troubleshooting NetBackup servers with short names
  3. Managing image groups
    1. About image groups
      1.  
        Image expire
      2.  
        Image copy
  4. 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
  5. Managing Kubernetes assets
    1.  
      Add a Kubernetes cluster
    2. Configure settings
      1.  
        Configure resource limit settings
      2.  
        Configure autodiscovery frequency
      3.  
        Configure permissions
    3.  
      Add protection to the assets
    4.  
      FileMode volume support
  6. Managing Kubernetes intelligent groups
    1.  
      About intelligent group
    2.  
      Create an intelligent group
    3.  
      Delete an intelligent group
    4.  
      Edit an intelligent group
  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 (AIR) and duplication
    7.  
      Configure storage units
    8.  
      FileMode volume support
  8. Recovering Kubernetes assets
    1.  
      Explore and validate recovery points
    2.  
      Restore from snapshot
    3.  
      Restore from backup copy
  9. 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.  
      Restore from snapshot 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

Deploy service package on NetBackup Kubernetes operator

Before deploying the NetBackup Kubernetes operator, you must install the Helm chart and provide space for persistent volume.

To install the latest Helm version, run the following commands:

  1. #curl -k -fsSL -o get_helm.sh https://raw.githubusercontent.com/helm

  2. #chmod +x get_helm.sh

  3. #./get_helm.sh

You must deploy the operator in each cluster, where you want to deploy NetBackup.

Configuring the Helm chart

You can use the Helm chart to deploy the NetBackup Kubernetes operator.

You must upgrade a helm chart to upgrade NetBackup Kubernetes operator.

To upgrade the Helm chart

  • To upgrade the Helm chart, run the command:
    • helm upgrade <plugin-name> -n <namespace>

Note:

Before installing a new plug-in, you must uninstall the older plug-in.

To install a new Helm chart

  1. To uninstall an older plug-in, run the command:
    • helm uninstall <plugin-name> -n <namespace>

  2. To install a new plug-in, run the command:
    • helm install <plugin-name> <chart-path> -n <namespace>

Here is the Helm chart and tree structure layout:

netbackupkops-helm-chart

   ├── charts
   ├── Chart.yaml
   ├── templates
   │   └── deployment.yaml
   └── values.yaml

Directory structure:

tar --list -f netbackupkops-10.1.1.tar.gz
veritas_license.txt
netbackupkops-helm-chart/
netbackupkops-helm-chart/Chart.yaml
netbackupkops-helm-chart/Values.yaml
netbackupkops-helm-chart/.helmignore
netbackupkops-helm-chart/templates
netbackupkops-helm-chart/templates/development.yaml
netbackupkops-helm-chart/Charts/

To deploy the NetBackup Kubernetes operator:

  1. Download the tar package from Veritas Support website: https://www.veritas.com/content/support
  2. Extract the package to the home directory. The netbackupkops-helm-chart folder should 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 compiled to OCI standards. you can use any tools to push the operators and datamover 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 log on to the private docker registry, run the command: docker login -u <user name><repo-name>

      After log in, the config.json file containing the authorization token is created or updated. To view the config.json file, run the command: cat ~/.docker/config.json

      The output looks like:

      {
         "auths": {
             "https://index.docker.io/v1/": {
                 "auth": "c3R...zE2"
            }
         }
      }
    • To create a secret named as netbackupkops-docker-cred in the NetBackup namespace, run the command:

      kubectl create secret generic netbackupkops-docker-cred \

      --from-file=.dockerconfigjson=.docker/config.json \

      --type=kubernetes.io/dockerconfigjson -n netbackup

      You can provide any namespace to create a secret.

    • To check if the secret netbackupkops-docker-cred is created in the NetBackup namespace, run the command:

      kubectl get secrets -n netbackup

    • To load the image to the docker cache and push the image to the docker image repository, run the commands:

      docker load -i <name of the tar file>./

      docker tag <image name:tag of the loaded image>

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

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

  7. Open the netbackupkops-helm-chart/values.yaml file in a text editor and then replace the value for image in the manager section, with your image name and tag repo-name/image-name:tag-name and then save the file.
  8. To deploy the NetBackup Kubernetes operator service, run the command:

    helm install <release name of the deployment> ./netbackupkops-helm-chart -n <namespace which runs NetBackup operator service>

    Example: helm install veritas-netbackupkops ./netbackupkops-helm-chart -n netbackup

    • You can change the release name of the deployment as required.

    • The -n option is required to specify the namespace in which NetBackup operator service and NetBackup is intended to run.

  9. To check the status of the deployment, run the command:

    helm list -n <namespace which runs NetBackup operator service >

    Example:

    helm list -n netbackup

  10. To check the release history, run the command:

    helm history veritas-netbackupkops -n

    <namespace which runs NetBackup operator service>.

    Example:

    helm history veritas-netbackupkops -n netbackup