Restore Resource options for Percona Server for MySQL

A Restore resource is a Kubernetes object that tells the Operator how to restore your database from a specific backup. The deploy/backup/restore.yaml file is a template for creating restore resources. It defines the PerconaServerMySQLRestore resource.

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

apiVersion

Specifies the API version of the Custom Resource. ps.percona.com indicates the group, and v1alpha1 is the version of the API.

kind

Defines the type of resource being created: PerconaServerMySQLRestore.

metadata

The metadata part of the deploy/backup/restore.yaml contains metadata about the resource, such as its name and other attributes. It includes the following keys:

• name - The name of the restore object used to identify it in your deployment. You use this name to track the restore operation status and view information about it.

spec

This section includes the configuration of a restore resource.

clusterName

Specifies the name of the Percona Server for MySQL cluster to restore.

Value type	Example
string	ps-cluster1

backupName

Specifies the name of a backup to be used for a restore. This backup should be from the same cluster.

Value type	Example
string	backup1

pitr section

This subsection contains configuration options for point-in-time recovery. When present, the Operator restores the base backup from backupName and then replays binary logs until the requested GTID or timestamp. You must enable point-in-time recovery and configure a Binlog Servr in the cluster; see Point-in-time recovery for details.

pitr.type

The type of point-in-time recovery. Supported values are:

Value	Meaning
gtid	Restore just before the specified GTID target (pitr.gtid).
date	Restore just before the specified timestamp (pitr.date).

Value type	Example
string	gtid

pitr.gtid

The exact GTID set for point-in-time recovery, specified in the format “aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:nnn”. Used when pitr.type is gtid.

Value type	Example
string	3E11FA47-71CA-11E1-9E33-C80AA9429562:1-5

pitr.date

Timestamp string used when pitr.type is date. Specified in the format “yyyy-mm-dd hhss” .

Value type	Example
string	2026-03-30 14:32:00

pitr.force

Forces the mysql client to run with the --force flag and this silently ignores all SQL errors during binlog replay.

Warning: This might result in data loss if underlying replication or data integrity errors are ignored.

Value type	Example
boolean	false

The backupSource subsection

Contains the configuration options to restore from a backup made in a different cluster, namespace, or Kubernetes environment.

backupSource.destination

Specifies the path to the backup on the storage

Value type	Example
string	s3://bucket-name/backup-destination/

backupSource.storage.s3.bucket

Specifies the name of the bucket where the backup that you wish to restore from is saved.

Value type	Example
string

backupSource.storage.s3.credentialsSecret

Specifies the Secrets object name with the credentials to access the storage with a backup.

Value type	Example
string	ps-cluster1-s3-credentials

backupSource.storage.s3.region

The AWS region to use. Please note this option is mandatory for Amazon and all S3-compatible storages.

Value type	Example
string	us-west-2

backupSource.storage.type

Specifies the type of the backup storage. Available options: s3, azure.

Value type	Example
string	s3

containerOptions.env

The environment variables set as key-value pairs for the restore job.

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

containerOptions.args.xtrabackup

Custom command line options for the xtrabackup Percona XtraBackup tool .

Value type	Example
subdoc	- “–someflag=abc”

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: April 17, 2026
Created: April 17, 2026