Add helm documentation (#104)

* add helm documentation * add helm documentation * add helm documentation * add helm documentation --------- Co-authored-by: Yonah Dissen <[email protected]>
yonahd · Oct 15, 2023 · 0210609 · 0210609
1 parent 2ef9cca
commit 0210609
Show file tree

Hide file tree

Showing 3 changed files with 60 additions and 25 deletions.
diff --git a/README.md b/README.md
@@ -46,14 +46,24 @@ docker run --rm -i -v "/path/to/.kube/config:/root/.kube/config" yonahdissen/kor
 ```
 
 ### Helm
-Run as a cronjob in your Cluster
+Run as a cronjob in your Cluster (with an option for sending slack updates)
 ```sh
 helm upgrade -i kor \
     --namespace kor \
     --create-namespace \
+    --set cronJob.enabled=true
     ./charts/kor
 ```
 
+Run as a deployment in your Cluster exposing prometheus metrics
+```sh
+helm upgrade -i kor \
+    --namespace kor \
+    --create-namespace \
+    ./charts/kor
+```
+
+
 For more information see [in cluster usage](#in-cluster-usage) 
 
 ## Usage

diff --git a/charts/kor/Chart.yaml b/charts/kor/Chart.yaml
@@ -15,10 +15,10 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 0.1.0
+version: 0.1.1
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to
 # follow Semantic Versioning. They should reflect the version the application is using.
 # It is recommended to use it with quotes.
-appVersion: "0.2.2"
+appVersion: "0.2.4"
diff --git a/charts/kor/README.md b/charts/kor/README.md
@@ -1,30 +1,55 @@
 # kor
 
-![Version: 0.1.0](https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.2.2](https://img.shields.io/badge/AppVersion-0.2.2-informational?style=flat-square)
+![Version: 0.1.1](https://img.shields.io/badge/Version-0.1.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.2.4](https://img.shields.io/badge/AppVersion-0.2.4-informational?style=flat-square)
 
-A Helm chart to deploy Kor as into a Kubernetes cluster.
+A Helm chart for Kubernetes
 
 ## Values
 
-| Key                                | Type   | Default             | Description |
-| ---------------------------------- | ------ | ------------------- | ----------- |
-| cronJob.enabled                    | bool   | `true`              |             |
-| cronJob.failedJobsHistoryLimit     | int    | `2`                 |             |
-| cronJob.image.repository           | string | `"yonahdissen/kor"` |             |
-| cronJob.image.tag                  | string | `"latest"`          |             |
-| cronJob.command                    | string | `"kor all"`         |             |
-| cronJob.name                       | string | `"kor"`             |             |
-| cronJob.restartPolicy              | string | `"OnFailure"`       |             |
-| cronJob.schedule                   | string | `"0 1 * * 1"`       |             |
-| cronJob.slackAuthToken             | string | `""`                |             |
-| cronJob.slackChannel               | string | `""`                |             |
-| cronJob.slackWebhookUrl            | string | `""`                |             |
-| cronJob.successfulJobsHistoryLimit | int    | `3`                 |             |
-| namespace                          | string | `"kor"`             |             |
-| serviceAccount.annotations         | object | `{}`                |             |
-| serviceAccount.create              | bool   | `true`              |             |
-| serviceAccount.name                | string | `""`                |             |
-
----
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| cronJob.command | string | `"kor all"` |  |
+| cronJob.enabled | bool | `false` |  |
+| cronJob.failedJobsHistoryLimit | int | `2` |  |
+| cronJob.image.repository | string | `"yonahdissen/kor"` |  |
+| cronJob.image.tag | string | `"latest"` |  |
+| cronJob.name | string | `"kor"` |  |
+| cronJob.restartPolicy | string | `"OnFailure"` |  |
+| cronJob.schedule | string | `"0 1 * * 1"` |  |
+| cronJob.slackAuthToken | string | `""` |  |
+| cronJob.slackChannel | string | `""` |  |
+| cronJob.slackWebhookUrl | string | `""` |  |
+| cronJob.successfulJobsHistoryLimit | int | `3` |  |
+| prometheusExporter.deployment.affinity | object | `{}` |  |
+| prometheusExporter.deployment.command | string | `"kor exporter"` |  |
+| prometheusExporter.deployment.image.repository | string | `"yonahdissen/kor"` |  |
+| prometheusExporter.deployment.image.tag | string | `"latest"` |  |
+| prometheusExporter.deployment.imagePullPolicy | string | `"Always"` |  |
+| prometheusExporter.deployment.imagePullSecrets | list | `[]` |  |
+| prometheusExporter.deployment.nodeSelector | object | `{}` |  |
+| prometheusExporter.deployment.podSecurityContext | object | `{}` |  |
+| prometheusExporter.deployment.replicaCount | int | `1` |  |
+| prometheusExporter.deployment.resources | object | `{}` |  |
+| prometheusExporter.deployment.restartPolicy | string | `"Always"` |  |
+| prometheusExporter.deployment.securityContext | object | `{}` |  |
+| prometheusExporter.deployment.tolerations | list | `[]` |  |
+| prometheusExporter.enabled | bool | `true` |  |
+| prometheusExporter.exporterInterval | string | `""` |  |
+| prometheusExporter.name | string | `"kor-exporter"` |  |
+| prometheusExporter.service.port | int | `8080` |  |
+| prometheusExporter.service.type | string | `"ClusterIP"` |  |
+| prometheusExporter.serviceMonitor.enabled | bool | `true` |  |
+| prometheusExporter.serviceMonitor.interval | string | `"30s"` |  |
+| prometheusExporter.serviceMonitor.labels | object | `{}` |  |
+| prometheusExporter.serviceMonitor.metricRelabelings | list | `[]` |  |
+| prometheusExporter.serviceMonitor.namespace | string | `""` |  |
+| prometheusExporter.serviceMonitor.relabelings | list | `[]` |  |
+| prometheusExporter.serviceMonitor.targetLabels | list | `[]` |  |
+| prometheusExporter.serviceMonitor.telemetryPath | string | `"/metrics"` |  |
+| prometheusExporter.serviceMonitor.timeout | string | `"10s"` |  |
+| serviceAccount.annotations | object | `{}` |  |
+| serviceAccount.create | bool | `true` |  |
+| serviceAccount.name | string | `""` |  |
 
+----------------------------------------------
 Autogenerated from chart metadata using [helm-docs v1.8.1](https://github.com/norwoodj/helm-docs/releases/v1.8.1)