Generic Plugin Parameters

The following Kubernetes Plugin parameters affect any type of Job (Backup, Estimate, or Restore).

abort_on_error[=<0 or 1>]

specifies whether or not the plugin should abort execution (and the Bacula Job) if a fatal error occurs during a Backup, Estimate, or Restore operation. If not specified, the default value is 0.

This parameter is optional.

config=</path/to/file>

specifies the path to the configuration file used to connect to the Kubernetes cluster. Refer to the Kubernetes documentation for more information about the kubeconfig file. If this directive is omitted and no other access method is configured, the default configuration file location will be used: $HOME/.kube/config.

This parameter is optional.

incluster

if defined, standard in-cluster access to the Kubernetes API is used. This option should be used only when the Bacula File Daemon and Kubernetes Plugin are deployed as a Kubernetes cluster service in a Pod. In this case, Kubernetes automatically provides the required access credentials. This option does not work when executed outside of a Kubernetes cluster.

This parameter is optional.

host=<url-k8s-api>

defines a Kubernetes API url. This option must be used together with the token parameter described below. If this option is specified, then both parameters are required.

This parameter is optional.

token=<bearer-token>

defines a Bearer token used for authorization to the Kubernetes API defined by host=<url-k8s-api>. This option must be used together with the host parameter described above. You can read more about Bearer token authentication here: https://swagger.io/docs/specification/authentication/bearer-authentication/

This parameter is optional.

verify_ssl[=<0 or 1>]

specifies whether the plugin should verify a Kubernetes API certificate when the connection uses SSL/TLS. If set to verify_ssl=0, verification is disabled. This can be useful when connecting to a Kubernetes API server that uses a self-signed certificate. By default, if this parameter is not set, proper certificate validation is performed by default.

This parameter is optional.

ssl_ca_cert=</path/to/file>

specifies a file with the CA certificate used to customize the Kubernetes API server identity to verify the peer.

This parameter is optional.

debug[=1,2,3]

enables generation of a backend debug file at the following location: /bacula/working/kubernetes/. The debug file can assist with troubleshooting job execution issues. If not defined, no debug file is generated. Starting from version 16.0.14, multiple debug levels are available. Each higher level includes the information from the previous levels.

1: Save debug messages of k8s server interactions. 2: Save communication messages with bacula core except data packages. From version 18.0.9, this debug level also includes relevant information about the Kubernetes environment like: namespaces, storage classes, pvcs and their pvs. 3: Save all debug messages.

This parameter is optional. Normally, the level 2 is enough to open support cases.