kubernetes_use_configmap (zalando#887)

ReSearchITEng · FxKu · web-flow · commit 1249626a6023 · 2020-04-02T13:20:45.000+02:00
* kubernetes_use_configmap

* Update manifests/postgresql-operator-default-configuration.yaml

Co-Authored-By: Felix Kunde &lt;felix-kunde@gmx.de&gt;

* Update manifests/configmap.yaml

Co-Authored-By: Felix Kunde &lt;felix-kunde@gmx.de&gt;

* Update charts/postgres-operator/values.yaml

Co-Authored-By: Felix Kunde &lt;felix-kunde@gmx.de&gt;

* go.fmt

Co-authored-by: Felix Kunde &lt;felix-kunde@gmx.de&gt;
diff --git a/charts/postgres-operator/crds/operatorconfigurations.yaml b/charts/postgres-operator/crds/operatorconfigurations.yaml
@@ -66,6 +66,8 @@ spec:
               type: boolean
             etcd_host:
               type: string
+            kubernetes_use_configmaps:
+              type: boolean
             max_instances:
               type: integer
               minimum: -1  # -1 = disabled
diff --git a/charts/postgres-operator/values-crd.yaml b/charts/postgres-operator/values-crd.yaml
@@ -23,6 +23,8 @@ configGeneral:
   enable_shm_volume: true
   # etcd connection string for Patroni. Empty uses K8s-native DCS.
   etcd_host: ""
+  # Select if setup uses endpoints (default), or configmaps to manage leader (DCS=k8s)
+  # kubernetes_use_configmaps: false
   # Spilo docker image
   docker_image: registry.opensource.zalan.do/acid/spilo-12:1.6-p2
   # max number of instances in Postgres cluster. -1 = no limit
diff --git a/charts/postgres-operator/values.yaml b/charts/postgres-operator/values.yaml
@@ -23,6 +23,8 @@ configGeneral:
   enable_shm_volume: "true"
   # etcd connection string for Patroni. Empty uses K8s-native DCS.
   etcd_host: ""
+  # Select if setup uses endpoints (default), or configmaps to manage leader (DCS=k8s)
+  # kubernetes_use_configmaps: "false"
   # Spilo docker image
   docker_image: registry.opensource.zalan.do/acid/spilo-12:1.6-p2
   # max number of instances in Postgres cluster. -1 = no limit
diff --git a/docs/reference/operator_parameters.md b/docs/reference/operator_parameters.md
@@ -80,6 +80,12 @@ Those are top-level keys, containing both leaf keys and groups.
   Patroni native Kubernetes support is used. The default is empty (use
   Kubernetes-native DCS).
 
+* **kubernetes_use_configmaps**
+  Select if setup uses endpoints (default), or configmaps to manage leader when
+  DCS is kubernetes (not etcd or similar). In OpenShift it is not possible to
+  use endpoints option, and configmaps is required. By default, 
+  `kubernetes_use_configmaps: false`, meaning endpoints will be used.
+
 * **docker_image**
   Spilo Docker image for Postgres instances. For production, don't rely on the
   default image, as it might be not the most up-to-date one. Instead, build
diff --git a/manifests/configmap.yaml b/manifests/configmap.yaml
@@ -43,6 +43,7 @@ data:
   # enable_team_superuser: "false"
   enable_teams_api: "false"
   # etcd_host: ""
+  # kubernetes_use_configmaps: "false"
   # infrastructure_roles_secret_name: postgresql-infrastructure-roles
   # inherited_labels: application,environment
   # kube_iam_role: ""
diff --git a/manifests/operatorconfiguration.crd.yaml b/manifests/operatorconfiguration.crd.yaml
@@ -42,6 +42,8 @@ spec:
               type: boolean
             etcd_host:
               type: string
+            kubernetes_use_configmaps:
+              type: boolean
             max_instances:
               type: integer
               minimum: -1  # -1 = disabled
diff --git a/manifests/postgresql-operator-default-configuration.yaml b/manifests/postgresql-operator-default-configuration.yaml
@@ -5,6 +5,7 @@ metadata:
 configuration:
   # enable_crd_validation: true
   etcd_host: ""
+  # kubernetes_use_configmaps: false
   docker_image: registry.opensource.zalan.do/acid/spilo-12:1.6-p2
   # enable_shm_volume: true
   max_instances: -1
diff --git a/pkg/apis/acid.zalan.do/v1/crds.go b/pkg/apis/acid.zalan.do/v1/crds.go
@@ -727,6 +727,9 @@ var OperatorConfigCRDResourceValidation = apiextv1beta1.CustomResourceValidation
 					"etcd_host": {
 						Type: "string",
 					},
+					"kubernetes_use_configmaps": {
+						Type: "boolean",
+					},
 					"max_instances": {
 						Type:        "integer",
 						Description: "-1 = disabled",
diff --git a/pkg/apis/acid.zalan.do/v1/operator_configuration_type.go b/pkg/apis/acid.zalan.do/v1/operator_configuration_type.go
@@ -183,6 +183,7 @@ type OperatorLogicalBackupConfiguration struct {
 type OperatorConfigurationData struct {
 	EnableCRDValidation        *bool                              `json:"enable_crd_validation,omitempty"`
 	EtcdHost                   string                             `json:"etcd_host,omitempty"`
+	KubernetesUseConfigMaps    bool                               `json:"kubernetes_use_configmaps,omitempty"`
 	DockerImage                string                             `json:"docker_image,omitempty"`
 	Workers                    uint32                             `json:"workers,omitempty"`
 	MinInstances               int32                              `json:"min_instances,omitempty"`
diff --git a/pkg/cluster/k8sres.go b/pkg/cluster/k8sres.go
@@ -672,6 +672,10 @@ func (c *Cluster) generateSpiloPodEnvVars(uid types.UID, spiloConfiguration stri
 		envVars = append(envVars, v1.EnvVar{Name: "ETCD_HOST", Value: c.OpConfig.EtcdHost})
 	}
 
+	if c.patroniKubernetesUseConfigMaps() {
+		envVars = append(envVars, v1.EnvVar{Name: "KUBERNETES_USE_CONFIGMAPS", Value: "true"})
+	}
+
 	if cloneDescription.ClusterName != "" {
 		envVars = append(envVars, c.generateCloneEnvironment(cloneDescription)...)
 	}
@@ -1406,7 +1410,7 @@ func (c *Cluster) generateService(role PostgresRole, spec *acidv1.PostgresSpec)
 		Type:  v1.ServiceTypeClusterIP,
 	}
 
-	if role == Replica {
+	if role == Replica || c.patroniKubernetesUseConfigMaps() {
 		serviceSpec.Selector = c.roleLabelsSet(false, role)
 	}
 
diff --git a/pkg/cluster/util.go b/pkg/cluster/util.go
@@ -510,6 +510,15 @@ func (c *Cluster) patroniUsesKubernetes() bool {
 	return c.OpConfig.EtcdHost == ""
 }
 
+func (c *Cluster) patroniKubernetesUseConfigMaps() bool {
+	if !c.patroniUsesKubernetes() {
+		return false
+	}
+
+	// otherwise, follow the operator configuration
+	return c.OpConfig.KubernetesUseConfigMaps
+}
+
 func (c *Cluster) needConnectionPoolerWorker(spec *acidv1.PostgresSpec) bool {
 	if spec.EnableConnectionPooler == nil {
 		return spec.ConnectionPooler != nil
diff --git a/pkg/controller/operator_config.go b/pkg/controller/operator_config.go
@@ -35,6 +35,7 @@ func (c *Controller) importConfigurationFromCRD(fromCRD *acidv1.OperatorConfigur
 	// general config
 	result.EnableCRDValidation = fromCRD.EnableCRDValidation
 	result.EtcdHost = fromCRD.EtcdHost
+	result.KubernetesUseConfigMaps = fromCRD.KubernetesUseConfigMaps
 	result.DockerImage = fromCRD.DockerImage
 	result.Workers = fromCRD.Workers
 	result.MinInstances = fromCRD.MinInstances
diff --git a/pkg/util/config/config.go b/pkg/util/config/config.go
@@ -107,11 +107,12 @@ type Config struct {
 	LogicalBackup
 	ConnectionPooler
 
-	WatchedNamespace      string            `name:"watched_namespace"`    // special values: "*" means 'watch all namespaces', the empty string "" means 'watch a namespace where operator is deployed to'
-	EtcdHost              string            `name:"etcd_host" default:""` // special values: the empty string "" means Patroni will use K8s as a DCS
-	DockerImage           string            `name:"docker_image" default:"registry.opensource.zalan.do/acid/spilo-12:1.6-p2"`
-	Sidecars              map[string]string `name:"sidecar_docker_images"`
-	PodServiceAccountName string            `name:"pod_service_account_name" default:"postgres-pod"`
+	WatchedNamespace        string            `name:"watched_namespace"` // special values: "*" means 'watch all namespaces', the empty string "" means 'watch a namespace where operator is deployed to'
+	KubernetesUseConfigMaps bool              `name:"kubernetes_use_configmaps" default:"false"`
+	EtcdHost                string            `name:"etcd_host" default:""` // special values: the empty string "" means Patroni will use K8s as a DCS
+	DockerImage             string            `name:"docker_image" default:"registry.opensource.zalan.do/acid/spilo-12:1.6-p2"`
+	Sidecars                map[string]string `name:"sidecar_docker_images"`
+	PodServiceAccountName   string            `name:"pod_service_account_name" default:"postgres-pod"`
 	// value of this string must be valid JSON or YAML; see initPodServiceAccount
 	PodServiceAccountDefinition            string            `name:"pod_service_account_definition" default:""`
 	PodServiceAccountRoleBindingDefinition string            `name:"pod_service_account_role_binding_definition" default:""`

Original file line number	Diff line number	Diff line change
`@@ -672,6 +672,10 @@ func (c *Cluster) generateSpiloPodEnvVars(uid types.UID, spiloConfiguration stri`
`672`	`672`	`envVars = append(envVars, v1.EnvVar{Name: "ETCD_HOST", Value: c.OpConfig.EtcdHost})`
`673`	`673`	`}`
`674`	`674`
	`675`	`+ if c.patroniKubernetesUseConfigMaps() {`
	`676`	`+ envVars = append(envVars, v1.EnvVar{Name: "KUBERNETES_USE_CONFIGMAPS", Value: "true"})`
	`677`	`+ }`
	`678`	`+`
`675`	`679`	`if cloneDescription.ClusterName != "" {`
`676`	`680`	`envVars = append(envVars, c.generateCloneEnvironment(cloneDescription)...)`
`677`	`681`	`}`
`@@ -1406,7 +1410,7 @@ func (c Cluster) generateService(role PostgresRole, spec acidv1.PostgresSpec)`
`1406`	`1410`	`Type: v1.ServiceTypeClusterIP,`
`1407`	`1411`	`}`
`1408`	`1412`
`1409`		`- if role == Replica {`
	`1413`	`+ if role == Replica \|\| c.patroniKubernetesUseConfigMaps() {`
`1410`	`1414`	`serviceSpec.Selector = c.roleLabelsSet(false, role)`
`1411`	`1415`	`}`
`1412`	`1416`