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

Kubernetes operators supported configuration parameters

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 Resource 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 Resource 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 Resource 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 Resource 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 Resource 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 Resource 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 Resource 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