NetBackup™ for Kubernetes Administrator's Guide
- Overview of NetBackup for Kubernetes
- Deploying and configuring the NetBackup Kubernetes operator
- Prerequisites for NetBackup Kubernetes Operator deployment
- Deploy service package on NetBackup Kubernetes operator
- Port requirements for Kubernetes operator deployment
- Upgrade the NetBackup Kubernetes operator
- Delete the NetBackup Kubernetes operator
- Configure NetBackup Kubernetes data mover
- Automated configuration of NetBackup protection for Kubernetes
- Customize Kubernetes workload
- Troubleshooting NetBackup servers with short names
- Data mover pod schedule mechanism support
- Validating accelerator storage class
- Deploying certificates on NetBackup Kubernetes operator
- Managing Kubernetes assets
- Managing Kubernetes intelligent groups
- Managing Kubernetes policies
- Protecting Kubernetes assets
- Managing image groups
- Protecting Rancher managed clusters in NetBackup
- Recovering Kubernetes assets
- About incremental backup and restore
- Enabling accelerator based backup
- Enabling FIPS mode in Kubernetes
- About Openshift Virtualization support
- Troubleshooting Kubernetes issues
- Error during the primary server upgrade: NBCheck fails
- Error during an old image restore: Operation fails
- Error during persistent volume recovery API
- Error during restore: Final job status shows partial failure
- Error during restore on the same namespace
- Datamover pods exceed the Kubernetes resource limit
- Error during restore: Job fails on the highly loaded cluster
- Custom Kubernetes role created for specific clusters cannot view the jobs
- Openshift creates blank non-selected PVCs while restoring applications installed from OperatorHub
- NetBackup Kubernetes operator become unresponsive if PID limit exceeds on the Kubernetes node
- Failure during edit cluster in NetBackup Kubernetes 10.1
- Backup or restore fails for large sized PVC
- Restore of namespace file mode PVCs to different file system partially fails
- Restore from backup copy fails with image inconsistency error
- Connectivity checks between NetBackup primary, media, and Kubernetes servers.
- Error during accelerator backup when there is no space available for track log
- Error during accelerator backup due to track log PVC creation failure
- Error during accelerator backup due to invalid accelerator storage class
- Error occurred during track log pod start
- Failed to setup the data mover instance for track log PVC operation
- Error to read track log storage class from configmap
Deploy service package on NetBackup Kubernetes operator
You can use the Helm chart to deploy the NetBackup Kubernetes operator.
You must upgrade a helm chart to upgrade NetBackup Kubernetes operator.
Note:
Before installing a new plug-in, you must uninstall the older plug-in.
To deploy NetBackup Kubernetes operator:
- Download the tar package from the Cohesity Technical Support website: https://www.veritas.com/content/support
- Extract the package to the home directory. The
netbackupkops-helm-chartfolder should be in the home directory. - To list all cluster contexts, run the command: kubectl config get-contexts
- To switch to the cluster where you want to deploy the operator service, run the command:
kubectl config use-context <cluster-context-name>
- To change the current directory to your home directory, run the command: cd ~
- 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-credin 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.jsonfile containing the authorization token is created or updated. To view theconfig.jsonfile, run the command: cat ~/.docker/config.jsonThe output looks like:
{ "auths": { "https://index.docker.io/v1/": { "auth": "c3R...zE2" } } }To create a secret named as
netbackupkops-docker-credin 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-credis 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.
- 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.
- 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: 10GiDuring 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.
- 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.
- To check the status of the deployment, run the command:
helm list -n <namespace which runs NetBackup operator service >
Example:
helm list -n netbackup
- 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