PerconaXtraDBClusterBackup Custom Resource options

A Backup resource is a Kubernetes object that tells the Operator how to backup your database. The deploy/backup/backup.yaml file is a template for creating backup resources.

It defines the PerconaXtraDBClusterBackup resource.

This document describes all available options that you can use to customize a backup.

apiVersion

Specifies the API version of the Custom Resource. pxc.percona.com indicates the group, and v1 is the version of the API.

kind

Defines the type of resource being created: PerconaXtraDBClusterBackup.

metadata

The metadata part contains the following keys:

• name sets the name of your backup resource;

• finalizers subsection:

  • percona.com/delete-backup if present, enables deletion of backup files from a backup storage when the backup object is removed (manually or by schedule). When used with the Persistent Volume as the backup storage, the finalizer deletes the PVC.

spec section

The toplevel spec elements of the deploy/backup/backup.yaml are the following ones:

pxcCluster

The name of the Percona XtraDB Cluster to back up.

Value type	Example
string	cluster1

storageName

The name of the storage configuration defined in your deploy/cr.yaml file in the spec.backup.storages subsection.

Value type	Example
string	fs-pvc

activeDeadlineSeconds

The timeout value in seconds, after which backup job will automatically fail.

Value type	Example
int	3600

startingDeadlineSeconds

The maximum time in seconds for a backup to reach the Starting state. The Operator compares the timestamp of the backup object against the current time. If the backup is not started within the set time, the Operator automatically marks it as “failed”.

Value type	Example
int	300

suspendedDeadlineSeconds

The maximum time in seconds for a backup to remain in a suspended state. The Operator compares the timestamp when the backup job was suspended against the current time. After the defined suspension time expires, the backup is automatically marked as “failed”.

Value type	Example
int	1200

runningDeadlineSeconds

The maximum time in seconds for a backup job to reach the Running state. The Operator compares the timestamp when the backup job started running against the current time. After the defined running time expires, the backup is automatically marked as “failed”.

Value type	Example
int	300

containerOptions.env

The environment variables set as key-value pairs for the backup container.

Value type	Example
subdoc	- name: VERIFY_TLS value: “false”

containerOptions.args.xbcloud

Custom command line options for the xbcloud Percona XtraBackup tool.

Value type	Example
subdoc	- “–someflag=abc”

containerOptions.args.xbstream

Custom command line options for the xbstream Percona XtraBackup tool.

Value type	Example
subdoc	- “–someflag=abc”

---

Last update: December 4, 2025
Created: December 4, 2025