PM-1506 WIP

.pre-commit-config.yaml

@@ -0,0 +1,14 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+  - repo: https://github.com/norwoodj/helm-docs
+    rev: v1.13.1
+    hooks:
+      - id: helm-docs-container
+        args:
+          # Make the tool search for charts only under the `example-charts` directory
+          - --chart-search-root=gpt-survey-summarizer
+
+          # The `./` makes it relative to the chart-search-root set above
+          - --template-files=README.md.gotmpl
+

README.md.gotmpl

@@ -0,0 +1,51 @@
+{{ template "chart.header" . }}
+{{ template "chart.deprecationWarning" . }}
+
+{{ template "chart.badgesSection" . }}
+
+{{ template "chart.description" . }}
+
+{{ template "chart.homepageLine" . }}
+
+{{ template "chart.maintainersSection" . }}
+
+{{ template "chart.sourcesSection" . }}
+
+{{ template "chart.requirementsSection" . }}
+
+## Prerequisites
+
+Before using this Helm chart, you should have the following prerequisites:
+
+- Access to Kubernetes cluster (If needed contact your friendly neighbourhood DevOps engineer)
+- Helm >= v3.14.3
+- (**Optional**) helmfile >= v0.162.0 to install this chart
+
+## Installation
+
+> Note: **examples** can be found in the repository
+
+To install this Helm chart, the easiest is to create a helmfile.yaml with needed values and run:
+
+```
+helmfile template
+helmfile apply
+```
+
+Or use helmfile only to generate resources and apply them with kubectl like so:
+
+```
+helmfile template | kubectl -f -
+```
+
+Verify that the chart is deployed successfully:
+
+> Note: `kubectl` is a better suited tool for this
+
+```
+helmfile status
+```
+
+{{ template "chart.valuesSection" . }}
+
+{{ template "helm-docs.versionFooter" . }}

gpt-survey-summarizer/README.md

@@ -34,7 +34,7 @@ A helm chart for the gptSuverySummarizer
 | config.discord.guildId | string | `""` | Discord Guild/Server ID |
 | config.discord.token | string | `""` | Discord API Token |
 | config.openAiApiKey | string | `""` | Openai API Key |
-| config.summarizeFrequencySeconds | int | `3600` | Summarize Frequency Seconds |
+| config.summarizeFrequencySeconds | int | `3600` | Summarize Frequency Seconds test |
 | fullnameOverride | string | `""` | The full release name override |
 | image.pullPolicy | string | `"IfNotPresent"` | The pullPolicy used when pulling the image |
 | image.repository | string | `"673156464838.dkr.ecr.us-west-2.amazonaws.com/gpt-survey-summarizer"` | The repository of the image |

gpt-survey-summarizer/values.yaml

@@ -3,7 +3,7 @@
 # Declare variables to be passed into your templates.
 
 config:
-  # -- Summarize Frequency Seconds
+  # -- Summarize Frequency Seconds test
   summarizeFrequencySeconds: 3600
   # -- Openai API Key
   openAiApiKey: ""