K8SPG-615: Add initialDelaySeconds for backups

egegunes · egegunes · commit 00f008faa3f2 · 2025-04-09T12:27:54.000+03:00
diff --git a/build/crd/crunchy/generated/postgres-operator.crunchydata.com_postgresclusters.yaml b/build/crd/crunchy/generated/postgres-operator.crunchydata.com_postgresclusters.yaml
@@ -1956,6 +1956,13 @@ spec:
                         description: Defines details for manual pgBackRest backup
                           Jobs
                         properties:
+                          initialDelaySeconds:
+                            description: |-
+                              InitialDelaySeconds defines the number of seconds to wait before starting the backup.
+                              After the backup pod is scheduled, its entrypoint will wait for this number of seconds
+                              before initiating the backup process.
+                            format: int64
+                            type: integer
                           options:
                             description: |-
                               Command line options to include when running the pgBackRest backup command.
diff --git a/build/crd/percona/generated/pgv2.percona.com_perconapgclusters.yaml b/build/crd/percona/generated/pgv2.percona.com_perconapgclusters.yaml
@@ -2112,6 +2112,13 @@ spec:
                         description: Defines details for manual pgBackRest backup
                           Jobs
                         properties:
+                          initialDelaySeconds:
+                            description: |-
+                              InitialDelaySeconds defines the number of seconds to wait before starting the backup.
+                              After the backup pod is scheduled, its entrypoint will wait for this number of seconds
+                              before initiating the backup process.
+                            format: int64
+                            type: integer
                           options:
                             description: |-
                               Command line options to include when running the pgBackRest backup command.
diff --git a/cmd/pgbackrest/main.go b/cmd/pgbackrest/main.go
@@ -25,6 +25,7 @@ import (
 	"strconv"
 	"strings"
 	"syscall"
+	"time"
 
 	log "github.com/sirupsen/logrus"
 	corev1 "k8s.io/api/core/v1"
@@ -79,6 +80,16 @@ func main() {
 	}
 	log.Infof("debug flag set to %t", debugFlag)
 
+	if delay, found := os.LookupEnv("INITIAL_DELAY_SECS"); found {
+		delaySecs, err := strconv.ParseInt(delay, 10, 64)
+		if err != nil {
+			panic(err)
+		}
+
+		log.Infof("sleeping for %d seconds", delaySecs)
+		time.Sleep(time.Duration(delaySecs) * time.Second)
+	}
+
 	config, err := NewConfig()
 	if err != nil {
 		panic(err)
diff --git a/config/crd/bases/pgv2.percona.com_perconapgclusters.yaml b/config/crd/bases/pgv2.percona.com_perconapgclusters.yaml
@@ -2517,6 +2517,13 @@ spec:
                         description: Defines details for manual pgBackRest backup
                           Jobs
                         properties:
+                          initialDelaySeconds:
+                            description: |-
+                              InitialDelaySeconds defines the number of seconds to wait before starting the backup.
+                              After the backup pod is scheduled, its entrypoint will wait for this number of seconds
+                              before initiating the backup process.
+                            format: int64
+                            type: integer
                           options:
                             description: |-
                               Command line options to include when running the pgBackRest backup command.
diff --git a/config/crd/bases/postgres-operator.crunchydata.com_postgresclusters.yaml b/config/crd/bases/postgres-operator.crunchydata.com_postgresclusters.yaml
@@ -1948,6 +1948,13 @@ spec:
                         description: Defines details for manual pgBackRest backup
                           Jobs
                         properties:
+                          initialDelaySeconds:
+                            description: |-
+                              InitialDelaySeconds defines the number of seconds to wait before starting the backup.
+                              After the backup pod is scheduled, its entrypoint will wait for this number of seconds
+                              before initiating the backup process.
+                            format: int64
+                            type: integer
                           options:
                             description: |-
                               Command line options to include when running the pgBackRest backup command.
diff --git a/deploy/bundle.yaml b/deploy/bundle.yaml
@@ -2814,6 +2814,13 @@ spec:
                         description: Defines details for manual pgBackRest backup
                           Jobs
                         properties:
+                          initialDelaySeconds:
+                            description: |-
+                              InitialDelaySeconds defines the number of seconds to wait before starting the backup.
+                              After the backup pod is scheduled, its entrypoint will wait for this number of seconds
+                              before initiating the backup process.
+                            format: int64
+                            type: integer
                           options:
                             description: |-
                               Command line options to include when running the pgBackRest backup command.
@@ -28436,6 +28443,13 @@ spec:
                         description: Defines details for manual pgBackRest backup
                           Jobs
                         properties:
+                          initialDelaySeconds:
+                            description: |-
+                              InitialDelaySeconds defines the number of seconds to wait before starting the backup.
+                              After the backup pod is scheduled, its entrypoint will wait for this number of seconds
+                              before initiating the backup process.
+                            format: int64
+                            type: integer
                           options:
                             description: |-
                               Command line options to include when running the pgBackRest backup command.
diff --git a/deploy/cr.yaml b/deploy/cr.yaml
@@ -509,6 +509,7 @@ spec:
         repoName: repo1
         options:
          - --type=full
+#        initialDelaySeconds: 120
       repos:
       - name: repo1
         schedules:
diff --git a/deploy/crd.yaml b/deploy/crd.yaml
@@ -2814,6 +2814,13 @@ spec:
                         description: Defines details for manual pgBackRest backup
                           Jobs
                         properties:
+                          initialDelaySeconds:
+                            description: |-
+                              InitialDelaySeconds defines the number of seconds to wait before starting the backup.
+                              After the backup pod is scheduled, its entrypoint will wait for this number of seconds
+                              before initiating the backup process.
+                            format: int64
+                            type: integer
                           options:
                             description: |-
                               Command line options to include when running the pgBackRest backup command.
@@ -28436,6 +28443,13 @@ spec:
                         description: Defines details for manual pgBackRest backup
                           Jobs
                         properties:
+                          initialDelaySeconds:
+                            description: |-
+                              InitialDelaySeconds defines the number of seconds to wait before starting the backup.
+                              After the backup pod is scheduled, its entrypoint will wait for this number of seconds
+                              before initiating the backup process.
+                            format: int64
+                            type: integer
                           options:
                             description: |-
                               Command line options to include when running the pgBackRest backup command.
diff --git a/deploy/cw-bundle.yaml b/deploy/cw-bundle.yaml
@@ -2814,6 +2814,13 @@ spec:
                         description: Defines details for manual pgBackRest backup
                           Jobs
                         properties:
+                          initialDelaySeconds:
+                            description: |-
+                              InitialDelaySeconds defines the number of seconds to wait before starting the backup.
+                              After the backup pod is scheduled, its entrypoint will wait for this number of seconds
+                              before initiating the backup process.
+                            format: int64
+                            type: integer
                           options:
                             description: |-
                               Command line options to include when running the pgBackRest backup command.
@@ -28436,6 +28443,13 @@ spec:
                         description: Defines details for manual pgBackRest backup
                           Jobs
                         properties:
+                          initialDelaySeconds:
+                            description: |-
+                              InitialDelaySeconds defines the number of seconds to wait before starting the backup.
+                              After the backup pod is scheduled, its entrypoint will wait for this number of seconds
+                              before initiating the backup process.
+                            format: int64
+                            type: integer
                           options:
                             description: |-
                               Command line options to include when running the pgBackRest backup command.
diff --git a/internal/controller/postgrescluster/pgbackrest.go b/internal/controller/postgrescluster/pgbackrest.go
@@ -11,6 +11,7 @@ import (
 	"reflect"
 	"regexp"
 	"sort"
+	"strconv"
 	"strings"
 	"time"
 
@@ -861,6 +862,14 @@ func generateBackupJobSpecIntent(ctx context.Context, postgresCluster *v1beta1.P
 		}
 	}
 
+	// K8SPG-615
+	if manual := postgresCluster.Spec.Backups.PGBackRest.Manual; postgresCluster.CompareVersion("2.7.0") >= 0 && manual != nil && manual.InitialDelaySeconds != 0 {
+		container.Env = append(container.Env, corev1.EnvVar{
+			Name:  "INITIAL_DELAY_SECS",
+			Value: strconv.FormatInt(manual.InitialDelaySeconds, 10),
+		})
+	}
+
 	jobSpec := &batchv1.JobSpec{
 		Template: corev1.PodTemplateSpec{
 			ObjectMeta: metav1.ObjectMeta{Labels: labels, Annotations: annotations},
diff --git a/internal/controller/postgrescluster/pgbackrest_test.go b/internal/controller/postgrescluster/pgbackrest_test.go
@@ -2720,6 +2720,144 @@ volumes:
 			}
 		})
 	})
+
+	t.Run("InitialDelaySeconds", func(t *testing.T) {
+		t.Run("<2.7.0", func(t *testing.T) {
+			cluster := &v1beta1.PostgresCluster{
+				ObjectMeta: metav1.ObjectMeta{
+					Labels: map[string]string{
+						naming.LabelVersion: "2.6.0",
+					},
+				},
+				Spec: v1beta1.PostgresClusterSpec{
+					Backups: v1beta1.Backups{
+						PGBackRest: v1beta1.PGBackRestArchive{
+							Manual: &v1beta1.PGBackRestManualBackup{
+								InitialDelaySeconds: 30,
+							},
+						},
+					},
+				},
+			}
+			job := generateBackupJobSpecIntent(ctx,
+				cluster, v1beta1.PGBackRestRepo{},
+				"", "",
+				nil, nil,
+			)
+
+			container := job.Template.Spec.Containers[0]
+
+			var envVarFound bool
+			for _, env := range container.Env {
+				if env.Name == "INITIAL_DELAY_SECS" {
+					envVarFound = true
+				}
+			}
+
+			assert.Check(t, envVarFound == false)
+		})
+
+		t.Run(">=2.7.0", func(t *testing.T) {
+			cluster := &v1beta1.PostgresCluster{
+				ObjectMeta: metav1.ObjectMeta{
+					Labels: map[string]string{
+						naming.LabelVersion: "2.7.0",
+					},
+				},
+				Spec: v1beta1.PostgresClusterSpec{
+					Backups: v1beta1.Backups{
+						PGBackRest: v1beta1.PGBackRestArchive{
+							Manual: &v1beta1.PGBackRestManualBackup{
+								InitialDelaySeconds: 30,
+							},
+						},
+					},
+				},
+			}
+			job := generateBackupJobSpecIntent(ctx,
+				cluster, v1beta1.PGBackRestRepo{},
+				"", "",
+				nil, nil,
+			)
+
+			container := job.Template.Spec.Containers[0]
+
+			var envVar corev1.EnvVar
+			for _, env := range container.Env {
+				if env.Name == "INITIAL_DELAY_SECS" {
+					envVar = env
+				}
+			}
+
+			if assert.Check(t, envVar.Name == "INITIAL_DELAY_SECS") {
+				assert.Equal(t, envVar.Value, "30")
+			}
+		})
+
+		t.Run("NoManual", func(t *testing.T) {
+			cluster := &v1beta1.PostgresCluster{
+				ObjectMeta: metav1.ObjectMeta{
+					Labels: map[string]string{
+						naming.LabelVersion: "2.7.0",
+					},
+				},
+				Spec: v1beta1.PostgresClusterSpec{
+					Backups: v1beta1.Backups{
+						PGBackRest: v1beta1.PGBackRestArchive{},
+					},
+				},
+			}
+			job := generateBackupJobSpecIntent(ctx,
+				cluster, v1beta1.PGBackRestRepo{},
+				"", "",
+				nil, nil,
+			)
+
+			container := job.Template.Spec.Containers[0]
+
+			var envVarFound bool
+			for _, env := range container.Env {
+				if env.Name == "INITIAL_DELAY_SECS" {
+					envVarFound = true
+				}
+			}
+
+			assert.Check(t, envVarFound == false)
+		})
+
+		t.Run("EmptyValue", func(t *testing.T) {
+			cluster := &v1beta1.PostgresCluster{
+				ObjectMeta: metav1.ObjectMeta{
+					Labels: map[string]string{
+						naming.LabelVersion: "2.7.0",
+					},
+				},
+				Spec: v1beta1.PostgresClusterSpec{
+					Backups: v1beta1.Backups{
+						PGBackRest: v1beta1.PGBackRestArchive{
+							Manual: &v1beta1.PGBackRestManualBackup{},
+						},
+					},
+				},
+			}
+			job := generateBackupJobSpecIntent(ctx,
+				cluster, v1beta1.PGBackRestRepo{},
+				"", "",
+				nil, nil,
+			)
+
+			container := job.Template.Spec.Containers[0]
+
+			var envVarFound bool
+			for _, env := range container.Env {
+				if env.Name == "INITIAL_DELAY_SECS" {
+					envVarFound = true
+				}
+			}
+
+			assert.Check(t, envVarFound == false)
+		})
+	})
 }
 
 func TestGenerateRepoHostIntent(t *testing.T) {
diff --git a/pkg/apis/postgres-operator.crunchydata.com/v1beta1/pgbackrest_types.go b/pkg/apis/postgres-operator.crunchydata.com/v1beta1/pgbackrest_types.go
@@ -205,6 +205,12 @@ type PGBackRestManualBackup struct {
 	// https://pgbackrest.org/command.html#command-backup
 	// +optional
 	Options []string `json:"options,omitempty"`
+
+	// InitialDelaySeconds defines the number of seconds to wait before starting the backup.
+	// After the backup pod is scheduled, its entrypoint will wait for this number of seconds
+	// before initiating the backup process.
+	// +optional
+	InitialDelaySeconds int64 `json:"initialDelaySeconds,omitempty"`
 }
 
 // PGBackRestRepoHost represents a pgBackRest dedicated repository host
