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

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

---

Last update: 2025-05-20