K8SPG-704: Allow configuring create_replica_methods (#1110)

* K8SPG-704: Allow configuring create_replica_methods

* add test case

---------

Co-authored-by: Viacheslav Sarzhan <[email protected]>

Author: egegunes

Diff for: build/crd/crunchy/generated/postgres-operator.crunchydata.com_postgresclusters.yaml

@@ -14023,6 +14023,15 @@ spec:
                 type: boolean
               patroni:
                 properties:
+                  createReplicaMethods:
+                    description: CreateReplicaMethods allows overriding create_replica_methods
+                      for all instances.
+                    items:
+                      enum:
+                      - basebackup
+                      - pgbackrest
+                      type: string
+                    type: array
                   dynamicConfiguration:
                     description: |-
                       Patroni dynamic configuration settings. Changes to this value will be

Diff for: build/crd/percona/generated/pgv2.percona.com_perconapgclusters.yaml

@@ -13355,6 +13355,15 @@ spec:
                 type: boolean
               patroni:
                 properties:
+                  createReplicaMethods:
+                    description: CreateReplicaMethods allows overriding create_replica_methods
+                      for all instances.
+                    items:
+                      enum:
+                      - basebackup
+                      - pgbackrest
+                      type: string
+                    type: array
                   dynamicConfiguration:
                     description: |-
                       Patroni dynamic configuration settings. Changes to this value will be

Diff for: config/crd/bases/pgv2.percona.com_perconapgclusters.yaml

@@ -13760,6 +13760,15 @@ spec:
                 type: boolean
               patroni:
                 properties:
+                  createReplicaMethods:
+                    description: CreateReplicaMethods allows overriding create_replica_methods
+                      for all instances.
+                    items:
+                      enum:
+                      - basebackup
+                      - pgbackrest
+                      type: string
+                    type: array
                   dynamicConfiguration:
                     description: |-
                       Patroni dynamic configuration settings. Changes to this value will be

Diff for: config/crd/bases/postgres-operator.crunchydata.com_postgresclusters.yaml

@@ -13965,6 +13965,15 @@ spec:
                 type: boolean
               patroni:
                 properties:
+                  createReplicaMethods:
+                    description: CreateReplicaMethods allows overriding create_replica_methods
+                      for all instances.
+                    items:
+                      enum:
+                      - basebackup
+                      - pgbackrest
+                      type: string
+                    type: array
                   dynamicConfiguration:
                     description: |-
                       Patroni dynamic configuration settings. Changes to this value will be

Diff for: deploy/bundle.yaml

@@ -14057,6 +14057,15 @@ spec:
                 type: boolean
               patroni:
                 properties:
+                  createReplicaMethods:
+                    description: CreateReplicaMethods allows overriding create_replica_methods
+                      for all instances.
+                    items:
+                      enum:
+                      - basebackup
+                      - pgbackrest
+                      type: string
+                    type: array
                   dynamicConfiguration:
                     description: |-
                       Patroni dynamic configuration settings. Changes to this value will be
@@ -39663,6 +39672,15 @@ spec:
                 type: boolean
               patroni:
                 properties:
+                  createReplicaMethods:
+                    description: CreateReplicaMethods allows overriding create_replica_methods
+                      for all instances.
+                    items:
+                      enum:
+                      - basebackup
+                      - pgbackrest
+                      type: string
+                    type: array
                   dynamicConfiguration:
                     description: |-
                       Patroni dynamic configuration settings. Changes to this value will be

Diff for: deploy/cr.yaml

@@ -495,6 +495,9 @@ spec:
 #          max_worker_processes: 2
 #          shared_buffers: 1GB
 #          work_mem: 2MB
+#    createReplicaMethods:
+#    - pgbackrest
+#    - basebackup
 
 #  extensions:
 #    image: perconalab/percona-postgresql-operator:main

Diff for: deploy/crd.yaml

@@ -14057,6 +14057,15 @@ spec:
                 type: boolean
               patroni:
                 properties:
+                  createReplicaMethods:
+                    description: CreateReplicaMethods allows overriding create_replica_methods
+                      for all instances.
+                    items:
+                      enum:
+                      - basebackup
+                      - pgbackrest
+                      type: string
+                    type: array
                   dynamicConfiguration:
                     description: |-
                       Patroni dynamic configuration settings. Changes to this value will be
@@ -39663,6 +39672,15 @@ spec:
                 type: boolean
               patroni:
                 properties:
+                  createReplicaMethods:
+                    description: CreateReplicaMethods allows overriding create_replica_methods
+                      for all instances.
+                    items:
+                      enum:
+                      - basebackup
+                      - pgbackrest
+                      type: string
+                    type: array
                   dynamicConfiguration:
                     description: |-
                       Patroni dynamic configuration settings. Changes to this value will be

Diff for: deploy/cw-bundle.yaml

@@ -14057,6 +14057,15 @@ spec:
                 type: boolean
               patroni:
                 properties:
+                  createReplicaMethods:
+                    description: CreateReplicaMethods allows overriding create_replica_methods
+                      for all instances.
+                    items:
+                      enum:
+                      - basebackup
+                      - pgbackrest
+                      type: string
+                    type: array
                   dynamicConfiguration:
                     description: |-
                       Patroni dynamic configuration settings. Changes to this value will be
@@ -39663,6 +39672,15 @@ spec:
                 type: boolean
               patroni:
                 properties:
+                  createReplicaMethods:
+                    description: CreateReplicaMethods allows overriding create_replica_methods
+                      for all instances.
+                    items:
+                      enum:
+                      - basebackup
+                      - pgbackrest
+                      type: string
+                    type: array
                   dynamicConfiguration:
                     description: |-
                       Patroni dynamic configuration settings. Changes to this value will be

Diff for: internal/patroni/config.go

@@ -585,6 +585,14 @@ func instanceYAML(
 		methods = append([]string{pgBackRestCreateReplicaMethod}, methods...)
 	}
 
+	// K8SPG-704: Allow overriding create replica methods list
+	if cluster.Spec.Patroni != nil && len(cluster.Spec.Patroni.CreateReplicaMethods) > 0 {
+		methods = []string{}
+		for _, m := range cluster.Spec.Patroni.CreateReplicaMethods {
+			methods = append(methods, string(m))
+		}
+	}
+
 	// NOTE(cbandy): Is there any chance a user might want to specify their own
 	// method? This is a list and cannot be merged.
 	postgresql["create_replica_methods"] = methods

Diff for: internal/patroni/config_test.go

@@ -976,6 +976,32 @@ postgresql:
   pgpass: /tmp/.pgpass
   use_unix_socket: true
 restapi: {}
+tags: {}
+	`, "\t\n")+"\n")
+
+	cluster.Spec.Patroni.CreateReplicaMethods = []v1beta1.CreateReplicaMethod{"basebackup", "pgbackrest"}
+	dataWithCustomMethods, err := instanceYAML(cluster, instance, nil)
+	assert.NilError(t, err)
+	assert.Equal(t, dataWithCustomMethods, strings.Trim(`
+# Generated by postgres-operator. DO NOT EDIT.
+# Your changes will not be saved.
+bootstrap:
+  initdb:
+  - data-checksums
+  - encoding=UTF8
+  - waldir=/pgdata/pg12_wal
+  - encryption-key-command=echo test
+  method: initdb
+kubernetes: {}
+postgresql:
+  basebackup:
+  - waldir=/pgdata/pg12_wal
+  create_replica_methods:
+  - basebackup
+  - pgbackrest
+  pgpass: /tmp/.pgpass
+  use_unix_socket: true
+restapi: {}
 tags: {}
 	`, "\t\n")+"\n")
 }

Diff for: pkg/apis/postgres-operator.crunchydata.com/v1beta1/patroni_types.go

@@ -42,12 +42,19 @@ type PatroniSpec struct {
 	// +optional
 	Switchover *PatroniSwitchover `json:"switchover,omitempty"`
 
+	// CreateReplicaMethods allows overriding create_replica_methods for all instances.
+	// +optional
+	CreateReplicaMethods []CreateReplicaMethod `json:"createReplicaMethods,omitempty"`
+
 	// TODO(cbandy): Add UseConfigMaps bool, default false.
 	// TODO(cbandy): Allow other DCS: etcd, raft, etc?
 	// N.B. changing this will cause downtime.
 	// - https://patroni.readthedocs.io/en/latest/kubernetes.html
 }
 
+// +kubebuilder:validation:Enum={basebackup,pgbackrest}
+type CreateReplicaMethod string
+
 type PatroniSwitchover struct {
 
 	// Whether or not the operator should allow switchovers in a PostgresCluster