Estimate and Backup Plugin Parameters

These plugin parameters are relevant only for Backup and Estimate jobs:

namespace=<name>

specifies a Kubernetes namespace name which you want to backup. Multiple namespace=<name> parameters are allowed if you want to backup multiple namespaces. If a namespace with name can not be found its backup will be silently ignored. If this parameter is not set, all the objects in all namespaces will be saved. If doing a pvcdata backup, the namespace(s) must be specified, and the persistent volume(s) in the specified namespace(s) are included in the backup.

This parameter is required for pvcdata backup. Otherwise, this parameter is optional.

persistentvolume=<name>

specifies a Kubernetes persistent volume configuration you want to backup. Multiple persistentvolume=<name> parameters are allowed if you want to backup multiple volumes. You can use standard shell wildcard pattern matching to select multiple volumes using a single persistentvolume parameter. If a persistent volume with name can not be found its backup will be silently ignored. If this parameter is not set, all persistent volume configurations will be saved unless pvconfig=0 is set as described below.

This parameter is optional.

pvconfig=[0|1]

this option is used to disable persistent volume configuration backups when pvconfig=0 is set. The default is to backup persistent volume configurations.

This parameter is optional.

storageclass=<name>

specifies a Kubernetes Storage Class configuration to be backed up. Multiple storageclass=<name> parameters are allowed if you want to backup multiple objects. You can use standard shell wildcard pattern matching to select multiple volumes using a single storageclass parameter. If a storage class with name can not be found, its backup will be silently ignored. If this parameter is not set, all storage class configuration will be saved unless scconfig=0 is set as described below.

This parameter is optional.

scconfig=[0|1]

this option is used to disable Storage Class configuration backups when scconfig=0 is set. The default is to backup Storage Class object configurations.

This parameter is optional.

pvcdata[=<pvcname1>,<pvcname2>]

specifies a Kubernetes Persistent Volume Claim names you want to make PVC Data archive for. As all PVCs are namespaced objects, to use this option you should specify the required namespace(s) with namespace=<name> parameter. If you define a simple pvcdata parameter without the equals sign (“=”) and subsequent value, all detected persistent volume claims in the specified namespace(s) will be selected for the PVC Data archive backup. You can select several Persistent Volume Claim in this parameter.

This parameter is optional.

backup_mode=[snapshot|clone|standard]

specifies the general backup mode you want to do backup.

Note

The bacula/backup.mode pod annotation has precendence over this parameter in the defined pvcs in the pod.

If none of the parameters above are specified, then all available Namespaces and Persistent Volume Configurations will be backed up. However, the plugin does not force a PVC Data archive backup in this case.