Restore from a backup to a new Kubernetes-based environment¶

You can restore from a backup as follows:

On the same Kubernetes cluster where you made the backup
On a new cluster deployed in a different Kubernetes-based environment.

This document focuses on the restore on a new cluster deployed in a different Kubernetes environment.

Preconditions¶

When restoring to a new Kubernetes-based environment, make sure it has a Secrets object with the same user passwords as in the source cluster.

You can export the user Secret from the source cluster and create a Secrets object on the target one. Here’s how to do it:

Find the secret name. Run this command on the cluster where you made the backup:

kubectl get ps ps-cluster1 -n $NAMESPACE -o jsonpath='{.spec.secretsName}'

Expected output

ps-cluster1-secrets

Export the secret to a file:

kubectl get secrets -n $NAMESPACE ps-cluster1-secrets -o yaml > ps-cluster1-secrets.yaml

Remove the annotations, labels, creationTimestamp, resourceVersion, selfLink, uid and namespace metadata fields from the resulting file to make it ready for the source cluster. Use the following script to do it:

yq eval 'del(.metadata.ownerReferences, .metadata.annotations, .metadata.labels, .metadata.creationTimestamp, .metadata.resourceVersion, .metadata.selfLink, .metadata.uid, .metadata.namespace)' ps-cluster1-secrets.yaml > ps-cluster1-secrets-target.yaml

Expected output

apiVersion: v1
data:
  heartbeat: MUBra1Z2IWRNVjNFe0lJM3o=
  monitor: b1k3IyxyWns8eGxVSmFfTiU=
  operator: XT8oYWVhQnd3Sk5FeVdbJg==
  orchestrator: ZF8yXy04PGNTTSl4Qk5ZdFU=
  replication: JFZxVUF4XjBvOFJoI0hPbjZS
  root: QGckTSQtMF9ZeUlYWzV3UWIp
  xtrabackup: REZtVGNbTW5fKUVMfTUqRSEo
kind: Secret
metadata:
  name: my-db-ps-db-secrets
type: Opaque

On the target cluster, create the Secrets object. Replace the <namespace> with your value:
```
kubectl apply -f ps-cluster1-secrets-target.yaml -n <namespace>
```

Before you begin¶

Export the namespace as an environment variable. Replace the <namespace> placeholder with your value:
```
export NAMESPACE = <namespace>
```
Make sure that the cluster is running. Use this command to check it:
```
kubectl get ps <cluster-name> -n $NAMESPACE
```
List backups on the source cluster with the following command:
```
kubectl get ps-backup -n $NAMESPACE
```

Restore from a backup¶

Configure the PerconaServerMySQLRestore Custom Resource. Specify the following keys:

set spec.clusterName key to the name of the target cluster to restore the backup on

configure the spec.backupSource subsection to point to the cloud storage where the backup is stored. This subsection should include:

a destination key. Take it from the output of the kubectl get ps-backup command

the necessary storage configuration keys, just like in the deploy/cr.yaml file of the source cluster.

S3-compatible storageAzure Blob storageGoogle Cloud Storage

apiVersion: ps.percona.com/v1
kind: PerconaServerMySQLRestore
metadata:
  name: restore1
spec:
  clusterName: ps-cluster1
  backupSource:
    destination: s3://S3-BUCKET-NAME/BACKUP-NAME
    s3:
      bucket: S3-BUCKET-NAME
      credentialsSecret: ps-cluster1-s3-credentials
      region: us-west-2
      endpointUrl: https://URL-OF-THE-S3-COMPATIBLE-STORAGE
      ...
    type: s3

apiVersion: ps.percona.com/v1
kind: PerconaServerMySQLRestore
metadata:
  name: restore1
spec:
  clusterName: ps-cluster1
  backupSource:
    destination: AZURE-CONTAINER-NAME/BACKUP-NAME
    type: azure
    azure:
      container: AZURE-CONTAINER-NAME
      credentialsSecret: ps-cluster1-azure-credentials
      ...

apiVersion: ps.percona.com/v1
kind: PerconaServerMySQLRestore
metadata:
  name: restore1
spec:
  clusterName: ps-cluster1
  backupSource:
    destination: gs://BUCKET-NAME/BACKUP-NAME
    storage:
      gcs:
        bucket: operator-testing
        credentialsSecret: ps-cluster1-gcp-credentials
      type: gcs

Start the restore:

kubectl apply -f deploy/backup/restore.yaml -n $NAMESPACE

View restore details¶

When you start the restore, the restore job is created. You can check the job details using these commands:

kubectl get job

Sample output

xb-restore-restore2                                Running    0/1                      0s
xb-restore-restore2                                Complete             1/1           25s        25s

You can check the restore progress with this command:

kubectl get ps-restore -n $NAMESPACE

Troubleshooting¶

If you face issues with restore, refer to our Restore troubleshooting guide for help.

Last update: 2025-11-17