feat(plugins): add pluging including backup logic for barman cloud plugin

Signed-off-by: Philipp Hamann <[email protected]>

Author: pha91

charts/cluster/README.md

@@ -173,6 +173,7 @@ refer to  the [CloudNativePG Documentation](https://cloudnative-pg.io/documentat
 | cluster.monitoring.podMonitor.relabelings | list | `[]` | The list of relabelings for the PodMonitor. Applied to samples before scraping. |
 | cluster.monitoring.prometheusRule.enabled | bool | `true` | Whether to enable the PrometheusRule automated alerts |
 | cluster.monitoring.prometheusRule.excludeRules | list | `[]` | Exclude specified rules |
+| cluster.plugins | list | `[]` | The plugins configuration, containing any plugin to be loaded with the corresponding configuration |
 | cluster.postgresGID | int | `-1` | The GID of the postgres user inside the image, defaults to 26 |
 | cluster.postgresUID | int | `-1` | The UID of the postgres user inside the image, defaults to 26 |
 | cluster.postgresql.ldap | object | `{}` | PostgreSQL LDAP configuration (see https://cloudnative-pg.io/documentation/current/postgresql_conf/#ldap-configuration) |

charts/cluster/templates/_backup.tpl

@@ -2,6 +2,7 @@
 {{- if .Values.backups.enabled }}
 backup:
   target: "prefer-standby"
+  {{ if (eq (include "cluster.useBarmanCloudPlugin" .) "false")  }}
   retentionPolicy: {{ .Values.backups.retentionPolicy }}
   barmanObjectStore:
     wal:
@@ -19,5 +20,6 @@ backup:
 
     {{- $d := dict "chartFullname" (include "cluster.fullname" .) "scope" .Values.backups "secretPrefix" "backup" }}
     {{- include "cluster.barmanObjectStoreConfig" $d | nindent 2 }}
+  {{- end}}
 {{- end }}
 {{- end }}

charts/cluster/templates/_helpers.tpl

@@ -144,3 +144,19 @@ Postgres GID
     {{- 26 -}}
   {{- end -}}
 {{- end -}}
+
+
+{{/*
+Check if barman-cloud plugin exists and is enabled
+*/}}
+{{- define "cluster.useBarmanCloudPlugin" -}}
+{{- $hasPlugin := false }}
+{{- if .Values.cluster.plugins }}
+  {{- range .Values.cluster.plugins }}
+    {{- if and (eq .name "barman-cloud.cloudnative-pg.io") .enabled }}
+      {{- $hasPlugin = true }}
+    {{- end }}
+  {{- end }}
+{{- end }}
+{{- $hasPlugin }}
+{{- end }}

charts/cluster/templates/cluster.yaml

@@ -67,6 +67,10 @@ spec:
     name: {{ . }}
   {{ end }}
   enablePDB: {{ .Values.cluster.enablePDB }}
+  {{- with .Values.cluster.plugins }}
+  plugins:
+    {{- toYaml . | nindent 4}}
+  {{- end }}
   postgresql:
     {{- if or (eq .Values.type "timescaledb") (not (empty .Values.cluster.postgresql.shared_preload_libraries)) }}
     shared_preload_libraries:

charts/cluster/templates/objectStore.yaml

@@ -0,0 +1,22 @@
+{{ if and (eq (include "cluster.useBarmanCloudPlugin" .) "true") .Values.backups.enabled }}
+apiVersion: barmancloud.cnpg.io/v1
+kind: ObjectStore
+metadata:
+  name: {{ include "cluster.fullname" $  }}-object-store
+spec:
+  configuration:
+    wal:
+      compression: {{ .Values.backups.wal.compression }}
+      {{- if .Values.backups.wal.encryption }}
+      encryption: {{ .Values.backups.wal.encryption }}
+      {{- end }}
+      maxParallel: {{ .Values.backups.wal.maxParallel }}
+    data:
+      compression: {{ .Values.backups.data.compression }}
+      {{- if .Values.backups.data.encryption }}
+      encryption: {{ .Values.backups.data.encryption }}
+      {{- end }}
+      jobs: {{ .Values.backups.data.jobs }}
+    {{- $d := dict "chartFullname" (include "cluster.fullname" .) "scope" .Values.backups "secretPrefix" "backup" -}}
+    {{- include "cluster.barmanObjectStoreConfig" $d | indent 2 }}
+{{- end }}

charts/cluster/templates/scheduled-backups.yaml

@@ -11,9 +11,15 @@ metadata:
 spec:
   immediate: true
   schedule: {{ .schedule | quote }}
-  method: {{ .method }}
   backupOwnerReference: {{ .backupOwnerReference }}
   cluster:
     name: {{ include "cluster.fullname" $context }}
+{{- if (eq (include "cluster.useBarmanCloudPlugin" $context ) "true") }}
+  pluginConfiguration:
+    name: barman-cloud.cloudnative-pg.io
+  method: plugin
+{{ else }}
+  method: {{ .method }}
+{{- end }}
 {{ end -}}
 {{ end }}

charts/cluster/test/postgresql-cluster-configuration/01-non_default_configuration_cluster-assert.yaml

@@ -101,7 +101,13 @@ spec:
       memory: 256Mi
     limits:
       cpu: 100m
-      memory: 256Mi
+      memory: 256Mi  
+  plugins:
+    - name: cnpg-i-plugin-example.my-org.io
+      enabled: true
+      parameters:
+        key1: value1
+        key2: value2
   priorityClassName: mega-high
   primaryUpdateStrategy: supervised
   primaryUpdateMethod: restart

charts/cluster/test/postgresql-cluster-configuration/01-non_default_configuration_cluster.yaml

@@ -87,6 +87,12 @@ cluster:
        inRoles:
          - pg_monitor
          - pg_signal_backend
+  plugins:
+    - name: cnpg-i-plugin-example.my-org.io
+      enabled: true
+      parameters:
+        key1: value1
+        key2: value2
   postgresql:
     ldap:
       server: 'openldap.default.svc.cluster.local'

charts/cluster/values.schema.json

@@ -262,6 +262,27 @@
                         }
                     }
                 },
+                "plugins": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "properties": {
+                            "name": {
+                                "type": "string"
+                            },
+                            "enabled": {
+                                "type": "boolean"
+                            },
+                            "isWALArchiver": {
+                                "type": "boolean"
+                            },
+                            "parameters": {
+                                "type": "object"
+                            }
+                        },
+                        "required": ["name"]
+                    }
+                },
                 "postgresGID": {
                     "type": "integer"
                 },

charts/cluster/values.yaml

@@ -343,6 +343,13 @@ cluster:
     #  - name: custom-queries-secret
     #    key: custom-queries
 
+  plugins: []
+    # - name: cnpg-i-plugin-example.my-org.io
+    #   enabled: true
+    #   parameters:
+    #     key1: value1
+    #     key2: value2
+
   postgresql:
     # -- PostgreSQL configuration options (postgresql.conf)
     parameters: {}