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
Customize Kubernetes workload
To get the configuration values, run the following command:
kubectl get configmaps <namespace>-backup-operator-configuration -n <namespace> -o yaml > {local.file}.
To edit the configuration, run the following command:
kubectl edit cm<backup-operator-configmap> -n <kops-namespace>.
Set the VirtualMachine=false to disable the auto discovery of the assets.
Note:
NetBackup allows you to edit only the VirtualMachine parameter under the Resources section.
Note:
To get the configuration value, you can run the command: kubectl get configmaps <namespace>-backup-operator-configuration -n <namespace> -o yaml > {local.file}
Table: Kubernetes operators supported configuration parameters in <namespace>-backup-operator-configuration
Configuration | Description | Default value | Possible value | |
|---|---|---|---|---|
daemonsets | If value is set to false this resource are discovered and backed up. But the resources will not be visible in the section when you click on Kubernetes namespace in NetBackup web UI. | true | true, false | |
deployments | If value is set to false this resource are discovered and backed up. But the resources will not be visible in the section when you click on Kubernetes namespace in NetBackup web UI. | true | true, false | |
pods | If value is set to false this resource are discovered and backed up. But the resources will not be visible in the section when you click on Kubernetes namespace in NetBackup web UI. | true | true, false | |
replicasets | If value is set to false this resource are discovered and backed up. But the resources will not be visible in the section when you click on Kubernetes namespace in NetBackup web UI. | true | true, false | |
secrets | If value is set to false this resource are discovered and backed up. But the resources will not be visible in the section when you click on Kubernetes namespace in NetBackup web UI. | true | true, false | |
services | If value is set to false this resource are discovered and backed up. But the resources will not be visible in the section when you click on Kubernetes namespace in NetBackup web UI. | true | true, false | |
namespace | Kubernetes operator is deployed in the namespace. If value is set to false this resource are discovered and backed up. But the resources will not be visible in the section when you click on Kubernetes namespace in NetBackup web UI. | Any name given to a namespace. | NetBackup namespace. | |
cleanStaleCRDurationMinutes | Time duration after a CR job is invoked to clean stale CRs. The interval after which stale custom resource cleanup job is triggered. For long running Backup from snapshot and Restore from backup jobs, you need to increase the cleanStaleCRDurationMinutes value. | 1440 minutes | Any values in minutes | |
ttlCRDurationMinutes | TTL CR duration | 30240 minutes | 30240 minutes | |
fipsMode | Configuration to enable FIPS_MODE in Netbackup Kubernetes Operator and data mover. | DISABLE | ENABLE, DISABLE | |
livesnessProbeInitialDelay | Probe initial delay period. | 60 seconds | 60 minutes | |
livenessProbeTimeoutInSeconds | On loaded machine, liveness probe execution might take more than 1 second, User can increase this value in-order to stop failures due liveness probe timeout errors. | 1 Second | 1 to 5 Seconds. | |
livenessProbePeriodInSeconds | Probe period. | 180 seconds | Any value in seconds | |
checkNbcertdaemonStatusDurationMinutes | NB certificate daemon status duration. | 1440 minutes | 1440 minutes | |
collectDataMoverLogs | Due to high memory usage in datamover logs collection, it is recommended to enable the logs only when you are debugging, troubleshooting, or restarting the pods. Before enabling the logs for datamover, ensure to increase the memory limits for NetBackup Kubernetes pod to at least 2 GB or more. After the debugging or troubleshooting is done, you can reset to the previous or the default value. Note: Granular support is provided for collecting datamover logs only in case of failed jobs. It provides an additional level of granularity layer, All/FailedOnly/Off. | Failed | All, Failed, None | |
maxRetentionDataMoverLogsInHours | Maximum retention for datamover logs. | 24 hours | 72 hours | |
maxRetentionDataMoverInHours | It removes all the datamover resources that are older than the specified time. | 24 hours | Any value in hours | |
cleanStaleCertFilesDurationMinutes | The interval after which stale certificate files cleanup job is triggered. | 60 minutes | 1440 minutes | |
maxRetentionInDiscoveryCacheHours | It is the time in hours that decides the time interval for keeping the discovery cache. | 24 hours | 48 hours | |
pollingTimeoutInMinutes | It is the timeout that keeps retrying till it expires and fails. | 15 minutes | Any value in minutes | |
pollingFrequencyInSecs | Polling frequency. | 5 seconds | Any value in seconds | |
nbcertPrerequisteDirectoryAndFiles | NBCA prerequisites. | Certificate name | Certificate name | |