feat: Helm-Chart Support External Secret Operator (#242)

* feat: Helm-Chart Support External Secret Operator / feat: support for reload when secret changed

* Update charts/ext-postgres-operator/values.yaml

Co-authored-by: Pieter C <pieter@buca.be>

* fix: values.yaml after code-review

* fix: values.yaml after code-review :02

* fix: values.yaml after code-review :03

* fix: .Values.externalSecret

---------

Co-authored-by: Pieter C <pieter@buca.be>

Author: tkcontiant

charts/ext-postgres-operator/Chart.yaml

@@ -8,5 +8,5 @@ description: |
 
 type: application
 
-version: 2.1.0
+version: 2.2.0
 appVersion: "2.0.0"

charts/ext-postgres-operator/templates/external-secret.yaml

@@ -0,0 +1,35 @@
+{{- if and (.Capabilities.APIVersions.Has "external-secrets.io/v1beta1") (.Values.externalSecret) }}
+apiVersion: external-secrets.io/v1beta1
+kind: ExternalSecret
+metadata:
+  name: {{ include "chart.fullname" . }}-external-secret
+  namespace: {{ if .Values.externalSecret.namespace }}{{ .Values.externalSecret.namespace }}{{ else }}{{ .Release.Namespace }}{{ end }}
+  labels:
+    {{- include "chart.labels" . | nindent 4 }}
+spec:
+  refreshInterval: {{ .Values.externalSecret.refreshInterval | default "2s"}}
+  secretStoreRef:
+    kind: {{ .Values.externalSecret.secretStoreKind | default "SecretStore" }}
+    name: {{ .Values.externalSecret.secretStore | quote }}
+  target:
+    creationPolicy: Owner
+    deletionPolicy: Retain
+    name: {{ include "chart.fullname" . }}
+    template:
+      data:
+        POSTGRES_HOST: {{ .Values.postgres.host | quote }}
+        POSTGRES_USER: "{{ `{{ .username }}` }}"
+        POSTGRES_PASS: "{{ `{{ .password }}` }}"
+        POSTGRES_URI_ARGS: {{ .Values.postgres.uri_args | quote }}
+        POSTGRES_CLOUD_PROVIDER: {{ .Values.postgres.cloud_provider | quote }}
+        POSTGRES_DEFAULT_DATABASE: {{ .Values.postgres.default_database | quote }}
+  data:
+    - secretKey: username
+      remoteRef:
+        key: {{ .Values.externalSecret.remoteKey | quote }}
+        property: username
+    - secretKey: password
+      remoteRef:
+        key: {{ .Values.externalSecret.remoteKey | quote }}
+        property: password
+{{- end }}

charts/ext-postgres-operator/templates/operator.yaml

@@ -5,8 +5,14 @@ metadata:
   labels:
     {{- include "chart.labels" . | nindent 4 }}
   namespace: {{ .Release.Namespace }}
-  {{- with .Values.deploymentAnnotations }}
   annotations:
+    {{- if not .Values.externalSecret }}
+    checksum/secret: {{ include (print $.Template.BasePath "/secret.yaml") . | sha256sum }}
+    {{- end }}
+    {{- if .Values.externalSecret }}
+    checksum/external-secret: {{ include (print $.Template.BasePath "/external-secret.yaml") . | sha256sum }}
+    {{- end }}
+  {{- with .Values.deploymentAnnotations }}
     {{- toYaml . | nindent 4 }}
   {{- end }}
 spec:

charts/ext-postgres-operator/templates/secret.yaml

@@ -1,12 +1,12 @@
-{{- if (not .Values.existingSecret) }}
+{{- if and (not .Values.existingSecret) (not .Values.externalSecret) }}
 ---
 apiVersion: v1
 kind: Secret
 metadata:
   annotations:
     "helm.sh/resource-policy": keep
   name: {{ include "chart.fullname" . }}
-  namespace: {{ .Release.namespace }}
+  namespace: {{ .Release.Namespace }}
   labels:
     {{- include "chart.labels" . | nindent 4 }}
 type: Opaque

charts/ext-postgres-operator/templates/serviceaccount.yaml

@@ -9,4 +9,4 @@ metadata:
     {{- toYaml . | nindent 4 }}
   {{- end }}
   namespace: {{ .Release.Namespace }}
-
+automountServiceAccountToken: {{ .Values.serviceAccount.automount }}

charts/ext-postgres-operator/values.yaml

@@ -27,12 +27,13 @@ serviceAccount:
   # The name of the service account to use.
   # If not set and create is true, a name is generated using the fullname template
   name: ""
+  automount: true
 
 deploymentAnnotations: {}
 
 podAnnotations: {}
 
-# Additionnal labels to add to the pod.
+# Additional labels to add to the pod.
 podLabels: {}
 
 podSecurityContext:
@@ -45,8 +46,7 @@ securityContext:
     drop:
       - "ALL"
 
-resources:
-  {}
+resources: {}
   # We usually recommend not to specify default resources and to leave this as a conscious
   # choice for the user. This also increases chances charts run on environments with little
   # resources, such as Minikube. If you do want to specify resources, uncomment the following
@@ -80,10 +80,10 @@ watchNamespace: ""
 postgres:
   # postgres hostname
   host: "localhost"
-  # postgres admin user and password
+  # postgres admin user and password ( ignored if existingSecret or ExternalSecret is set )
   user: "admin"
   password: "password"
-  # additional connection args to pg driver
+  # additional connection args to pg driver (Example "sslmode=disable")
   uri_args: ""
   # postgres cloud provider, could be AWS, Azure, GCP or empty (default)
   cloud_provider: ""
@@ -98,10 +98,21 @@ volumeMounts: []
 
 # Existing secret where values to connect to Postgres are defined.
 # If not set a new secret will be created, filled with information under the postgres key above.
+# If ExternalSecret is set, existingSecret is ignored.
 existingSecret: ""
 
-# Additionnal environment variables to add to the pod (map of key / value)
+# Support for ExternalSecret Operator to fetch Postgres credentials from an external secret store.
+externalSecret: {}
+  # secretStore: "aws-secretsmanager-euc1"                   # (Mandatory) Name of the SecretStore or ClusterSecretStore to reference in the ExternalSecret
+  # remoteKey: "rds!db-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # (Mandatory) Remote key in the external secret store where Postgres credentials are stored
+  # namespace: ""                                          # (Optional), defaults to release namespace
+  # secretStoreKind: ""                                    # (Optional), defaults to SecretStore / SecretStore or ClusterSecretStore
+  # refreshInterval: "2s"                                  # (Optional), defaults to SecretStore / SecretStore or ClusterSecretStore
+
+# Additional environment variables to add to the pod (map of key / value)
 env: {}
+  # POSTGRES_INSTANCE: "XXXXXXXXXX"
+  # POSTGRES_CLOUD_PROVIDER: "AWS"
 
 nodeSelector: {}