K8SPG-771: Backup snapshots

build/crd/percona/generated/pgv2.percona.com_perconapgbackups.yaml

@@ -70,6 +70,13 @@ spec:
             type: object
           spec:
             properties:
+              method:
+                default: pgbackrest
+                description: Method with which to perform the backup
+                enum:
+                - pgbackrest
+                - volumeSnapshot
+                type: string
               options:
                 description: |-
                   Command line options to include when running the pgBackRest backup command.
@@ -80,14 +87,17 @@ spec:
               pgCluster:
                 type: string
               repoName:
-                description: The name of the pgBackRest repo to run the backup command
-                  against.
+                description: |-
+                  The name of the pgBackRest repo to run the backup command against.
+                  This is required when method is 'pgbackrest'.
                 pattern: ^repo[1-4]
                 type: string
             required:
             - pgCluster
-            - repoName
             type: object
+            x-kubernetes-validations:
+            - message: repoName is required when method is 'pgbackrest'
+              rule: self.method == "volumeSnapshot" || has(self.repoName)
           status:
             properties:
               backupName:
@@ -391,6 +401,24 @@ spec:
                 required:
                 - name
                 type: object
+              snapshot:
+                properties:
+                  dataVolumeSnapshotRef:
+                    description: Name of the VolumeSnapshot containing data volume
+                      contents.
+                    type: string
+                  tablespaceVolumeSnapshotRefs:
+                    additionalProperties:
+                      type: string
+                    description: |-
+                      Names of the VolumeSnapshots containing tablespace volume contents.
+                      Key is the name of the tablespace, value is the name of the VolumeSnapshot.
+                    type: object
+                  walVolumeSnapshotRef:
+                    description: Name of the VolumeSnapshot containing WAL volume
+                      contents.
+                    type: string
+                type: object
               state:
                 type: string
               storageType:

build/crd/percona/generated/pgv2.percona.com_perconapgclusters.yaml

@@ -7110,6 +7110,51 @@ spec:
                   trackLatestRestorableTime:
                     description: Enable tracking latest restorable time
                     type: boolean
+                  volumeSnapshots:
+                    description: VolumeSnapshots configuration
+                    properties:
+                      className:
+                        description: Name of the VolumeSnapshotClass to use.
+                        type: string
+                      mode:
+                        default: offline
+                        description: Mode of the VolumeSnapshot.
+                        enum:
+                        - offline
+                        type: string
+                      offlineConfig:
+                        description: |-
+                          Configuration for offline snapshot operations.
+                          Ignored if mode is not offline.
+                        properties:
+                          checkpoint:
+                            description: Checkpoint configuration for offline snapshot
+                              operations.
+                            properties:
+                              enabled:
+                                default: true
+                                description: If set, a checkpoint is requested.
+                                type: boolean
+                              timeoutSeconds:
+                                default: 300
+                                description: |-
+                                  Timeout for the checkpoint operation.
+                                  Ignored if checkpoint is not enabled.
+                                format: int32
+                                minimum: 30
+                                type: integer
+                            type: object
+                        type: object
+                      schedule:
+                        description: |-
+                          Defines the Cron schedule for a VolumeSnapshot.
+                          Follows the standard Cron schedule syntax:
+                          https://k8s.io/docs/concepts/workloads/controllers/cron-jobs/#cron-schedule-syntax
+                        minLength: 6
+                        type: string
+                    required:
+                    - className
+                    type: object
                 type: object
                 x-kubernetes-validations:
                 - message: At least one repository must be configured when backups

build/crd/percona/generated/pgv2.percona.com_perconapgrestores.yaml

@@ -67,17 +67,33 @@ spec:
               pgCluster:
                 description: The name of the PerconaPGCluster to perform restore.
                 type: string
+                x-kubernetes-validations:
+                - message: pgCluster is an immutable field
+                  rule: self == oldSelf
               repoName:
                 description: |-
                   The name of the pgBackRest repo within the source PostgresCluster that contains the backups
                   that should be utilized to perform a pgBackRest restore when initializing the data source
                   for the new PostgresCluster.
                 pattern: ^repo[1-4]
                 type: string
+                x-kubernetes-validations:
+                - message: repoName is an immutable field
+                  rule: self == oldSelf
+              volumeSnapshotBackupName:
+                description: The name of the backup to perform in-place volume snapshot
+                  restores from.
+                type: string
+                x-kubernetes-validations:
+                - message: volumeSnapshotBackupName is an immutable field
+                  rule: self == oldSelf
             required:
             - pgCluster
-            - repoName
             type: object
+            x-kubernetes-validations:
+            - message: either repoName or volumeSnapshotBackupName must be set
+              rule: ((has(self.repoName) && self.repoName != "") || (has(self.volumeSnapshotBackupName)
+                && self.volumeSnapshotBackupName != ""))
           status:
             properties:
               completed:

build/postgres-operator/Dockerfile

@@ -69,6 +69,7 @@ COPY build/postgres-operator/init-entrypoint.sh /usr/local/bin
 COPY build/postgres-operator/postgres-entrypoint.sh /usr/local/bin
 COPY build/postgres-operator/postgres-liveness-check.sh /usr/local/bin
 COPY build/postgres-operator/postgres-readiness-check.sh /usr/local/bin
+COPY build/postgres-operator/restore-command-wrapper.sh /usr/local/bin
 COPY hack/tools/queries /opt/crunchy/conf
 
 RUN chgrp -R 0 /opt/crunchy/conf && chmod -R g=u opt/crunchy/conf

build/postgres-operator/init-entrypoint.sh

@@ -10,3 +10,4 @@ install -o "$(id -u)" -g "$(id -g)" -m 0755 -D "/usr/local/bin/postgres-entrypoi
 install -o "$(id -u)" -g "$(id -g)" -m 0755 -D "/usr/local/bin/postgres-liveness-check.sh" "${CRUNCHY_BINDIR}/bin/postgres-liveness-check.sh"
 install -o "$(id -u)" -g "$(id -g)" -m 0755 -D "/usr/local/bin/postgres-readiness-check.sh" "${CRUNCHY_BINDIR}/bin/postgres-readiness-check.sh"
 install -o "$(id -u)" -g "$(id -g)" -m 0755 -D "/usr/local/bin/relocate-extensions.sh" "${CRUNCHY_BINDIR}/bin/relocate-extensions.sh"
+install -o "$(id -u)" -g "$(id -g)" -m 0755 -D "/usr/local/bin/restore-command-wrapper.sh" "${CRUNCHY_BINDIR}/bin/restore-command-wrapper.sh"

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

@@ -0,0 +1,10 @@
+#!/bin/sh
+set -e
+
+# When this marker exists (e.g. after a snapshot restore), skip all WAL recovery by
+# exiting non-zero. Do not remove the file so every restore_command call is skipped.
+if [ -f "${PGDATA}/skip-wal-recovery" ]; then
+	exit 1
+fi
+
+exec "$@"

cmd/postgres-operator/main.go

@@ -14,6 +14,7 @@ import (
 	"time"
 	"unicode"
 
+	volumesnapshotv1 "github.com/kubernetes-csi/external-snapshotter/client/v8/apis/volumesnapshot/v1"
 	"github.com/pkg/errors"
 	"go.opentelemetry.io/otel"
 	uzap "go.uber.org/zap"
@@ -125,6 +126,8 @@ func main() {
 	// Add Percona custom resource types to scheme
 	assertNoError(v2.AddToScheme(mgr.GetScheme()))
 
+	assertNoError(volumesnapshotv1.AddToScheme(mgr.GetScheme()))
+
 	// add all PostgreSQL Operator controllers to the runtime manager
 	err = addControllersToManager(ctx, mgr)
 	assertNoError(err)

config/crd/bases/pgv2.percona.com_perconapgclusters.yaml

@@ -69,6 +69,13 @@ spec:
             type: object
           spec:
             properties:
+              method:
+                default: pgbackrest
+                description: Method with which to perform the backup
+                enum:
+                - pgbackrest
+                - volumeSnapshot
+                type: string
               options:
                 description: |-
                   Command line options to include when running the pgBackRest backup command.
@@ -79,14 +86,17 @@ spec:
               pgCluster:
                 type: string
               repoName:
-                description: The name of the pgBackRest repo to run the backup command
-                  against.
+                description: |-
+                  The name of the pgBackRest repo to run the backup command against.
+                  This is required when method is 'pgbackrest'.
                 pattern: ^repo[1-4]
                 type: string
             required:
             - pgCluster
-            - repoName
             type: object
+            x-kubernetes-validations:
+            - message: repoName is required when method is 'pgbackrest'
+              rule: self.method == "volumeSnapshot" || has(self.repoName)
           status:
             properties:
               backupName:
@@ -390,6 +400,24 @@ spec:
                 required:
                 - name
                 type: object
+              snapshot:
+                properties:
+                  dataVolumeSnapshotRef:
+                    description: Name of the VolumeSnapshot containing data volume
+                      contents.
+                    type: string
+                  tablespaceVolumeSnapshotRefs:
+                    additionalProperties:
+                      type: string
+                    description: |-
+                      Names of the VolumeSnapshots containing tablespace volume contents.
+                      Key is the name of the tablespace, value is the name of the VolumeSnapshot.
+                    type: object
+                  walVolumeSnapshotRef:
+                    description: Name of the VolumeSnapshot containing WAL volume
+                      contents.
+                    type: string
+                type: object
               state:
                 type: string
               storageType:
@@ -7515,6 +7543,51 @@ spec:
                   trackLatestRestorableTime:
                     description: Enable tracking latest restorable time
                     type: boolean
+                  volumeSnapshots:
+                    description: VolumeSnapshots configuration
+                    properties:
+                      className:
+                        description: Name of the VolumeSnapshotClass to use.
+                        type: string
+                      mode:
+                        default: offline
+                        description: Mode of the VolumeSnapshot.
+                        enum:
+                        - offline
+                        type: string
+                      offlineConfig:
+                        description: |-
+                          Configuration for offline snapshot operations.
+                          Ignored if mode is not offline.
+                        properties:
+                          checkpoint:
+                            description: Checkpoint configuration for offline snapshot
+                              operations.
+                            properties:
+                              enabled:
+                                default: true
+                                description: If set, a checkpoint is requested.
+                                type: boolean
+                              timeoutSeconds:
+                                default: 300
+                                description: |-
+                                  Timeout for the checkpoint operation.
+                                  Ignored if checkpoint is not enabled.
+                                format: int32
+                                minimum: 30
+                                type: integer
+                            type: object
+                        type: object
+                      schedule:
+                        description: |-
+                          Defines the Cron schedule for a VolumeSnapshot.
+                          Follows the standard Cron schedule syntax:
+                          https://k8s.io/docs/concepts/workloads/controllers/cron-jobs/#cron-schedule-syntax
+                        minLength: 6
+                        type: string
+                    required:
+                    - className
+                    type: object
                 type: object
                 x-kubernetes-validations:
                 - message: At least one repository must be configured when backups
@@ -21968,17 +22041,33 @@ spec:
               pgCluster:
                 description: The name of the PerconaPGCluster to perform restore.
                 type: string
+                x-kubernetes-validations:
+                - message: pgCluster is an immutable field
+                  rule: self == oldSelf
               repoName:
                 description: |-
                   The name of the pgBackRest repo within the source PostgresCluster that contains the backups
                   that should be utilized to perform a pgBackRest restore when initializing the data source
                   for the new PostgresCluster.
                 pattern: ^repo[1-4]
                 type: string
+                x-kubernetes-validations:
+                - message: repoName is an immutable field
+                  rule: self == oldSelf
+              volumeSnapshotBackupName:
+                description: The name of the backup to perform in-place volume snapshot
+                  restores from.
+                type: string
+                x-kubernetes-validations:
+                - message: volumeSnapshotBackupName is an immutable field
+                  rule: self == oldSelf
             required:
             - pgCluster
-            - repoName
             type: object
+            x-kubernetes-validations:
+            - message: either repoName or volumeSnapshotBackupName must be set
+              rule: ((has(self.repoName) && self.repoName != "") || (has(self.volumeSnapshotBackupName)
+                && self.volumeSnapshotBackupName != ""))
           status:
             properties:
               completed:

config/manager/default/manager.yaml

@@ -39,6 +39,8 @@ spec:
             value: "1"
           - name: PPROF_BIND_ADDRESS
             value: "0"
+          - name: PGO_FEATURE_GATES
+            value: ""
         ports:
           - containerPort: 8080
             name: metrics

deploy/backup.yaml

@@ -5,5 +5,6 @@ metadata:
 spec:
   pgCluster: cluster1
   repoName: repo1
+#  method: volumeSnapshot
 #  options:
 #  - --type=full