🔧(helm) add option to configure deployment annotations

We need to be abble to add specific annotations on Deployment in order to use a reloader when external-secret sync new secrets
suitenumerique · Jan 9, 2025 · f12c06e · f12c06e
1 parent bbb176e
commit f12c06e
Show file tree

Hide file tree

Showing 8 changed files with 260 additions and 126 deletions.
diff --git a/src/helm/helmfile.yaml b/src/helm/helmfile.yaml
@@ -77,7 +77,7 @@ releases:
     installed: {{ eq .Environment.Name "dev" | toYaml }}
     namespace: {{ .Namespace }}
     chart: bitnami/redis
-    version: 18.19.2
+    version: 20.6.2
     values:
       - auth:
           password: pass

diff --git a/src/helm/impress/Chart.yaml b/src/helm/impress/Chart.yaml
@@ -1,5 +1,5 @@
 apiVersion: v2
 type: application
 name: docs
-version: 0.0.1
+version: 0.0.2
 appVersion: latest
diff --git a/src/helm/impress/README.md b/src/helm/impress/README.md
diff --git a/src/helm/impress/generate-readme.sh b/src/helm/impress/generate-readme.sh
@@ -2,9 +2,9 @@
 
 docker image ls | grep readme-generator-for-helm
 if [ "$?" -ne "0" ]; then
-	git clone https://github.com/bitnami/readme-generator-for-helm.git /tmp/readme-generator-for-helm
-	cd /tmp/readme-generator-for-helm
-	docker build -t readme-generator-for-helm:latest .
-	cd $(dirname -- "${BASH_SOURCE[0]}")
+  git clone https://github.com/bitnami/readme-generator-for-helm.git /tmp/readme-generator-for-helm
+  cd /tmp/readme-generator-for-helm
+  docker build -t readme-generator-for-helm:latest .
+  cd $(dirname -- "${BASH_SOURCE[0]}")
 fi
-docker run --rm -it -v ./values.yaml:/app/values.yaml -v ./README.md:/app/README.md readme-generator-for-helm:latest readme-generator -v values.yaml -r README.md
+docker run --rm -it -v .:/source -w /source readme-generator-for-helm:latest readme-generator -v values.yaml -r README.md
diff --git a/src/helm/impress/templates/backend_deployment.yaml b/src/helm/impress/templates/backend_deployment.yaml
@@ -6,6 +6,10 @@ kind: Deployment
 metadata:
   name: {{ $fullName }}
   namespace: {{ .Release.Namespace | quote }}
+  annotations:
+    {{- with .Values.backend.dpAnnotations }}
+    {{- toYaml . | nindent 4 }}
+    {{- end }}
   labels:
     {{- include "impress.common.labels" (list . $component) | nindent 4 }}
 spec:

diff --git a/src/helm/impress/templates/frontend_deployment.yaml b/src/helm/impress/templates/frontend_deployment.yaml
@@ -6,6 +6,10 @@ kind: Deployment
 metadata:
   name: {{ $fullName }}
   namespace: {{ .Release.Namespace | quote }}
+  annotations:
+    {{- with .Values.backend.dpAnnotations }}
+    {{- toYaml . | nindent 4 }}
+    {{- end }}
   labels:
     {{- include "impress.common.labels" (list . $component) | nindent 4 }}
 spec:

diff --git a/src/helm/impress/templates/yprovider_deployment.yaml b/src/helm/impress/templates/yprovider_deployment.yaml
@@ -6,6 +6,10 @@ kind: Deployment
 metadata:
   name: {{ $fullName }}
   namespace: {{ .Release.Namespace | quote }}
+  annotations:
+    {{- with .Values.backend.dpAnnotations }}
+    {{- toYaml . | nindent 4 }}
+    {{- end }}
   labels:
     {{- include "impress.common.labels" (list . $component) | nindent 4 }}
 spec:

diff --git a/src/helm/impress/values.yaml b/src/helm/impress/values.yaml
@@ -59,7 +59,7 @@ ingressCollaborationWS:
   className: null
   host: impress.example.com
   path: /collaboration/ws/
-  ## @param ingress.hosts Additional host to configure for the Ingress
+  ## @param ingressCollaborationWS.hosts Additional host to configure for the Ingress
   hosts: []
   #  - chart-example.local
   ## @param ingressCollaborationWS.tls.enabled Weather to enable TLS for the Ingress
@@ -75,6 +75,12 @@ ingressCollaborationWS:
   ## @param ingressCollaborationWS.customBackends Add custom backends to ingress
   customBackends: []
 
+  ## @param ingressCollaborationWS.annotations.nginx.ingress.kubernetes.io/auth-response-headers
+  ## @param ingressCollaborationWS.annotations.nginx.ingress.kubernetes.io/auth-url
+  ## @param ingressCollaborationWS.annotations.nginx.ingress.kubernetes.io/enable-websocket
+  ## @param ingressCollaborationWS.annotations.nginx.ingress.kubernetes.io/proxy-read-timeout
+  ## @param ingressCollaborationWS.annotations.nginx.ingress.kubernetes.io/proxy-send-timeout
+  ## @param ingressCollaborationWS.annotations.nginx.ingress.kubernetes.io/upstream-hash-by
   annotations:
     nginx.ingress.kubernetes.io/auth-response-headers: "Authorization, X-Can-Edit, X-User-Id"
     nginx.ingress.kubernetes.io/auth-url: https://impress.example.com/api/v1.0/documents/collaboration-auth/
@@ -92,7 +98,7 @@ ingressCollaborationApi:
   className: null
   host: impress.example.com
   path: /collaboration/api/
-  ## @param ingress.hosts Additional host to configure for the Ingress
+  ## @param ingressCollaborationApi.hosts Additional host to configure for the Ingress
   hosts: []
   #  - chart-example.local
   ## @param ingressCollaborationApi.tls.enabled Weather to enable TLS for the Ingress
@@ -108,6 +114,7 @@ ingressCollaborationApi:
   ## @param ingressCollaborationApi.customBackends Add custom backends to ingress
   customBackends: []
 
+  ## @param ingressCollaborationApi.annotations.nginx.ingress.kubernetes.io/upstream-hash-by
   annotations:
     nginx.ingress.kubernetes.io/upstream-hash-by: $arg_room
 
@@ -156,11 +163,17 @@ ingressMedia:
     secretName: null
     additional: []
 
+  ## @param ingressMedia.annotations.nginx.ingress.kubernetes.io/auth-url
+  ## @param ingressMedia.annotations.nginx.ingress.kubernetes.io/auth-response-headers
+  ## @param ingressMedia.annotations.nginx.ingress.kubernetes.io/upstream-vhost
   annotations:
     nginx.ingress.kubernetes.io/auth-url: https://impress.example.com/api/v1.0/documents/media-auth/
     nginx.ingress.kubernetes.io/auth-response-headers: "Authorization, X-Amz-Date, X-Amz-Content-SHA256"
     nginx.ingress.kubernetes.io/upstream-vhost: minio.impress.svc.cluster.local:9000
 
+## @param serviceMedia.host
+## @param serviceMedia.port
+## @param serviceMedia.annotations
 serviceMedia:
   host: minio.impress.svc.cluster.local
   port: 9000
@@ -205,6 +218,9 @@ backend:
   ## @param backend.podAnnotations Annotations to add to the backend Pod
   podAnnotations: {}
 
+  ## @param backend.dpAnnotations Annotations to add to the backend Deployment
+  dpAnnotations: {}
+
   ## @param backend.service.type backend Service type
   ## @param backend.service.port backend Service listening port
   ## @param backend.service.targetPort backend container listening port
@@ -322,6 +338,9 @@ frontend:
   ## @param frontend.podAnnotations Annotations to add to the frontend Pod
   podAnnotations: {}
 
+  ## @param frontend.dpAnnotations Annotations to add to the frontend Deployment
+  dpAnnotations: {}
+
   ## @param frontend.service.type frontend Service type
   ## @param frontend.service.port frontend Service listening port
   ## @param frontend.service.targetPort frontend container listening port
@@ -413,6 +432,9 @@ yProvider:
   ## @param yProvider.podAnnotations Annotations to add to the yProvider Pod
   podAnnotations: {}
 
+  ## @param yProvider.dpAnnotations Annotations to add to the yProvider Deployment
+  dpAnnotations: {}
+
   ## @param yProvider.service.type yProvider Service type
   ## @param yProvider.service.port yProvider Service listening port
   ## @param yProvider.service.targetPort yProvider container listening port
@@ -423,7 +445,6 @@ yProvider:
     targetPort: 4444
     annotations: {}
 
-  ## @param yProvider.probes Configure probe for yProvider
   ## @extra yProvider.probes.liveness.path Configure path for yProvider HTTP liveness probe
   ## @extra yProvider.probes.liveness.targetPort Configure port for yProvider HTTP liveness probe
   ## @extra yProvider.probes.liveness.initialDelaySeconds Configure initial delay for yProvider liveness probe
@@ -438,6 +459,8 @@ yProvider:
   ## @extra yProvider.probes.readiness.initialDelaySeconds Configure timeout for yProvider readiness probe
   probes:
     liveness:
+      ## @param yProvider.probes.liveness.path
+      ## @param yProvider.probes.liveness.initialDelaySeconds
       path: /ping
       initialDelaySeconds: 10