Cleanup configuration

Add pool configuration into CRD & charts. Add preliminary documentation.
Rename NumberOfInstances to Replicas like in Deployment. Mention couple
of potential improvement points for connection pool specification.

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

@@ -65,12 +65,12 @@ type KubernetesMetaConfiguration struct {
 	// TODO: use a proper toleration structure?
 	PodToleration map[string]string `json:"toleration,omitempty"`
 	// TODO: use namespacedname
-	PodEnvironmentConfigMap    string        `json:"pod_environment_configmap,omitempty"`
-	PodPriorityClassName       string        `json:"pod_priority_class_name,omitempty"`
-	MasterPodMoveTimeout       Duration      `json:"master_pod_move_timeout,omitempty"`
-	EnablePodAntiAffinity      bool          `json:"enable_pod_antiaffinity,omitempty"`
-	PodAntiAffinityTopologyKey string        `json:"pod_antiaffinity_topology_key,omitempty"`
-	PodManagementPolicy        string        `json:"pod_management_policy,omitempty"`
+	PodEnvironmentConfigMap    string   `json:"pod_environment_configmap,omitempty"`
+	PodPriorityClassName       string   `json:"pod_priority_class_name,omitempty"`
+	MasterPodMoveTimeout       Duration `json:"master_pod_move_timeout,omitempty"`
+	EnablePodAntiAffinity      bool     `json:"enable_pod_antiaffinity,omitempty"`
+	PodAntiAffinityTopologyKey string   `json:"pod_antiaffinity_topology_key,omitempty"`
+	PodManagementPolicy        string   `json:"pod_management_policy,omitempty"`
 }
 
 // PostgresPodResourcesDefaults defines the spec of default resources
@@ -154,10 +154,9 @@ type ScalyrConfiguration struct {
 
 // Defines default configuration for connection pool
 type ConnectionPoolConfiguration struct {
-	NumberOfInstances    *int32 `json:"connection_pool_instances_number,omitempty"`
+	Replicas             *int32 `json:"connection_pool_replicas,omitempty"`
 	Schema               string `json:"connection_pool_schema,omitempty"`
 	User                 string `json:"connection_pool_user,omitempty"`
-	Type                 string `json:"connection_pool_type,omitempty"`
 	Image                string `json:"connection_pool_image,omitempty"`
 	Mode                 string `json:"connection_pool_mode,omitempty"`
 	DefaultCPURequest    string `name:"connection_pool_default_cpu_request,omitempty"`

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

@@ -27,7 +27,7 @@ type PostgresSpec struct {
 	Patroni         `json:"patroni,omitempty"`
 	Resources       `json:"resources,omitempty"`
 
-	EnableConnectionPool bool            `json:"enable_connection_pool,omitempty"`
+	EnableConnectionPool bool            `json:"enableConnectionPool,omitempty"`
 	ConnectionPool       *ConnectionPool `json:"connectionPool,omitempty"`
 
 	TeamID      string `json:"teamId"`
@@ -159,16 +159,21 @@ type PostgresStatus struct {
 }
 
 // Options for connection pooler
+//
+// TODO: prepared snippets of configuration, one can choose via type, e.g.
+// pgbouncer-large (with higher resources) or odyssey-small (with smaller
+// resources)
+// Type              string `json:"type,omitempty"`
+//
+// TODO: figure out what other important parameters of the connection pool it
+// makes sense to expose. E.g. pool size (min/max boundaries), max client
+// connections etc.
 type ConnectionPool struct {
-	NumberOfInstances *int32 `json:"instancesNumber,omitempty"`
-	Schema            string `json:"schema,omitempty"`
-	User              string `json:"user,omitempty"`
-	Mode              string `json:"mode,omitempty"`
-	DockerImage       string `json:"dockerImage,omitempty"`
-	// TODO: prepared snippets of configuration, one can choose via type, e.g.
-	// pgbouncer-large (with higher resources) or odyssey-small (with smaller
-	// resources)
-	// Type              string `json:"type,omitempty"`
+	Replicas    *int32 `json:"replicas,omitempty"`
+	Schema      string `json:"schema,omitempty"`
+	User        string `json:"user,omitempty"`
+	Mode        string `json:"mode,omitempty"`
+	DockerImage string `json:"dockerImage,omitempty"`
 
 	Resources `json:"resources,omitempty"`
 }

pkg/cluster/k8sres.go

@@ -1861,9 +1861,9 @@ func (c *Cluster) generateConnPoolDeployment(spec *acidv1.PostgresSpec) (
 	*appsv1.Deployment, error) {
 
 	podTemplate, err := c.generateConnPoolPodTemplate(spec)
-	numberOfInstances := spec.ConnectionPool.NumberOfInstances
+	numberOfInstances := spec.ConnectionPool.Replicas
 	if numberOfInstances == nil {
-		numberOfInstances = c.OpConfig.ConnectionPool.NumberOfInstances
+		numberOfInstances = c.OpConfig.ConnectionPool.Replicas
 	}
 
 	if err != nil {

pkg/cluster/sync_test.go

@@ -99,14 +99,14 @@ func TestConnPoolSynchronization(t *testing.T) {
 			oldSpec: &acidv1.Postgresql{
 				Spec: acidv1.PostgresSpec{
 					ConnectionPool: &acidv1.ConnectionPool{
-						NumberOfInstances: int32ToPointer(1),
+						Replicas: int32ToPointer(1),
 					},
 				},
 			},
 			newSpec: &acidv1.Postgresql{
 				Spec: acidv1.PostgresSpec{
 					ConnectionPool: &acidv1.ConnectionPool{
-						NumberOfInstances: int32ToPointer(2),
+						Replicas: int32ToPointer(2),
 					},
 				},
 			},

pkg/controller/operator_config.go

@@ -146,13 +146,13 @@ func (c *Controller) importConfigurationFromCRD(fromCRD *acidv1.OperatorConfigur
 
 	// Connection pool. Looks like we can't use defaulting in CRD before 1.17,
 	// so ensure default values here.
-	result.ConnectionPool.NumberOfInstances = fromCRD.ConnectionPool.NumberOfInstances
-	if result.ConnectionPool.NumberOfInstances == nil ||
-		*result.ConnectionPool.NumberOfInstances < 1 {
+	result.ConnectionPool.Replicas = fromCRD.ConnectionPool.Replicas
+	if result.ConnectionPool.Replicas == nil ||
+		*result.ConnectionPool.Replicas < 1 {
 		var value int32
 
 		value = 1
-		result.ConnectionPool.NumberOfInstances = &value
+		result.ConnectionPool.Replicas = &value
 	}
 
 	result.ConnectionPool.Schema = util.Coalesce(
@@ -163,10 +163,6 @@ func (c *Controller) importConfigurationFromCRD(fromCRD *acidv1.OperatorConfigur
 		fromCRD.ConnectionPool.User,
 		constants.ConnectionPoolUserName)
 
-	result.ConnectionPool.Type = util.Coalesce(
-		fromCRD.ConnectionPool.Type,
-		constants.ConnectionPoolDefaultType)
-
 	result.ConnectionPool.Image = util.Coalesce(
 		fromCRD.ConnectionPool.Image,
 		"pgbouncer:0.0.1")

pkg/util/config/config.go

@@ -85,10 +85,9 @@ type LogicalBackup struct {
 
 // Operator options for connection pooler
 type ConnectionPool struct {
-	NumberOfInstances            *int32 `name:"connection_pool_instances_number" default:"1"`
+	Replicas                     *int32 `name:"connection_pool_replicas" default:"1"`
 	Schema                       string `name:"connection_pool_schema" default:"pooler"`
 	User                         string `name:"connection_pool_user" default:"pooler"`
-	Type                         string `name:"connection_pool_type" default:"pgbouncer"`
 	Image                        string `name:"connection_pool_image"  default:"pgbouncer:1.0"`
 	Mode                         string `name:"connection_pool_mode"  default:"session"`
 	ConnPoolDefaultCPURequest    string `name:"connection_pool_default_cpu_request" default:"100m"`