[POSTGRES][COMMON] Add support for postgres operator 79/136179/11
authorrajesh.kumar <rk00747546@techmahindra.com>
Tue, 17 Oct 2023 09:59:20 +0000 (15:29 +0530)
committerAndreas Geissler <andreas-geissler@telekom.de>
Mon, 19 Feb 2024 10:11:21 +0000 (11:11 +0100)
Add template for the postgres operator instance setup and
modifications to use the postgres instance via Operator
TBD: Update of documentation and fix for clients (DMaaP, CPS)

Issue-ID: OOM-3247

Change-Id: I56c34400dc73c71b936a51260efd231017adaeae
Signed-off-by: rajesh.kumar <rk00747546@techmahindra.com>
21 files changed:
docs/sections/guides/infra_guides/oom_infra_optional_addons.rst
kubernetes/common/common/templates/_postgres.tpl
kubernetes/common/postgres-init/Chart.yaml
kubernetes/common/postgres-init/templates/job.yaml
kubernetes/common/postgres-init/values.yaml
kubernetes/common/postgres/Chart.yaml
kubernetes/common/postgres/templates/configmap.yaml
kubernetes/common/postgres/templates/deployment-primary.yaml
kubernetes/common/postgres/templates/deployment-replica.yaml
kubernetes/common/postgres/templates/metrics-svc-primary.yaml
kubernetes/common/postgres/templates/metrics-svc-replica.yaml
kubernetes/common/postgres/templates/postgres.yaml [new file with mode: 0644]
kubernetes/common/postgres/templates/pv-primary.yaml
kubernetes/common/postgres/templates/pv-replica.yaml
kubernetes/common/postgres/templates/pvc-primary.yaml
kubernetes/common/postgres/templates/pvc-replica.yaml
kubernetes/common/postgres/templates/service-common.yaml
kubernetes/common/postgres/templates/service-primary.yaml
kubernetes/common/postgres/templates/service-replica.yaml
kubernetes/common/postgres/templates/servicemonitor.yaml
kubernetes/common/postgres/values.yaml

index de26d11..fb164bc 100644 (file)
@@ -11,6 +11,7 @@
 .. _Kserve setup guide: https://kserve.github.io/website/0.10/admin/kubernetes_deployment/
 .. _K8ssandra setup guide: https://docs.k8ssandra.io/install/
 .. _Mariadb-Operator setup guide: https://github.com/mariadb-operator/mariadb-operator
+.. _Postgres-Operator setup guide: https://github.com/CrunchyData/postgres-operator
 
 .. _oom_base_optional_addons:
 
@@ -125,7 +126,7 @@ For setup the K8ssandra operator is used, see `K8ssandra setup guide`_
 Mariadb-Operator Installation
 -----------------------------
 
-Mariadb-Operator is used to ease the installation and lifecycle management
+Mariadb-Operator is used to ease the installation and lifecycle management of
 MariaDB Galera and Replication clusters, including monitoring and backup
 
 For setup the Mariadb-Operator is used, see `Mariadb-Operator setup guide`_
@@ -147,6 +148,13 @@ For setup the Mariadb-Operator is used, see `Mariadb-Operator setup guide`_
       --set metrics.enabled=true --set webhook.certificate.certManager=true
       --version=<recommended-version>
 
+Postgres-Operator Installation
+------------------------------
+
+Postgres-Operator is used to ease the installation and lifecycle management of
+Postgres DB clusters, including monitoring and backup
+
+For setup the Postgres-Operator is used, see `Postgres-Operator setup guide`_
 
 Kserve Installation
 -------------------
index 45d903e..d21d8c7 100644 (file)
 {{- define "common.postgres.secret.primaryPasswordSecretName" -}}
   {{- include "common.postgres.secret._secretName" (set . "uidTemplate" "common.postgres.secret.primaryPasswordUID") }}
 {{- end -}}
+
+{{/*
+  Create postgres cluster via postgres crunchydata-operator
+*/}}
+{{- define "common.postgresOpInstance" -}}
+{{- $dot := default . .dot -}}
+{{- $global := $dot.Values.global -}}
+{{- $dbinst := include "common.name" $dot -}}
+---
+apiVersion: postgres-operator.crunchydata.com/v1beta1
+kind: PostgresCluster
+metadata:
+  name: {{ $dbinst }}
+  labels:
+    app: {{ $dbinst }}
+    version: "5.5"
+spec:
+  metadata:
+    labels:
+      app: {{ $dbinst }}
+      version: "5.5"
+  {{- if .Values.postgresOperator.imagePostgres }}
+  image: {{ .Values.postgresOperator.imagePostgres | quote }}
+  {{- end }}
+  imagePullSecrets:
+    - name: {{ include "common.namespace" . }}-docker-registry-key
+  postgresVersion: {{ $dot.Values.postgresOperator.postgresVersion }}
+  instances:
+    - name: {{ default "instance1" .Values.postgresOperator.instanceName | quote }}
+      replicas: {{ default 2 .Values.postgresOperator.instanceReplicas }}
+      dataVolumeClaimSpec:
+        {{- if .Values.instanceStorageClassName }}
+        storageClassName: {{ .Values.postgresOperator.instanceStorageClassName | quote }}
+        {{- end }}
+        accessModes:
+        - "ReadWriteOnce"
+        resources:
+          requests:
+            storage: {{ default "1Gi" .Values.postgresOperator.instanceSize | quote }}
+      {{- if or .Values.instanceMemory .Values.postgresOperator.instanceCPU }}
+      resources:
+        limits:
+          cpu: {{ default "" .Values.postgresOperator.instanceCPU | quote }}
+          memory: {{ default "" .Values.postgresOperator.instanceMemory | quote }}
+      {{- end }}
+      affinity:
+        podAntiAffinity:
+          preferredDuringSchedulingIgnoredDuringExecution:
+          - weight: 1
+            podAffinityTerm:
+              topologyKey: kubernetes.io/hostname
+              labelSelector:
+                matchLabels:
+                  postgres-operator.crunchydata.com/cluster: {{ $dbinst }}
+                  postgres-operator.crunchydata.com/instance-set: {{ default "instance1" .Values.postgresOperator.instanceName | quote }}
+  proxy:
+    pgBouncer:
+      metadata:
+        labels:
+          app: {{ $dbinst }}
+          version: "5.5"
+      {{- if .Values.postgresOperator.imagePgBouncer }}
+      image: {{ .Values.postgresOperator.imagePgBouncer | quote }}
+      {{- end }}
+      replicas: {{ default 2 .Values.postgresOperator.bouncerReplicas }}
+      affinity:
+        podAntiAffinity:
+          preferredDuringSchedulingIgnoredDuringExecution:
+          - weight: 1
+            podAffinityTerm:
+              topologyKey: kubernetes.io/hostname
+              labelSelector:
+                matchLabels:
+                  postgres-operator.crunchydata.com/cluster: {{ $dbinst }}
+                  postgres-operator.crunchydata.com/role: pgbouncer
+  {{- if .Values.postgresOperator.monitoring }}
+  monitoring:
+    pgmonitor:
+      exporter:
+        image: {{ default "" .Values.postgresOperator.imageExporter | quote }}
+        {{- if .Values.postgresOperator.monitoringConfig }}
+{{ toYaml .Values.monitoringConfig | indent 8 }}
+        {{- end }}
+  {{- end }}
+  users:
+    - name: postgres
+{{- end -}}
index 59008d3..81f566f 100644 (file)
@@ -16,7 +16,7 @@
 apiVersion: v2
 description: Chart for Postgres init job
 name: postgres-init
-version: 13.0.0
+version: 13.0.1
 
 
 dependencies:
@@ -26,6 +26,9 @@ dependencies:
   - name: repositoryGenerator
     version: ~13.x-0
     repository: 'file://../repositoryGenerator'
+  - name: readinessCheck
+    version: ~13.x-0
+    repository: '@local'
   - name: serviceAccount
     version: ~13.x-0
     repository: '@local'
\ No newline at end of file
index 09c21fe..7fa2e9f 100644 (file)
@@ -33,21 +33,7 @@ spec:
         release: {{ include "common.release" . }}
       name: {{ include "common.name" . }}
     spec:
-      initContainers:
-      - name: {{ include "common.name" . }}-readiness
-        command:
-        - /app/ready.py
-        args:
-        - --container-name
-        - {{ .Values.global.postgres.container.name }}
-        env:
-        - name: NAMESPACE
-          valueFrom:
-            fieldRef:
-              apiVersion: v1
-              fieldPath: metadata.namespace
-        image: {{ include "repositoryGenerator.image.readiness" . }}
-        imagePullPolicy: {{ .Values.global.pullPolicy | default .Values.pullPolicy }}
+      initContainers: {{ include "common.readinessCheck.waitFor" . | nindent 6 }}
       containers:
       - command:
         - sh
index 1b9e72b..5a9f445 100644 (file)
@@ -96,6 +96,10 @@ serviceAccount:
   roles:
     - read
 
+readinessCheck:
+  wait_for:
+    - '{{ .Values.global.postgres.container.name }}'
+
 wait_for_job_container:
   containers:
     - '{{ include "common.name" . }}-update-config'
\ No newline at end of file
index e81fc3f..3920d8e 100644 (file)
@@ -17,7 +17,7 @@
 apiVersion: v2
 description: ONAP Postgres Server
 name: postgres
-version: 13.0.0
+version: 13.1.0
 
 dependencies:
   - name: common
index e8bfd11..ff4f976 100644 (file)
@@ -14,6 +14,7 @@
 # limitations under the License.
 */}}
 
+{{- if not .Values.global.postgres.useOperator }}
 apiVersion: v1
 kind: ConfigMap
 metadata:
@@ -26,4 +27,4 @@ metadata:
     heritage: {{ .Release.Service }}
 data:
 {{ tpl (.Files.Glob "configs/*").AsConfig . | indent 2 }}
-
+{{- end }}
index c8a0001..535eefa 100644 (file)
@@ -13,4 +13,6 @@
 # # See the License for the specific language governing permissions and
 # # limitations under the License.
 */}}
+{{- if not .Values.global.postgres.useOperator }}
 {{ include "common.postgres.deployment" (dict "dot" . "pgMode" "primary") }}
+{{- end }}
\ No newline at end of file
index dc19c2d..97c7e11 100644 (file)
@@ -13,4 +13,6 @@
 # # See the License for the specific language governing permissions and
 # # limitations under the License.
 */}}
+{{- if not .Values.global.postgres.useOperator }}
 {{ include "common.postgres.deployment" (dict "dot" . "pgMode" "replica") }}
+{{- end }}
\ No newline at end of file
index 790dd47..00a5182 100644 (file)
@@ -14,6 +14,7 @@
 # limitations under the License.
 */}}
 
+{{- if not .Values.global.postgres.useOperator }}
 {{- if default false .Values.metrics.enabled }}
 apiVersion: v1
 kind: Service
@@ -33,4 +34,5 @@ spec:
   selector:
     name: {{ .Values.container.name.primary }}
     release: {{ include "common.release" . }}
+{{- end }}
 {{- end }}
\ No newline at end of file
index 5aa8d76..b8b9e79 100644 (file)
@@ -14,6 +14,7 @@
 # limitations under the License.
 */}}
 
+{{- if not .Values.global.postgres.useOperator }}
 {{- if default false .Values.metrics.enabled }}
 apiVersion: v1
 kind: Service
@@ -33,4 +34,5 @@ spec:
   selector:
     name: {{ .Values.container.name.replica }}
     release: {{ include "common.release" . }}
+{{- end }}
 {{- end }}
\ No newline at end of file
diff --git a/kubernetes/common/postgres/templates/postgres.yaml b/kubernetes/common/postgres/templates/postgres.yaml
new file mode 100644 (file)
index 0000000..aca6aa2
--- /dev/null
@@ -0,0 +1,19 @@
+{{/*
+# Copyright © 2023 Deutsche Telekom AG
+#
+# 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.
+*/}}
+
+{{- if .Values.global.postgres.useOperator }}
+{{ include "common.postgresOpInstance" . }}
+{{- end }}
\ No newline at end of file
index e1ff1f9..8db79d6 100644 (file)
@@ -13,6 +13,7 @@
 # # See the License for the specific language governing permissions and
 # # limitations under the License.
 */}}
+{{- if not .Values.global.postgres.useOperator }}
 {{- if and .Values.persistence.enabled (not .Values.persistence.existingClaim) -}}
 {{- if include "common.needPV" . -}}
 kind: PersistentVolume
@@ -37,3 +38,4 @@ spec:
     path: {{ .Values.global.persistence.mountPath | default .Values.persistence.mountPath }}/{{ include "common.release" . }}/{{ .Values.persistence.mountSubPath }}/primary
 {{- end -}}
 {{- end -}}
+{{- end }}
\ No newline at end of file
index d553c36..af46f61 100644 (file)
@@ -13,6 +13,7 @@
 # # See the License for the specific language governing permissions and
 # # limitations under the License.
 */}}
+{{- if not .Values.global.postgres.useOperator }}
 {{- if and .Values.persistence.enabled (not .Values.persistence.existingClaim) -}}
 {{- if include "common.needPV" . -}}
 kind: PersistentVolume
@@ -35,5 +36,6 @@ spec:
   persistentVolumeReclaimPolicy: {{ .Values.persistence.volumeReclaimPolicy }}
   hostPath:
     path: {{ .Values.global.persistence.mountPath | default .Values.persistence.mountPath }}/{{ include "common.release" . }}/{{ .Values.persistence.mountSubPath }}/replica
-{{- end -}}
-{{- end -}}
+{{- end }}
+{{- end }}
+{{- end }}
index a47d3ed..6aaa529 100644 (file)
@@ -14,6 +14,7 @@
 # limitations under the License.
 */}}
 
+{{- if not .Values.global.postgres.useOperator }}
 {{- if and .Values.persistence.enabled (not .Values.persistence.existingClaim) -}}
 kind: PersistentVolumeClaim
 apiVersion: v1
@@ -41,4 +42,5 @@ spec:
 {{- else }}
   storageClassName: {{ include "common.storageClass" . }}
 {{- end }}
-{{- end -}}
+{{- end }}
+{{- end }}
index 1e453fb..f59adf7 100644 (file)
@@ -14,6 +14,7 @@
 # limitations under the License.
 */}}
 
+{{- if not .Values.global.postgres.useOperator }}
 {{- if and .Values.persistence.enabled (not .Values.persistence.existingClaim) -}}
 kind: PersistentVolumeClaim
 apiVersion: v1
@@ -41,4 +42,5 @@ spec:
 {{- else }}
   storageClassName: {{ include "common.storageClass" . }}
 {{- end }}
-{{- end -}}
+{{- end }}
+{{- end }}
\ No newline at end of file
index 6e74a06..6ec83dc 100644 (file)
@@ -13,6 +13,7 @@
 # # See the License for the specific language governing permissions and
 # # limitations under the License.
 */}}
+{{- if not .Values.global.postgres.useOperator }}
 apiVersion: v1
 kind: Service
 metadata:
@@ -39,3 +40,4 @@ spec:
   selector:
     app: {{ include "common.name" . }}
     release: {{ include "common.release" . }}
+{{- end }}
index 2965b7d..bc60d27 100644 (file)
@@ -13,6 +13,7 @@
 # # See the License for the specific language governing permissions and
 # # limitations under the License.
 */}}
+{{- if not .Values.global.postgres.useOperator }}
 apiVersion: v1
 kind: Service
 metadata:
@@ -39,3 +40,4 @@ spec:
   selector:
     name: "{{.Values.container.name.primary}}"
     release: {{ include "common.release" . }}
+{{- end }}
index d92a083..6869456 100644 (file)
@@ -13,6 +13,7 @@
 # # See the License for the specific language governing permissions and
 # # limitations under the License.
 */}}
+{{- if not .Values.global.postgres.useOperator }}
 apiVersion: v1
 kind: Service
 metadata:
@@ -39,3 +40,4 @@ spec:
   selector:
     name: "{{.Values.container.name.replica}}"
     release: {{ include "common.release" . }}
+{{- end }}
\ No newline at end of file
index 73faba6..522e515 100644 (file)
@@ -13,7 +13,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 */}}
-
+{{- if not .Values.global.postgres.useOperator }}
 {{- if .Values.metrics.serviceMonitor.enabled }}
 {{  include "common.serviceMonitor" . }}
 {{- end }}
+{{- end }}
\ No newline at end of file
index 51b7759..977e7d5 100644 (file)
@@ -19,6 +19,9 @@
 global:
   nodePortPrefix: 302
   persistence: {}
+  postgres:
+    # flag to enable the DB creation via mariadb-operator
+    useOperator: false
 
 #################################################################
 # Secrets metaconfig
@@ -38,6 +41,27 @@ secrets:
     externalSecret: '{{ tpl (default "" .Values.config.pgPrimaryPasswordExternalSecret) . }}'
     password: '{{ .Values.config.pgPrimaryPassword }}'
 
+#################################################################
+# Postgres Operator configuration defaults.
+# Example: https://github.com/CrunchyData/postgres-operator-examples/tree/main/helm/postgres
+#################################################################
+postgresOperator:
+  postgresVersion: 16
+  # Possibility to override images
+  #imagePostgres:
+  #imagePgBouncer:
+  #imageExporter:
+  #imagePgBackRest:
+  instanceName: instance1
+  instanceReplicas: 2
+  #instanceStorageClassName:
+  instanceSize: 1Gi
+  #instanceCPU:
+  #instanceMemory:
+  bouncerReplicas: 2
+  monitoring: true
+  #monitoringConfig: {}
+
 #################################################################
 # Application configuration defaults.
 #################################################################