Merge branch 'main' into K8SPG-613

egegunes · web-flow · commit f62c48539119 · 2025-04-08T10:37:43.000+03:00
diff --git a/Makefile b/Makefile
@@ -120,6 +120,7 @@ uninstall: ## Delete the postgrescluster CRD
 deploy: ## Deploy the PostgreSQL Operator (enables the postgrescluster controller)
 	yq eval '(.spec.template.spec.containers[] | select(.name=="operator")).image = "$(IMAGE)"' ./deploy/operator.yaml \
 		| yq eval '(.spec.template.spec.containers[] | select(.name=="operator") | .env[] | select(.name=="DISABLE_TELEMETRY") | .value) = "true"' - \
+		| yq eval '(.spec.template.spec.containers[] | select(.name=="operator") | .env[] | select(.name=="LOG_LEVEL") | .value) = "DEBUG"' - \
 		| kubectl apply -f -
 
 .PHONY: undeploy
diff --git a/build/crd/crunchy/generated/postgres-operator.crunchydata.com_postgresclusters.yaml b/build/crd/crunchy/generated/postgres-operator.crunchydata.com_postgresclusters.yaml
@@ -14540,6 +14540,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 --git a/build/crd/percona/generated/pgv2.percona.com_perconapgclusters.yaml b/build/crd/percona/generated/pgv2.percona.com_perconapgclusters.yaml
@@ -13872,6 +13872,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 --git a/config/crd/bases/pgv2.percona.com_perconapgclusters.yaml b/config/crd/bases/pgv2.percona.com_perconapgclusters.yaml
@@ -14277,6 +14277,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 --git a/config/crd/bases/postgres-operator.crunchydata.com_postgresclusters.yaml b/config/crd/bases/postgres-operator.crunchydata.com_postgresclusters.yaml
@@ -14482,6 +14482,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 --git a/deploy/bundle.yaml b/deploy/bundle.yaml
@@ -14574,6 +14574,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
@@ -40697,6 +40706,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 --git a/deploy/cr.yaml b/deploy/cr.yaml
@@ -542,6 +542,9 @@ spec:
 #          max_worker_processes: 2
 #          shared_buffers: 1GB
 #          work_mem: 2MB
+#    createReplicaMethods:
+#    - pgbackrest
+#    - basebackup
 
 #  extensions:
 #    image: perconalab/percona-postgresql-operator:main
@@ -555,6 +558,7 @@ spec:
 #        name: cluster1-extensions-secret
 #    builtin:
 #      pg_stat_monitor: true
+#      pg_stat_statements: false
 #      pg_audit: true
 #      pgvector: false
 #      pg_repack: false
diff --git a/deploy/crd.yaml b/deploy/crd.yaml
@@ -14574,6 +14574,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
@@ -40697,6 +40706,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 --git a/deploy/cw-bundle.yaml b/deploy/cw-bundle.yaml
@@ -14574,6 +14574,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
@@ -40697,6 +40706,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 --git a/internal/controller/postgrescluster/controller.go b/internal/controller/postgrescluster/controller.go
@@ -27,13 +27,16 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/builder"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
+	"sigs.k8s.io/controller-runtime/pkg/event"
 	"sigs.k8s.io/controller-runtime/pkg/manager"
+	"sigs.k8s.io/controller-runtime/pkg/predicate"
 	"sigs.k8s.io/controller-runtime/pkg/reconcile"
 
 	"github.com/percona/percona-postgresql-operator/internal/config"
 	"github.com/percona/percona-postgresql-operator/internal/controller/runtime"
 	"github.com/percona/percona-postgresql-operator/internal/initialize"
 	"github.com/percona/percona-postgresql-operator/internal/logging"
+	"github.com/percona/percona-postgresql-operator/internal/naming"
 	"github.com/percona/percona-postgresql-operator/internal/pgaudit"
 	"github.com/percona/percona-postgresql-operator/internal/pgbackrest"
 	"github.com/percona/percona-postgresql-operator/internal/pgbouncer"
@@ -504,9 +507,22 @@ func (r *Reconciler) SetupWithManager(mgr manager.Manager) error {
 		}
 	}
 
+	// K8SPG-712: Allow overriding default configurations
+	configMapPredicate := builder.WithPredicates(predicate.Funcs{
+		UpdateFunc: func(e event.UpdateEvent) bool {
+			configMap, ok := e.ObjectNew.(*corev1.ConfigMap)
+			if !ok {
+				return true
+			}
+			// Skip reconciliation if the ConfigMap has the specified annotation
+			_, hasAnnotation := configMap.Annotations[naming.OverrideConfigAnnotation]
+			return !hasAnnotation
+		},
+	})
+
 	return builder.ControllerManagedBy(mgr).
 		For(&v1beta1.PostgresCluster{}).
-		Owns(&corev1.ConfigMap{}).
+		Owns(&corev1.ConfigMap{}, configMapPredicate). // K8SPG-712
 		Owns(&corev1.Endpoints{}).
 		Owns(&corev1.PersistentVolumeClaim{}).
 		Owns(&corev1.Secret{}).
diff --git a/internal/controller/postgrescluster/controller_test.go b/internal/controller/postgrescluster/controller_test.go
@@ -512,6 +512,31 @@ spec:
 			Expect(icm.Data["patroni.yaml"]).ToNot(BeZero())
 		})
 
+		It("doesn't reconcile ConfigMap with override annotation", func() {
+			icm := &corev1.ConfigMap{}
+			Expect(suite.Client.Get(context.Background(), client.ObjectKey{
+				Namespace: test.Namespace.Name, Name: instance.Name + "-config",
+			}, icm)).To(Succeed())
+
+			Expect(icm.Labels[naming.LabelCluster]).To(Equal("carlos"))
+			Expect(icm.Labels[naming.LabelInstance]).To(Equal(instance.Name))
+			Expect(icm.Data["patroni.yaml"]).ToNot(BeZero())
+
+			icm.SetAnnotations(map[string]string{
+				naming.OverrideConfigAnnotation: "true",
+			})
+			icm.Data["patroni.yaml"] = ""
+
+			Expect(suite.Client.Update(context.Background(), icm)).To(Succeed())
+
+			Expect(suite.Client.Get(context.Background(), client.ObjectKey{
+				Namespace: test.Namespace.Name, Name: instance.Name + "-config",
+			}, icm)).To(Succeed())
+
+			Expect(icm.Annotations[naming.OverrideConfigAnnotation]).To(Equal("true"))
+			Expect(icm.Data["patroni.yaml"]).To(BeZero())
+		})
+
 		Specify("Instance StatefulSet", func() {
 			Expect(instance.Labels[naming.LabelCluster]).To(Equal("carlos"))
 			Expect(instance.Labels[naming.LabelInstanceSet]).To(Equal("samba"))
diff --git a/internal/controller/postgrescluster/patroni.go b/internal/controller/postgrescluster/patroni.go
@@ -222,6 +222,8 @@ func (r *Reconciler) reconcilePatroniDynamicConfiguration(
 	}
 	configuration = patroni.DynamicConfiguration(cluster, configuration, pgHBAs, pgParameters)
 
+	logging.FromContext(ctx).V(1).Info("Replacing patroni dynamic configuration")
+
 	return errors.WithStack(
 		patroni.Executor(exec).ReplaceConfiguration(ctx, configuration))
 }
diff --git a/internal/controller/postgrescluster/pgbackrest_test.go b/internal/controller/postgrescluster/pgbackrest_test.go
@@ -2069,7 +2069,7 @@ func TestReconcileCloudBasedDataSource(t *testing.T) {
 			result: testResult{
 				configCount: 1, jobCount: 1, pvcCount: 1,
 				expectedClusterCondition: nil,
-				conf:                     "|\n  # Generated by postgres-operator. DO NOT EDIT.\n  # Your changes will not be saved.\n\n  [global]\n  archive-async = y\n  log-path = /pgdata/pgbackrest/log\n  repo1-path = /pgbackrest/repo1\n  spool-path = /pgdata/pgbackrest-spool\n\n  [db]\n  pg1-path = /pgdata/pg13\n  pg1-port = 5432\n  pg1-socket-path = /tmp/postgres\n",
+				conf:                     "|\n  # Generated by postgres-operator. DO NOT EDIT UNLESS YOU KNOW WHAT YOU'RE DOING.\n  # If you want to override the config, annotate this ConfigMap with pgv2.percona.com/override-config=true\n\n  [global]\n  archive-async = y\n  log-path = /pgdata/pgbackrest/log\n  repo1-path = /pgbackrest/repo1\n  spool-path = /pgdata/pgbackrest-spool\n\n  [db]\n  pg1-path = /pgdata/pg13\n  pg1-port = 5432\n  pg1-socket-path = /tmp/postgres\n",
 			},
 		}, {
 			desc: "global/configuration set",
@@ -2086,7 +2086,7 @@ func TestReconcileCloudBasedDataSource(t *testing.T) {
 			result: testResult{
 				configCount: 1, jobCount: 1, pvcCount: 1,
 				expectedClusterCondition: nil,
-				conf:                     "|\n  # Generated by postgres-operator. DO NOT EDIT.\n  # Your changes will not be saved.\n\n  [global]\n  archive-async = y\n  log-path = /pgdata/pgbackrest/log\n  repo1-path = elephant\n  spool-path = /pgdata/pgbackrest-spool\n\n  [db]\n  pg1-path = /pgdata/pg13\n  pg1-port = 5432\n  pg1-socket-path = /tmp/postgres\n",
+				conf:                     "|\n  # Generated by postgres-operator. DO NOT EDIT UNLESS YOU KNOW WHAT YOU'RE DOING.\n  # If you want to override the config, annotate this ConfigMap with pgv2.percona.com/override-config=true\n\n  [global]\n  archive-async = y\n  log-path = /pgdata/pgbackrest/log\n  repo1-path = elephant\n  spool-path = /pgdata/pgbackrest-spool\n\n  [db]\n  pg1-path = /pgdata/pg13\n  pg1-port = 5432\n  pg1-socket-path = /tmp/postgres\n",
 			},
 		}, {
 			desc: "invalid option: stanza",
@@ -2101,7 +2101,7 @@ func TestReconcileCloudBasedDataSource(t *testing.T) {
 			result: testResult{
 				configCount: 1, jobCount: 0, pvcCount: 1,
 				expectedClusterCondition: nil,
-				conf:                     "|\n  # Generated by postgres-operator. DO NOT EDIT.\n  # Your changes will not be saved.\n\n  [global]\n  archive-async = y\n  log-path = /pgdata/pgbackrest/log\n  repo1-path = /pgbackrest/repo1\n  spool-path = /pgdata/pgbackrest-spool\n\n  [db]\n  pg1-path = /pgdata/pg13\n  pg1-port = 5432\n  pg1-socket-path = /tmp/postgres\n",
+				conf:                     "|\n  # Generated by postgres-operator. DO NOT EDIT UNLESS YOU KNOW WHAT YOU'RE DOING.\n  # If you want to override the config, annotate this ConfigMap with pgv2.percona.com/override-config=true\n\n  [global]\n  archive-async = y\n  log-path = /pgdata/pgbackrest/log\n  repo1-path = /pgbackrest/repo1\n  spool-path = /pgdata/pgbackrest-spool\n\n  [db]\n  pg1-path = /pgdata/pg13\n  pg1-port = 5432\n  pg1-socket-path = /tmp/postgres\n",
 			},
 		}, {
 			desc: "cluster bootstrapped init condition missing",
@@ -2120,7 +2120,7 @@ func TestReconcileCloudBasedDataSource(t *testing.T) {
 					Reason:  "ClusterAlreadyBootstrapped",
 					Message: "The cluster is already bootstrapped",
 				},
-				conf: "|\n  # Generated by postgres-operator. DO NOT EDIT.\n  # Your changes will not be saved.\n\n  [global]\n  archive-async = y\n log-path = /pgdata/pgbackrest/log\n  repo1-path = /pgbackrest/repo1\n  spool-path = /pgdata/pgbackrest-spool\n\n  [db]\n  pg1-path = /pgdata/pg13\n  pg1-port = 5432\n  pg1-socket-path = /tmp/postgres\n",
+				conf: "|\n  # Generated by postgres-operator. DO NOT EDIT UNLESS YOU KNOW WHAT YOU'RE DOING.\n  # If you want to override the config, annotate this ConfigMap with pgv2.percona.com/override-config=true\n\n  [global]\n  archive-async = y\n log-path = /pgdata/pgbackrest/log\n  repo1-path = /pgbackrest/repo1\n  spool-path = /pgdata/pgbackrest-spool\n\n  [db]\n  pg1-path = /pgdata/pg13\n  pg1-port = 5432\n  pg1-socket-path = /tmp/postgres\n",
 			},
 		}}
 
diff --git a/internal/naming/annotations.go b/internal/naming/annotations.go
@@ -5,7 +5,8 @@
 package naming
 
 const (
-	annotationPrefix = labelPrefix
+	annotationPrefix        = labelPrefix
+	perconaAnnotationPrefix = perconaLabelPrefix
 
 	// Finalizer marks an object to be garbage collected by this module.
 	Finalizer = annotationPrefix + "finalizer"
@@ -68,4 +69,11 @@ const (
 	// to a cluster without backups. As usual with the operator, we do not
 	// touch cloud-based backups.
 	AuthorizeBackupRemovalAnnotation = annotationPrefix + "authorizeBackupRemoval"
+
+	// K8SPG-712
+	// OverrideConfigAnnotation is an annotation used to prevent the controller from reconciling
+	// ConfigMaps when a user wants to manually override their contents. When this annotation
+	// is present, the controller will not update the ConfigMap, allowing users to make custom
+	// modifications that won't be overwritten during reconciliation.
+	OverrideConfigAnnotation = perconaAnnotationPrefix + "override-config"
 )
diff --git a/internal/patroni/config.go b/internal/patroni/config.go
@@ -30,8 +30,8 @@ const (
 
 const (
 	yamlGeneratedWarning = "" +
-		"# Generated by postgres-operator. DO NOT EDIT.\n" +
-		"# Your changes will not be saved.\n"
+		"# Generated by postgres-operator. DO NOT EDIT UNLESS YOU KNOW WHAT YOU'RE DOING.\n" +
+		"# If you want to override the config, annotate this ConfigMap with " + naming.OverrideConfigAnnotation + "=true\n"
 )
 
 // quoteShellWord ensures that s is interpreted by a shell as single word.
@@ -535,7 +535,7 @@ func instanceYAML(
 		// NOTE(cbandy): The "--waldir" option was introduced in PostgreSQL v10.
 		"waldir=" + postgres.WALDirectory(cluster, instance),
 	}
-	methods := []string{"basebackup"}
+	methods := []string{basebackupCreateReplicaMethod}
 
 	// Prefer a pgBackRest method when it is available, and fallback to other
 	// methods when it fails.
@@ -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 --git a/internal/patroni/config_test.go b/internal/patroni/config_test.go
diff --git a/internal/pgbackrest/config.go b/internal/pgbackrest/config.go
diff --git a/internal/pgbackrest/config_test.go b/internal/pgbackrest/config_test.go
diff --git a/internal/pgbouncer/config.go b/internal/pgbouncer/config.go
diff --git a/internal/pgbouncer/config_test.go b/internal/pgbouncer/config_test.go
diff --git a/pkg/apis/postgres-operator.crunchydata.com/v1beta1/patroni_types.go b/pkg/apis/postgres-operator.crunchydata.com/v1beta1/patroni_types.go
diff --git a/pkg/apis/postgres-operator.crunchydata.com/v1beta1/zz_generated.deepcopy.go b/pkg/apis/postgres-operator.crunchydata.com/v1beta1/zz_generated.deepcopy.go
