NetBackup™ for Kubernetes Administrator's Guide

To deploy 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 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 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:

     • 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 Docker is used for reference. You can use any other CLI tool which provides equivalent functionality.

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

   • replace the value for image in the manager section, with your image name and tag repo-name/image-name:tag-name.

   • Change the value of replicas to 0.

     Note:

     Setting replicas to 0 as we are following manual steps to configure the Netbackup Kubernetes Operator.

8. Sizing for metadata persistent volume is required. The default persistent volume size for Kubernetes operator is 10Gi. The persistent volume size is configurable.

   You can change the value for storage from 10Gi to a higher value before deploying the plugin. This leads to the nbukops pod have the size of the PVC mounted in the pod.

   You can specify metadata persistent volume size in values.yaml.

   Persistent Volume Claim in deployment.yaml under helm-chart looks like this :

   apiVersion: v1
   kind: PersistentVolumeClaim
   metadata:
     labels:
       component: netbackup
     name: {{ .Release.Namespace }}-netbackupkops
     namespace: {{ .Release.Namespace }}
   spec:
     accessModes:
     - ReadWriteOnce
     resources:
       requests:
         storage: 10Gi
   

   • During fresh installation while configuring the Helm Chart. You can modify the size of PVC storage in the deployment.yaml of the netbackupkops-helm-chart which leads to creation of the initial PVC size.

   • Post installation, updating the PVC size (dynamic volume expansion) is supported by few storage vendors. For more information, refer to https://kubernetes.io/docs/concepts/storage/persistent-volumes

   Note:

   The default size of persistent volume can be resized to larger value without losing the data. You are recommended to add the storage provider that supports volume expansion.

9. 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.

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

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

    Example:

    helm list -n netbackup

11. 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