Fix warning & add template for helm docs generation

intuitem · Dec 28, 2024 · 7530583 · 7530583
1 parent e4c98d1
commit 7530583
Show file tree

Hide file tree

Showing 3 changed files with 45 additions and 3 deletions.
diff --git a/charts/ciso-assistant-next/README.md b/charts/ciso-assistant-next/README.md
@@ -16,6 +16,18 @@ A Helm chart for CISO Assistant k8s's deployment
 |------------|------|---------|
 | oci://registry-1.docker.io/bitnamicharts | postgresql | 16.3.4 |
 
+## Installing the chart
+
+To install the chart, firt get the values.yaml file and customize values.
+
+```
+helm show values oci://ghcr.io/intuitem/ciso-assistant > custom.yaml
+```
+To deploy the release :
+```
+helm install ciso-assistant-release oci://ghcr.io/intuitem/ciso-assistant -f custom.yaml
+```
+
 ## Values
 
 | Key | Type | Default | Description |
@@ -106,4 +118,4 @@ A Helm chart for CISO Assistant k8s's deployment
 | postgresql.primary.persistence.size | string | `"5Gi"` | PostgreSQL persistant volume size (default 8Gi). |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)
+Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)
diff --git a/charts/ciso-assistant-next/README.md.gotmpl b/charts/ciso-assistant-next/README.md.gotmpl
@@ -0,0 +1,30 @@
+{{ template "chart.header" . }}
+{{ template "chart.deprecationWarning" . }}
+
+{{ template "chart.badgesSection" . }}
+
+{{ template "chart.description" . }}
+
+{{ template "chart.homepageLine" . }}
+
+{{ template "chart.maintainersSection" . }}
+
+{{ template "chart.sourcesSection" . }}
+
+{{ template "chart.requirementsSection" . }}
+
+## Installing the chart
+
+To install the chart, firt get the values.yaml file and customize values.
+
+```
+helm show values oci://ghcr.io/intuitem/ciso-assistant > custom.yaml
+```
+To deploy the release :
+```
+helm install ciso-assistant-release oci://ghcr.io/intuitem/ciso-assistant -f custom.yaml
+```
+
+{{ template "chart.valuesSection" . }}
+
+{{ template "helm-docs.versionFooter" . }}
diff --git a/charts/ciso-assistant-next/templates/backend/deployment.yaml b/charts/ciso-assistant-next/templates/backend/deployment.yaml
@@ -97,7 +97,7 @@ spec:
           {{- if .Values.backend.config.smtp.primary.password }}
           - name: EMAIL_HOST_PASSWORD
             valueFrom:
-            secretKeyRef:
+              secretKeyRef:
                 name: {{ include "ciso-assistant.fullname" . }}-backend
                 key: email-primary-password
           {{- end }}
@@ -114,7 +114,7 @@ spec:
           {{- if .Values.backend.config.smtp.rescue.password }}
           - name: EMAIL_HOST_PASSWORD_RESCUE
             valueFrom:
-            secretKeyRef:
+              secretKeyRef:
                 name: {{ include "ciso-assistant.fullname" . }}-backend
                 key: email-rescue-password
           {{- end }}