Set memory request defaults for PostgreSQL, pgBackRest, pgBouncer

Author: Jonathan S. Katz

apiserver/clusterservice/clusterimpl.go

@@ -18,21 +18,19 @@ limitations under the License.
 import (
 	"errors"
 	"fmt"
-
 	"io/ioutil"
 	"strconv"
 	"strings"
 	"time"
 
 	crv1 "github.com/crunchydata/postgres-operator/apis/crunchydata.com/v1"
 	"github.com/crunchydata/postgres-operator/apiserver"
-	log "github.com/sirupsen/logrus"
-
 	msgs "github.com/crunchydata/postgres-operator/apiservermsgs"
 	"github.com/crunchydata/postgres-operator/config"
 	"github.com/crunchydata/postgres-operator/kubeapi"
 	"github.com/crunchydata/postgres-operator/util"
 
+	log "github.com/sirupsen/logrus"
 	v1 "k8s.io/api/core/v1"
 	kerrors "k8s.io/apimachinery/pkg/api/errors"
 	"k8s.io/apimachinery/pkg/api/resource"
@@ -1017,6 +1015,8 @@ func getClusterParams(request *msgs.CreateClusterRequest, name string, userLabel
 		// as this was already validated, we can ignore the error
 		quantity, _ := resource.ParseQuantity(request.MemoryRequest)
 		spec.Resources[v1.ResourceMemory] = quantity
+	} else {
+		spec.Resources[v1.ResourceMemory] = apiserver.Pgo.Cluster.DefaultInstanceResourceMemory
 	}
 
 	// similarly, if there are any overriding pgBackRest repository container
@@ -1031,6 +1031,8 @@ func getClusterParams(request *msgs.CreateClusterRequest, name string, userLabel
 		// as this was already validated, we can ignore the error
 		quantity, _ := resource.ParseQuantity(request.BackrestMemoryRequest)
 		spec.BackrestResources[v1.ResourceMemory] = quantity
+	} else {
+		spec.BackrestResources[v1.ResourceMemory] = apiserver.Pgo.Cluster.DefaultBackrestResourceMemory
 	}
 
 	// similarly, if there are any overriding pgBouncer container resource request
@@ -1045,6 +1047,8 @@ func getClusterParams(request *msgs.CreateClusterRequest, name string, userLabel
 		// as this was already validated, we can ignore the error
 		quantity, _ := resource.ParseQuantity(request.PgBouncerMemoryRequest)
 		spec.PgBouncerResources[v1.ResourceMemory] = quantity
+	} else {
+		spec.PgBouncerResources[v1.ResourceMemory] = apiserver.Pgo.Cluster.DefaultPgBouncerResourceMemory
 	}
 
 	spec.PrimaryStorage, _ = apiserver.Pgo.GetStorageSpec(apiserver.Pgo.PrimaryStorage)

apiserver/loadservice/loadconfig.go

@@ -24,17 +24,17 @@ import (
 )
 
 type LoadConfig struct {
-	PGOImagePrefix    string `yaml:"PGOImagePrefix"`
-	PGOImageTag       string `yaml:"PGOImageTag"`
-	DbDatabase        string `yaml:"DbDatabase"`
-	DbUser            string `yaml:"DbUser"`
-	DbPort            string `yaml:"DbPort"`
-	TableToLoad       string `yaml:"TableToLoad"`
-	FilePath          string `yaml:"FilePath"`
-	FileType          string `yaml:"FileType"`
-	PVCName           string `yaml:"PVCName"`
-	FSGroup           string `yaml:"FSGroup"`
-	SupplementalGroup string `yaml:"SupplementalGroup"`
+	PGOImagePrefix    string
+	PGOImageTag       string
+	DbDatabase        string
+	DbUser            string
+	DbPort            string
+	TableToLoad       string
+	FilePath          string
+	FileType          string
+	PVCName           string
+	FSGroup           string
+	SupplementalGroup string
 }
 
 func (c *LoadConfig) validate() error {

apiserver/pgbouncerservice/pgbouncerimpl.go

@@ -89,6 +89,8 @@ func CreatePgbouncer(request *msgs.CreatePgbouncerRequest, ns, pgouser string) m
 			// as this was already validated, we can ignore the error
 			quantity, _ := resource.ParseQuantity(request.MemoryRequest)
 			resources[v1.ResourceMemory] = quantity
+		} else {
+			resources[v1.ResourceMemory] = apiserver.Pgo.Cluster.DefaultPgBouncerResourceMemory
 		}
 
 		// set this value on the cluster spec, but this is only *temporary* in this

conf/postgres-operator/pgo.yaml

@@ -25,6 +25,9 @@ Cluster:
   PodAntiAffinityPgBackRest: ""
   PodAntiAffinityPgBouncer: ""
   SyncReplication: false
+  DefaultInstanceMemory:
+  DefaultBackrestMemory:
+  DefaultPgBouncerMemory:
 PrimaryStorage: storageos
 BackupStorage: storageos
 ReplicaStorage: storageos

config/defaults.go

@@ -0,0 +1,38 @@
+package config
+
+/*
+ Copyright 2020 Crunchy Data Solutions, Inc.
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+*/
+
+import (
+	"k8s.io/apimachinery/pkg/api/resource"
+)
+
+// Default resource values for deploying a PostgreSQL cluster. These values are
+// utilized if the user has not provided these values either through
+// configuration or from one-off API/CLI calls.
+//
+// These values were determined by either program defaults (e.g. the PostgreSQL
+// one) and/or loose to vigorous experimentation and profiling
+var (
+	// DefaultBackrestRepoResourceMemory is the default value of the resource request
+	// for memory for a pgBackRest repository
+	DefaultBackrestResourceMemory = resource.MustParse("48Mi")
+	// DefaultInstanceResourceMemory is the default value of the resource request
+	// for memory for a PostgreSQL instance in a cluster
+	DefaultInstanceResourceMemory = resource.MustParse("512Mi")
+	// DefaultPgBouncerResourceMemory is the default value of the resource request
+	// for memory of a pgBouncer instance
+	DefaultPgBouncerResourceMemory = resource.MustParse("24Mi")
+)

config/pgoconfig.go

@@ -184,69 +184,72 @@ var DeploymentTemplate *template.Template
 const deploymentTemplatePath = "cluster-deployment.json"
 
 type ClusterStruct struct {
-	CCPImagePrefix                string `yaml:"CCPImagePrefix"`
-	CCPImageTag                   string `yaml:"CCPImageTag"`
-	PrimaryNodeLabel              string `yaml:"PrimaryNodeLabel"`
-	ReplicaNodeLabel              string `yaml:"ReplicaNodeLabel"`
-	Policies                      string `yaml:"Policies"`
-	Metrics                       bool   `yaml:"Metrics"`
-	Badger                        bool   `yaml:"Badger"`
-	Port                          string `yaml:"Port"`
-	PGBadgerPort                  string `yaml:"PGBadgerPort"`
-	ExporterPort                  string `yaml:"ExporterPort"`
-	User                          string `yaml:"User"`
-	Database                      string `yaml:"Database"`
-	PasswordAgeDays               string `yaml:"PasswordAgeDays"`
-	PasswordLength                string `yaml:"PasswordLength"`
-	Replicas                      string `yaml:"Replicas"`
-	ServiceType                   string `yaml:"ServiceType"`
-	BackrestPort                  int    `yaml:"BackrestPort"`
-	Backrest                      bool   `yaml:"Backrest"`
-	BackrestS3Bucket              string `yaml:"BackrestS3Bucket"`
-	BackrestS3Endpoint            string `yaml:"BackrestS3Endpoint"`
-	BackrestS3Region              string `yaml:"BackrestS3Region"`
-	DisableAutofail               bool   `yaml:"DisableAutofail"`
-	PgmonitorPassword             string `yaml:"PgmonitorPassword"`
-	EnableCrunchyadm              bool   `yaml:"EnableCrunchyadm"`
-	DisableReplicaStartFailReinit bool   `yaml:"DisableReplicaStartFailReinit"`
-	PodAntiAffinity               string `yaml:"PodAntiAffinity"`
-	PodAntiAffinityPgBackRest     string `yaml:"PodAntiAffinityPgBackRest"`
-	PodAntiAffinityPgBouncer      string `yaml:"PodAntiAffinityPgBouncer"`
-	SyncReplication               bool   `yaml:"SyncReplication"`
+	CCPImagePrefix                 string
+	CCPImageTag                    string
+	PrimaryNodeLabel               string
+	ReplicaNodeLabel               string
+	Policies                       string
+	Metrics                        bool
+	Badger                         bool
+	Port                           string
+	PGBadgerPort                   string
+	ExporterPort                   string
+	User                           string
+	Database                       string
+	PasswordAgeDays                string
+	PasswordLength                 string
+	Replicas                       string
+	ServiceType                    string
+	BackrestPort                   int
+	Backrest                       bool
+	BackrestS3Bucket               string
+	BackrestS3Endpoint             string
+	BackrestS3Region               string
+	DisableAutofail                bool
+	PgmonitorPassword              string
+	EnableCrunchyadm               bool
+	DisableReplicaStartFailReinit  bool
+	PodAntiAffinity                string
+	PodAntiAffinityPgBackRest      string
+	PodAntiAffinityPgBouncer       string
+	SyncReplication                bool
+	DefaultInstanceResourceMemory  resource.Quantity `json:"DefaultInstanceMemory"`
+	DefaultBackrestResourceMemory  resource.Quantity `json:"DefaultBackrestMemory"`
+	DefaultPgBouncerResourceMemory resource.Quantity `json:"DefaultPgBouncerMemory"`
 }
 
 type StorageStruct struct {
-	AccessMode         string `yaml:"AccessMode"`
-	Size               string `yaml:"Size"`
-	StorageType        string `yaml:"StorageType"`
-	StorageClass       string `yaml:"StorageClass"`
-	SupplementalGroups string `yaml:"SupplementalGroups"`
-	MatchLabels        string `yaml:"MatchLabels"`
+	AccessMode         string
+	Size               string
+	StorageType        string
+	StorageClass       string
+	SupplementalGroups string
+	MatchLabels        string
 }
 
 type ContainerResourcesStruct struct {
-	RequestsMemory string `yaml:"RequestsMemory"`
-	RequestsCPU    string `yaml:"RequestsCPU"`
-	LimitsMemory   string `yaml:"LimitsMemory"`
-	LimitsCPU      string `yaml:"LimitsCPU"`
+	RequestsMemory string
+	RequestsCPU    string
+	LimitsMemory   string
+	LimitsCPU      string
 }
 
 type PgoStruct struct {
-	Audit          bool   `yaml:"Audit"`
-	PGOImagePrefix string `yaml:"PGOImagePrefix"`
-	PGOImageTag    string `yaml:"PGOImageTag"`
+	Audit          bool
+	PGOImagePrefix string
+	PGOImageTag    string
 }
 
 type PgoConfig struct {
-	BasicAuth          string                              `yaml:"BasicAuth"`
-	Cluster            ClusterStruct                       `yaml:"Cluster"`
-	Pgo                PgoStruct                           `yaml:"Pgo"`
-	ContainerResources map[string]ContainerResourcesStruct `yaml:"ContainerResources"`
-	PrimaryStorage     string                              `yaml:"PrimaryStorage"`
-	BackupStorage      string                              `yaml:"BackupStorage"`
-	ReplicaStorage     string                              `yaml:"ReplicaStorage"`
-	BackrestStorage    string                              `yaml:"BackrestStorage"`
-	Storage            map[string]StorageStruct            `yaml:"Storage"`
+	BasicAuth          string
+	Cluster            ClusterStruct
+	Pgo                PgoStruct
+	ContainerResources map[string]ContainerResourcesStruct
+	PrimaryStorage     string
+	BackupStorage      string
+	ReplicaStorage     string
+	BackrestStorage    string
+	Storage            map[string]StorageStruct
 }
 
 const DEFAULT_SERVICE_TYPE = "ClusterIP"
@@ -374,6 +377,25 @@ func (c *PgoConfig) Validate() error {
 			}
 			return errors.New(errPrefix + msg)
 		}
+
+		// validate any of the resources and if they are unavailable, set defaults
+		if c.Cluster.DefaultInstanceResourceMemory.IsZero() {
+			c.Cluster.DefaultInstanceResourceMemory = DefaultInstanceResourceMemory
+		}
+
+		log.Infof("deafult instance memory set to [%s]", c.Cluster.DefaultInstanceResourceMemory.String())
+
+		if c.Cluster.DefaultBackrestResourceMemory.IsZero() {
+			c.Cluster.DefaultBackrestResourceMemory = DefaultBackrestResourceMemory
+		}
+
+		log.Infof("deafult pgbackrest repository memory set to [%s]", c.Cluster.DefaultBackrestResourceMemory.String())
+
+		if c.Cluster.DefaultPgBouncerResourceMemory.IsZero() {
+			c.Cluster.DefaultPgBouncerResourceMemory = DefaultPgBouncerResourceMemory
+		}
+
+		log.Infof("deafult pgbouncer memory set to [%s]", c.Cluster.DefaultPgBouncerResourceMemory.String())
 	}
 
 	// if provided, ensure that the type of pod anti-affinity values are valid
@@ -522,9 +544,8 @@ func (c *PgoConfig) GetConfig(clientset *kubernetes.Clientset, namespace string)
 		return err
 	}
 
-	//validate the pgo.yaml config file
-	err = c.Validate()
-	if err != nil {
+	// validate the pgo.yaml config file
+	if err := c.Validate(); err != nil {
 		log.Error(err)
 		return err
 	}

docs/content/Configuration/pgo-yaml-configuration.md

@@ -38,6 +38,9 @@ The *pgo.yaml* file is broken into major sections as described below:
 |DisableReplicaStartFailReinit | if set to `true` will disable the detection of a "start failed" states in PG replicas, which results in the re-initialization of the replica in an attempt to bring it back online
 |PodAntiAffinity        | either `preferred`, `required` or `disabled` to either specify the type of affinity that should be utilized for the default pod anti-affinity applied to PG clusters, or to disable default pod anti-affinity all together (default `preferred`)
 |SyncReplication | boolean, if set to `true` will automatically enable synchronous replication in new PostgreSQL clusters (default `false`)
+|DefaultInstanceMemory | string, matches a Kubernetes resource value. If set, it is used as the default value of the memory request for each instance in a PostgreSQL cluster (default `512Mi`)
+|DefaultBackrestMemory | string, matches a Kubernetes resource value. If set, it is used as the default value of the memory request for the pgBackRest repository (default `48Mi`)
+|DefaultPgBouncerMemory | string, matches a Kubernetes resource value. If set, it is used as the default value of the memory request for pgBouncer instances (default `24Mi`)
 
 ## Storage
 | Setting|Definition  |

docs/content/Installation/install-with-ansible/prerequisites.md

@@ -166,6 +166,9 @@ sets of variables cannot be used at the same time.
 | `cleanup`                         | false       |          | Set to configure the playbooks to delete all objects when uninstalling the Operator.  Note: this will delete all objects related to the Operator (including clusters provisioned). |
 | `create_rbac`                     | true        | **Required** | Set to `true` if the installer should create the RBAC resources required to run the PostgreSQL Operator. |
 | `crunchy_debug`                   | false       |          | Set to configure Operator to use debugging mode.  Note: this can cause sensitive data such as passwords to appear in Operator logs.                                              |
+| `default_instance_memory`         | 512Mi       |          | The default amount of memory to request for a PostgreSQL instance                     |
+| `default_pgbackrest_memory`       | 48Mi        |          | The default amount of memory to request for a pgBackRest repository                   |
+| `default_pgbouncer_memory`        | 24Mi        |          | The default amount of memory to request for a pgBouncer instance                      |
 | `delete_metrics_namespace`        | false       |          | Set to configure whether or not the metrics namespace (defined using variable `metrics_namespace`) is deleted when uninstalling the metrics infrastructure                     |
 | `delete_operator_namespace`       | false       |          | Set to configure whether or not the PGO operator namespace (defined using variable `pgo_operator_namespace`) is deleted when uninstalling the PGO.                             |
 | `delete_watched_namespaces`       | false       |          | Set to configure whether or not the PGO watched namespaces (defined using variable `namespace`) are deleted when uninstalling the PGO.                                         |
@@ -224,6 +227,7 @@ sets of variables cannot be used at the same time.
 | `replica_storage`                 | storageos   | **Required** | Set to configure which storage definition to use when creating volumes used by PostgreSQL replicas on all newly created clusters.                                                |
 | `scheduler_timeout`               | 3600        | **Required** | Set to a value in seconds to configure the `pgo-scheduler` timeout threshold when waiting for schedules to complete.                                                             |
 | `service_type`                    | ClusterIP   |          | Set to configure the type of Kubernetes service provisioned on all newly created clusters.                                                                                       |
+| `sync_replication`                | false       |          | If set to true, defaults the PostgreSQL clusters to be deployed with synchronous replication |
 | `pgo_cluster_admin`               | false       |          | Determines whether or not the `cluster-admin` role is assigned to the PGO service account. Must be `true` to enable PGO namespace & role creation when installing in OpenShift.  |
 
 {{% notice tip %}}

installers/ansible/inventory

@@ -232,6 +232,25 @@ db_port=5432
 db_replicas=0
 db_user='testuser'
 
+# ==================
+# Default Container Resource Configurations
+# ==================
+# Define the default container resource configurations that differ from the
+# PostgreSQL Operator defaults. As a convenience, the current PostgreSQL
+# Operator defaults are listed with each variable
+#
+# "default_instance_memory" represents the memory request for a PostgreSQL
+# instance
+# default_instance_memory='512Mi'
+#
+# "default_pgbackrest_repo_memory" represents the memory request for a
+# pgBackRest repository
+# default_pgbackrest_memory='48Mi'
+#
+# "default_pgbouncer_memory" represents the memory request for a pgBouncer
+# instance
+# default_pgbouncer_memory='24Mi'
+
 # ==================
 # Storage Settings
 # ==================

installers/ansible/roles/pgo-operator/defaults/main.yml

@@ -17,6 +17,10 @@ crunchy_debug: "false"
 enable_crunchyadm: "false"
 disable_replica_start_fail_reinit: "false"
 
+default_instance_memory: ""
+default_pgbackrest_memory: ""
+default_pgbouncer_memory: ""
+
 pgo_client_install: "true"
 pgo_client_container_install: "false"
 pgo_cluster_admin: "false"