K8SPG-771: Backup snapshots by mayankshah1607 · Pull Request #1418 · percona/percona-postgresql-operator

mayankshah1607 · 2026-01-21T17:25:22Z

Due to the high volume of requests, we're unable to provide free service for this account. To continue using the service, please upgarde to a paid plan.

CHANGE DESCRIPTION

Adds support for taking backups using VolumeSnapshots API. VolumeSnapshots enable fast backups directly via the CSI driver.

This PR adds support for offline snapshot backups.

Enable snapshots for your cluster

apiVersion: pgv2.percona.com/v2
kind: PerconaPGCluster
metadata:
  name: cluster1
spec:
  backups:
    volumeSnapshots:
      mode: offline
      className: VOLUME-SNAPSHOT-CLASS

Trigger a snapshot backup via PerconaPGBackup:

apiVersion: pgv2.percona.com/v2
kind: PerconaPGBackup
metadata:
  name: backup1
spec:
  pgCluster: cluster1
  method: volumeSnapshot

The operator will:

Select a healthy replica pod and temporarily suspend it.
Create VolumeSnapshots of its data PVC
Resume the suspended replica

To take scheduled snapshots:

Enable snapshots for your cluster

apiVersion: pgv2.percona.com/v2
kind: PerconaPGCluster
metadata:
  name: cluster1
spec:
  backups:
    volumeSnapshots:
      mode: offline
      className: VOLUME-SNAPSHOT-CLASS
      schedule: "0 0 * * 6"

To restore a snapshot in-place, you may do so using PerconaPGRestore:

apiVersion: pgv2.percona.com/v2
kind: PerconaPGRestore
metadata:
  name: restore3
spec:
  pgCluster: cluster1
  volumeSnapshotBackupName: backup1

It is also possible to restore a snapshot and perform PiTR using pgbackrest, as long as backups in both sources belong to the same timeline:

apiVersion: pgv2.percona.com/v2
kind: PerconaPGRestore
metadata:
  name: restore3
spec:
  pgCluster: cluster1
  repoName: repo1
  volumeSnapshotBackupName: backup1
  options:
  - --type=time
  - --target="2026-02-09 10:17:51.899712+0000"

Restoring to a new cluster can be done by directly specifying the dataSource in the instance volume claim spec:

apiVersion: pgv2.percona.com/v2
kind: PerconaPGCluster
metadata:
  name: cluster1
spec:
  crVersion: 2.9.0
instances:
- name: instance1
   dataVolumeClaimSpec:
      accessModes:
      - ReadWriteOnce
      resources:
        requests:
          storage: 1Gi
     dataSource:
       apiGroup: snapshot.storate.k8s.io
       kind: VolumeSnapshot
       name: SNAPSHOT-NAME

Later we plan to add support for an online mode where the operator can perform a snapshot on a live primary without suspending it.

CHECKLIST

Jira

Is the Jira ticket created and referenced properly?
Does the Jira ticket have the proper statuses for documentation (Needs Doc) and QA (Needs QA)?
Does the Jira ticket link to the proper milestone (Fix Version field)?

Tests

Is an E2E test/test case added for the new feature/change?
Are unit tests added where appropriate?

Config/Logging/Testability

Are all needed new/changed options added to default YAML files?
Are all needed new/changed options added to the Helm Chart?
Did we add proper logging messages for operator actions?
Did we ensure compatibility with the previous version or cluster upgrade process?
Does the change support oldest and newest supported PG version?
Does the change support oldest and newest supported Kubernetes version?

Signed-off-by: Mayank Shah <mayank.shah@percona.com>

CLAassistant · 2026-01-21T17:25:38Z

All committers have signed the CLA.

Signed-off-by: Mayank Shah <mayank.shah@percona.com>

percona/watcher/wal.go

pkg/apis/pgv2.percona.com/v2/perconapgcluster_types.go

Signed-off-by: Mayank Shah <mayank.shah@percona.com>

Copilot

Pull request overview

Copilot reviewed 77 out of 80 changed files in this pull request and generated no new comments.

Comments suppressed due to low confidence (1)

pkg/apis/pgv2.percona.com/v2/perconapgcluster_types.go:1

Corrected spelling of 'storate' to 'storage.k8s.io' in the PR description example.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

egegunes · 2026-02-12T05:37:16Z

build/postgres-operator/restore-command-wrapper.sh

@@ -1,10 +1,9 @@
-#!/bin/bash
+#!/bin/sh


any reason to do this?

We don't need any bash-specific features in this script, so using /bin/sh is better for portability (even though our images are expected to support bash). Do you think we need bash?

egegunes · 2026-02-12T05:39:01Z

percona/controller/pgbackup/snapshots/offline.go

+		return "", errors.Wrap(err, "failed to get backup target pod")
+	}
+
+	// TODO: should this be optional, since this can take a while on large datasets?


Yeah I discussed this with PG team yesterday and looks like it can (and should) be made optional

egegunes · 2026-02-12T05:39:22Z

percona/controller/pgbackup/snapshots/offline.go

+
+func (e *offlineExec) checkpoint(ctx context.Context, instanceName string) error {
+	exec := func(_ context.Context, stdin io.Reader, stdout, stderr io.Writer, command ...string) error {
+		return e.podExec(ctx, e.cluster.GetNamespace(), instanceName+"-0", naming.ContainerDatabase, stdin, stdout, stderr, command...)


I see, thank you

Signed-off-by: Mayank Shah <mayank.shah@percona.com>

Copilot

Pull request overview

Copilot reviewed 77 out of 80 changed files in this pull request and generated 1 comment.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-02-12T11:35:43Z

percona/controller/pgbackup/controller.go

+	if ptr.Deref(pgBackup.Spec.RepoName, "") == "" {
+		if updErr := pgBackup.UpdateStatus(ctx, r.Client, func(bcp *v2.PerconaPGBackup) {
+			bcp.Status.State = v2.BackupFailed
+			bcp.Status.Error = "repoName is required when method is 'pgbackrest'"
+		}); updErr != nil {
+			return reconcile.Result{}, fmt.Errorf("failed to update backup status: %w", updErr)
 		}
-		pgCluster = nil
+		return reconcile.Result{}, errors.New("'repoName' is required when method is 'pgbackrest'")
 	}


After setting the backup status to BackupFailed for missing repoName, the reconciler returns a non-nil error. This will cause unnecessary error logs/requeues even though the failure is already persisted in status. Consider returning reconcile.Result{} with nil error (or a normal requeue delay if you need finalizers to run) after updating the status.

Copilot

Pull request overview

Copilot reviewed 77 out of 80 changed files in this pull request and generated 5 comments.

pkg/apis/pgv2.percona.com/v2/perconapgrestore_types.go

percona/controller/pgbackup/snapshots/offline.go

percona/controller/pgrestore/snapshot/reconcile.go

percona/controller/pgbackup/snapshots/reconcile.go

percona/controller/pgbackup/controller.go

Signed-off-by: Mayank Shah <mayank.shah@percona.com>

Copilot

Pull request overview

Copilot reviewed 77 out of 80 changed files in this pull request and generated 1 comment.

Copilot · 2026-02-13T09:39:03Z

percona/controller/pgbackup/snapshots/offline.go

+		return fmt.Errorf("checkpoint failed: %s", stderr)
+	}
+
+	log.Info("checkpoint executed", "stdout", stdout, "stderr", stderr)


The logging for successful checkpoint (line 105) includes both stdout and stderr, which could potentially log sensitive information. While checkpoint output is typically safe, consider whether logging the full output is necessary or if a simple success message would suffice.

JNKPercona · 2026-02-13T16:09:19Z

Test Name	Result	Time
backup-enable-disable	passed	00:07:04
builtin-extensions	passed	00:05:11
custom-envs	passed	00:18:40
custom-extensions	passed	00:13:47
custom-tls	passed	00:04:50
database-init-sql	passed	00:02:21
demand-backup	passed	00:24:04
demand-backup-offline-snapshot	passed	00:13:47
finalizers	passed	00:03:51
init-deploy	passed	00:02:45
huge-pages	passed	00:03:06
monitoring	passed	00:06:48
monitoring-pmm3	passed	00:08:26
one-pod	passed	00:05:43
operator-self-healing	passed	00:08:00
pitr	passed	00:11:29
scaling	passed	00:05:12
scheduled-backup	passed	00:25:28
self-healing	passed	00:08:54
sidecars	passed	00:02:35
standby-pgbackrest	passed	00:11:48
standby-streaming	passed	00:09:14
start-from-backup	passed	00:10:29
tablespaces	passed	00:07:02
telemetry-transfer	passed	00:03:30
upgrade-consistency	passed	00:05:18
upgrade-minor	passed	00:05:02
users	passed	00:04:44

Summary	Value
Tests Run	28/28
Job Duration	01:32:41
Total Test Time	03:59:25

commit: 216ebbe
image: perconalab/percona-postgresql-operator:PR-1418-216ebbe23

mayankshah1607 added 11 commits January 21, 2026 10:11

wip: add fencing mechanism

5c9506a

Signed-off-by: Mayank Shah <mayank.shah@percona.com>

rename to suspended-instances

c021fb2

Signed-off-by: Mayank Shah <mayank.shah@percona.com>

add BackupSnapshots feature gate

6043b7a

Signed-off-by: Mayank Shah <mayank.shah@percona.com>

implement reconciler logic

93c732b

Signed-off-by: Mayank Shah <mayank.shah@percona.com>

implement offline executor

bb96b8a

Signed-off-by: Mayank Shah <mayank.shah@percona.com>

naming improvements

22cb071

Signed-off-by: Mayank Shah <mayank.shah@percona.com>

add to scheme

478f8d9

Signed-off-by: Mayank Shah <mayank.shah@percona.com>

fix reconcile state

8bff157

Signed-off-by: Mayank Shah <mayank.shah@percona.com>

bug fixes and improvements

0c906ea

Signed-off-by: Mayank Shah <mayank.shah@percona.com>

naming improvements and fixes

77a96b6

Signed-off-by: Mayank Shah <mayank.shah@percona.com>

ran make generate

7f0587f

Signed-off-by: Mayank Shah <mayank.shah@percona.com>

mayankshah1607 and others added 10 commits January 22, 2026 10:30

fix PGBackup field validations

7b33275

Signed-off-by: Mayank Shah <mayank.shah@percona.com>

refactors and stability improvements

7e412fe

Signed-off-by: Mayank Shah <mayank.shah@percona.com>

update cr.yaml examples

d30df00

Signed-off-by: Mayank Shah <mayank.shah@percona.com>

Merge branch 'main' into K8SPG-771

ff0059c

organize imports

0e2537c

Signed-off-by: Mayank Shah <mayank.shah@percona.com>

misspells

1a551b1

Signed-off-by: Mayank Shah <mayank.shah@percona.com>

improve fencing logic

d4e09b5

Signed-off-by: Mayank Shah <mayank.shah@percona.com>

add extra validation

cdb8f43

Signed-off-by: Mayank Shah <mayank.shah@percona.com>

improvements to suspended logic

c53a00a

Signed-off-by: Mayank Shah <mayank.shah@percona.com>

finalizer renaming

77bb6a8

Signed-off-by: Mayank Shah <mayank.shah@percona.com>

egegunes reviewed Jan 23, 2026

View reviewed changes

percona/watcher/wal.go Outdated Show resolved Hide resolved

pkg/apis/pgv2.percona.com/v2/perconapgcluster_types.go Outdated Show resolved Hide resolved

mayankshah1607 added 7 commits January 23, 2026 11:48

remove enabled field

c8a2daa

Signed-off-by: Mayank Shah <mayank.shah@percona.com>

implement snapshot schedules

808fd85

Signed-off-by: Mayank Shah <mayank.shah@percona.com>

linting

ef509d7

Signed-off-by: Mayank Shah <mayank.shah@percona.com>

implement in-place restore

2d93ca5

Signed-off-by: Mayank Shah <mayank.shah@percona.com>

update cr.yaml example

78032c4

Signed-off-by: Mayank Shah <mayank.shah@percona.com>

linting

bf04199

Signed-off-by: Mayank Shah <mayank.shah@percona.com>

no need to use configmap to track

581a629

Signed-off-by: Mayank Shah <mayank.shah@percona.com>

mayankshah1607 added 3 commits February 11, 2026 18:26

remove duplicate code

b4910f5

Signed-off-by: Mayank Shah <mayank.shah@percona.com>

use fmt.Errorf

3d314a2

Signed-off-by: Mayank Shah <mayank.shah@percona.com>

catch potential nil error

e20a3cb

Signed-off-by: Mayank Shah <mayank.shah@percona.com>

Copilot AI review requested due to automatic review settings February 11, 2026 13:02

Copilot started reviewing on behalf of mayankshah1607 February 11, 2026 13:03 View session

Copilot AI reviewed Feb 11, 2026

View reviewed changes

egegunes reviewed Feb 12, 2026

View reviewed changes

allow skipping checkpointing

4e2203c

Signed-off-by: Mayank Shah <mayank.shah@percona.com>

mayankshah1607 requested review from egegunes and gkech February 12, 2026 10:59

Merge branch 'main' into K8SPG-771

05386e1

Copilot AI review requested due to automatic review settings February 12, 2026 11:28

Copilot started reviewing on behalf of mayankshah1607 February 12, 2026 11:29 View session

Copilot AI reviewed Feb 12, 2026

View reviewed changes

egegunes added this to the v2.9.0 milestone Feb 12, 2026

Merge branch 'main' into K8SPG-771

df83311

egegunes previously approved these changes Feb 13, 2026

View reviewed changes

mayankshah1607 requested a review from Copilot February 13, 2026 09:02

Copilot started reviewing on behalf of mayankshah1607 February 13, 2026 09:02 View session

Copilot AI reviewed Feb 13, 2026

View reviewed changes

address copilot comments

685d172

Signed-off-by: Mayank Shah <mayank.shah@percona.com>

mayankshah1607 dismissed egegunes’s stale review via 685d172 February 13, 2026 09:34

Merge branch 'main' into K8SPG-771

239bba7

Copilot AI review requested due to automatic review settings February 13, 2026 09:34

Copilot started reviewing on behalf of mayankshah1607 February 13, 2026 09:34 View session

fix error message

e7279c9

Signed-off-by: Mayank Shah <mayank.shah@percona.com>

Copilot AI reviewed Feb 13, 2026

View reviewed changes

Merge branch 'main' into K8SPG-771

216ebbe

gkech approved these changes Feb 13, 2026

View reviewed changes

		@@ -1,10 +1,9 @@
		#!/bin/bash
		#!/bin/sh

Conversation

mayankshah1607 commented Jan 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

CHANGE DESCRIPTION

CHECKLIST

Uh oh!

CLAassistant commented Jan 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

egegunes Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

mayankshah1607 Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

egegunes Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

egegunes Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

JNKPercona commented Feb 13, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

mayankshah1607 commented Jan 21, 2026 •

edited

Loading

CLAassistant commented Jan 21, 2026 •

edited

Loading