Feat: adding configurable parameter for custom role label in multiple resources

charts/postgres-operator/crds/operatorconfigurations.yaml

@@ -327,6 +327,9 @@ spec:
                   pod_role_label:
                     type: string
                     default: "spilo-role"
+                  pod_leader_label_value:
+                    type: string
+                    default: "master"
                   pod_service_account_definition:
                     type: string
                     default: ""

charts/postgres-operator/values.yaml

@@ -194,6 +194,7 @@ configKubernetes:
   pod_management_policy: "ordered_ready"
   # label assigned to the Postgres pods (and services/endpoints)
   pod_role_label: spilo-role
+  pod_leader_label_value: master
   # service account definition as JSON/YAML string to be used by postgres cluster pods
   # pod_service_account_definition: ""
 

docs/reference/operator_parameters.md

@@ -437,6 +437,10 @@ configuration they are grouped under the `kubernetes` key.
   name of the label assigned to the Postgres pods (and services/endpoints) by
   the operator. The default is `spilo-role`.
 
+* **pod_leader_label_value**
+  value of the pod label if Postgres role is primary when running on Kubernetes.
+  The default is 'master'.
+
 * **cluster_labels**
   list of `name:value` pairs for additional labels assigned to the cluster
   objects. The default is `application:spilo`.

manifests/configmap.yaml

@@ -134,6 +134,7 @@ data:
   pod_management_policy: "ordered_ready"
   # pod_priority_class_name: "postgres-pod-priority"
   pod_role_label: spilo-role
+  pod_leader_label_value: master
   pod_service_account_definition: ""
   pod_service_account_name: "postgres-pod"
   pod_service_account_role_binding_definition: ""

manifests/operatorconfiguration.crd.yaml

@@ -325,6 +325,9 @@ spec:
                   pod_role_label:
                     type: string
                     default: "spilo-role"
+                  pod_leader_label_value:
+                    type: string
+                    default: "master"
                   pod_service_account_definition:
                     type: string
                     default: ""

manifests/postgresql-operator-default-configuration.yaml

@@ -99,6 +99,7 @@ configuration:
     pod_management_policy: "ordered_ready"
     # pod_priority_class_name: "postgres-pod-priority"
     pod_role_label: spilo-role
+    pod_leader_label_value: master
     # pod_service_account_definition: ""
     pod_service_account_name: postgres-pod
     # pod_service_account_role_binding_definition: ""

pkg/apis/acid.zalan.do/v1/crds.go

@@ -1497,6 +1497,9 @@ var OperatorConfigCRDResourceValidation = apiextv1.CustomResourceValidation{
 							"pod_role_label": {
 								Type: "string",
 							},
+							"pod_leader_label_value": {
+								Type: "string",
+							},
 							"pod_service_account_definition": {
 								Type: "string",
 							},

pkg/apis/acid.zalan.do/v1/operator_configuration_type.go

@@ -81,6 +81,7 @@ type KubernetesMetaConfiguration struct {
 	InfrastructureRolesSecretName          spec.NamespacedName          `json:"infrastructure_roles_secret_name,omitempty"`
 	InfrastructureRolesDefs                []*config.InfrastructureRole `json:"infrastructure_roles_secrets,omitempty"`
 	PodRoleLabel                           string                       `json:"pod_role_label,omitempty"`
+	PodLeaderLabelValue                    string                       `json:"pod_leader_label_value,omitempty"`
 	ClusterLabels                          map[string]string            `json:"cluster_labels,omitempty"`
 	InheritedLabels                        []string                     `json:"inherited_labels,omitempty"`
 	InheritedAnnotations                   []string                     `json:"inherited_annotations,omitempty"`

pkg/cluster/cluster.go

@@ -175,6 +175,14 @@ func (c *Cluster) clusterNamespace() string {
 	return c.ObjectMeta.Namespace
 }
 
+func (c *Cluster) masterRole() PostgresRole {
+	return PostgresRole(c.OpConfig.PodLeaderLabelValue)
+}
+
+func (c *Cluster) replicaRole() PostgresRole {
+	return PostgresRole("replica")
+}
+
 func (c *Cluster) teamName() string {
 	// TODO: check Teams API for the actual name (in case the user passes an integer Id).
 	return c.Spec.TeamID
@@ -294,15 +302,15 @@ func (c *Cluster) Create() (err error) {
 	}
 	c.eventRecorder.Event(c.GetReference(), v1.EventTypeNormal, "Create", "Started creation of new cluster resources")
 
-	for _, role := range []PostgresRole{Master, Replica} {
+	for _, role := range []PostgresRole{c.masterRole(), c.replicaRole()} {
 
 		// if kubernetes_use_configmaps is set Patroni will create configmaps
 		// otherwise it will use endpoints
 		if !c.patroniKubernetesUseConfigMaps() {
 			if c.Endpoints[role] != nil {
 				return fmt.Errorf("%s endpoint already exists in the cluster", role)
 			}
-			if role == Master {
+			if role == c.masterRole() {
 				// replica endpoint will be created by the replica service. Master endpoint needs to be created by us,
 				// since the corresponding master service does not define any selectors.
 				ep, err = c.createEndpoint(role)
@@ -1213,7 +1221,7 @@ func (c *Cluster) Delete() error {
 		c.eventRecorder.Eventf(c.GetReference(), v1.EventTypeWarning, "Delete", "could not delete pod disruption budget: %v", err)
 	}
 
-	for _, role := range []PostgresRole{Master, Replica} {
+	for _, role := range []PostgresRole{c.masterRole(), c.replicaRole()} {
 		if !c.patroniKubernetesUseConfigMaps() {
 			if err := c.deleteEndpoint(role); err != nil {
 				anyErrors = true
@@ -1238,7 +1246,7 @@ func (c *Cluster) Delete() error {
 	// Delete connection pooler objects anyway, even if it's not mentioned in the
 	// manifest, just to not keep orphaned components in case if something went
 	// wrong
-	for _, role := range [2]PostgresRole{Master, Replica} {
+	for _, role := range [2]PostgresRole{c.masterRole(), c.replicaRole()} {
 		if err := c.deleteConnectionPooler(role); err != nil {
 			anyErrors = true
 			c.logger.Warningf("could not remove connection pooler: %v", err)

pkg/cluster/cluster_test.go

@@ -35,6 +35,7 @@ const (
 	adminUserName       = "admin"
 	exampleSpiloConfig  = `{"postgresql":{"bin_dir":"/usr/lib/postgresql/12/bin","parameters":{"autovacuum_analyze_scale_factor":"0.1"},"pg_hba":["hostssl all all 0.0.0.0/0 md5","host all all 0.0.0.0/0 md5"]},"bootstrap":{"initdb":[{"auth-host":"md5"},{"auth-local":"trust"},"data-checksums",{"encoding":"UTF8"},{"locale":"en_US.UTF-8"}],"dcs":{"ttl":30,"loop_wait":10,"retry_timeout":10,"maximum_lag_on_failover":33554432,"postgresql":{"parameters":{"max_connections":"100","max_locks_per_transaction":"64","max_worker_processes":"4"}}}}}`
 	spiloConfigDiff     = `{"postgresql":{"bin_dir":"/usr/lib/postgresql/12/bin","parameters":{"autovacuum_analyze_scale_factor":"0.1"},"pg_hba":["hostssl all all 0.0.0.0/0 md5","host all all 0.0.0.0/0 md5"]},"bootstrap":{"initdb":[{"auth-host":"md5"},{"auth-local":"trust"},"data-checksums",{"encoding":"UTF8"},{"locale":"en_US.UTF-8"}],"dcs":{"loop_wait":10,"retry_timeout":10,"maximum_lag_on_failover":33554432,"postgresql":{"parameters":{"max_locks_per_transaction":"64","max_worker_processes":"4"}}}}}`
+	leaderLabelValue    = "primary"
 )
 
 var logger = logrus.New().WithField("test", "cluster")
@@ -55,6 +56,7 @@ var cl = New(
 			},
 			Resources: config.Resources{
 				DownscalerAnnotations: []string{"downscaler/*"},
+				PodLeaderLabelValue:   leaderLabelValue,
 			},
 			ConnectionPooler: config.ConnectionPooler{
 				User: poolerUserName,
@@ -126,7 +128,7 @@ func TestCreate(t *testing.T) {
 			Labels: map[string]string{
 				"application":  "spilo",
 				"cluster-name": clusterName,
-				"spilo-role":   "master",
+				"spilo-role":   leaderLabelValue,
 			},
 		},
 	}
@@ -147,6 +149,7 @@ func TestCreate(t *testing.T) {
 					DefaultMemoryRequest:  "300Mi",
 					DefaultMemoryLimit:    "300Mi",
 					PodRoleLabel:          "spilo-role",
+					PodLeaderLabelValue:   leaderLabelValue,
 					ResourceCheckInterval: time.Duration(3),
 					ResourceCheckTimeout:  time.Duration(10),
 				},
@@ -663,7 +666,7 @@ func TestServiceAnnotations(t *testing.T) {
 		//MASTER
 		{
 			about:                        "Master with no annotations and EnableMasterLoadBalancer disabled on spec and OperatorConfig",
-			role:                         "master",
+			role:                         leaderLabelValue,
 			enableMasterLoadBalancerSpec: &disabled,
 			enableMasterLoadBalancerOC:   false,
 			enableTeamIdClusterPrefix:    false,
@@ -673,7 +676,7 @@ func TestServiceAnnotations(t *testing.T) {
 		},
 		{
 			about:                        "Master with no annotations and EnableMasterLoadBalancer enabled on spec",
-			role:                         "master",
+			role:                         leaderLabelValue,
 			enableMasterLoadBalancerSpec: &enabled,
 			enableMasterLoadBalancerOC:   false,
 			enableTeamIdClusterPrefix:    false,
@@ -686,7 +689,7 @@ func TestServiceAnnotations(t *testing.T) {
 		},
 		{
 			about:                        "Master with no annotations and EnableMasterLoadBalancer enabled only on operator config",
-			role:                         "master",
+			role:                         leaderLabelValue,
 			enableMasterLoadBalancerSpec: &disabled,
 			enableMasterLoadBalancerOC:   true,
 			enableTeamIdClusterPrefix:    false,
@@ -696,7 +699,7 @@ func TestServiceAnnotations(t *testing.T) {
 		},
 		{
 			about:                      "Master with no annotations and EnableMasterLoadBalancer defined only on operator config",
-			role:                       "master",
+			role:                       leaderLabelValue,
 			enableMasterLoadBalancerOC: true,
 			enableTeamIdClusterPrefix:  false,
 			operatorAnnotations:        make(map[string]string),
@@ -708,7 +711,7 @@ func TestServiceAnnotations(t *testing.T) {
 		},
 		{
 			about:                      "Master with cluster annotations and load balancer enabled",
-			role:                       "master",
+			role:                       leaderLabelValue,
 			enableMasterLoadBalancerOC: true,
 			enableTeamIdClusterPrefix:  false,
 			operatorAnnotations:        make(map[string]string),
@@ -721,7 +724,7 @@ func TestServiceAnnotations(t *testing.T) {
 		},
 		{
 			about:                        "Master with cluster annotations and load balancer disabled",
-			role:                         "master",
+			role:                         leaderLabelValue,
 			enableMasterLoadBalancerSpec: &disabled,
 			enableMasterLoadBalancerOC:   true,
 			enableTeamIdClusterPrefix:    false,
@@ -731,7 +734,7 @@ func TestServiceAnnotations(t *testing.T) {
 		},
 		{
 			about:                      "Master with operator annotations and load balancer enabled",
-			role:                       "master",
+			role:                       leaderLabelValue,
 			enableMasterLoadBalancerOC: true,
 			enableTeamIdClusterPrefix:  false,
 			operatorAnnotations:        map[string]string{"foo": "bar"},
@@ -744,7 +747,7 @@ func TestServiceAnnotations(t *testing.T) {
 		},
 		{
 			about:                      "Master with operator annotations override default annotations",
-			role:                       "master",
+			role:                       leaderLabelValue,
 			enableMasterLoadBalancerOC: true,
 			enableTeamIdClusterPrefix:  false,
 			operatorAnnotations: map[string]string{
@@ -758,7 +761,7 @@ func TestServiceAnnotations(t *testing.T) {
 		},
 		{
 			about:                      "Master with cluster annotations override default annotations",
-			role:                       "master",
+			role:                       leaderLabelValue,
 			enableMasterLoadBalancerOC: true,
 			enableTeamIdClusterPrefix:  false,
 			operatorAnnotations:        make(map[string]string),
@@ -772,7 +775,7 @@ func TestServiceAnnotations(t *testing.T) {
 		},
 		{
 			about:                      "Master with cluster annotations do not override external-dns annotations",
-			role:                       "master",
+			role:                       leaderLabelValue,
 			enableMasterLoadBalancerOC: true,
 			enableTeamIdClusterPrefix:  false,
 			operatorAnnotations:        make(map[string]string),
@@ -786,7 +789,7 @@ func TestServiceAnnotations(t *testing.T) {
 		},
 		{
 			about:                      "Master with cluster name teamId prefix enabled",
-			role:                       "master",
+			role:                       leaderLabelValue,
 			enableMasterLoadBalancerOC: true,
 			enableTeamIdClusterPrefix:  true,
 			serviceAnnotations:         make(map[string]string),
@@ -798,7 +801,7 @@ func TestServiceAnnotations(t *testing.T) {
 		},
 		{
 			about:                      "Master with master service annotations override service annotations",
-			role:                       "master",
+			role:                       leaderLabelValue,
 			enableMasterLoadBalancerOC: true,
 			enableTeamIdClusterPrefix:  false,
 			operatorAnnotations:        make(map[string]string),

pkg/cluster/connection_pooler.go

@@ -49,7 +49,7 @@ type ConnectionPoolerObjects struct {
 
 func (c *Cluster) connectionPoolerName(role PostgresRole) string {
 	name := fmt.Sprintf("%s-%s", c.Name, constants.ConnectionPoolerResourceSuffix)
-	if role == Replica {
+	if role == c.replicaRole() {
 		name = fmt.Sprintf("%s-%s", name, "repl")
 	}
 	return name
@@ -537,8 +537,8 @@ func (c *Cluster) generatePoolerServiceAnnotations(role PostgresRole, spec *acid
 			annotations[constants.ElbTimeoutAnnotationName] = constants.ElbTimeoutAnnotationValue
 		}
 		// -repl suffix will be added by replicaDNSName
-		clusterNameWithPoolerSuffix := c.connectionPoolerName(Master)
-		if role == Master {
+		clusterNameWithPoolerSuffix := c.connectionPoolerName(c.masterRole())
+		if role == c.masterRole() {
 			dnsString = c.masterDNSName(clusterNameWithPoolerSuffix)
 		} else {
 			dnsString = c.replicaDNSName(clusterNameWithPoolerSuffix)
@@ -557,15 +557,15 @@ func (c *Cluster) shouldCreateLoadBalancerForPoolerService(role PostgresRole, sp
 
 	switch role {
 
-	case Replica:
+	case c.replicaRole():
 		// if the value is explicitly set in a Postgresql manifest, follow this setting
 		if spec.EnableReplicaPoolerLoadBalancer != nil {
 			return *spec.EnableReplicaPoolerLoadBalancer
 		}
 		// otherwise, follow the operator configuration
 		return c.OpConfig.EnableReplicaPoolerLoadBalancer
 
-	case Master:
+	case c.masterRole():
 		if spec.EnableMasterPoolerLoadBalancer != nil {
 			return *spec.EnableMasterPoolerLoadBalancer
 		}
@@ -877,9 +877,9 @@ func (c *Cluster) syncConnectionPooler(oldSpec, newSpec *acidv1.Postgresql, Look
 	logPoolerEssentials(c.logger, oldSpec, newSpec)
 
 	// Check and perform the sync requirements for each of the roles.
-	for _, role := range [2]PostgresRole{Master, Replica} {
+	for _, role := range [2]PostgresRole{c.masterRole(), c.replicaRole()} {
 
-		if role == Master {
+		if role == c.masterRole() {
 			connectionPoolerNeeded = needMasterConnectionPoolerWorker(&newSpec.Spec)
 		} else {
 			connectionPoolerNeeded = needReplicaConnectionPoolerWorker(&newSpec.Spec)