feat(helm): documentation

Signed-off-by: Nicolas Lamirault <[email protected]>
keephq · Dec 11, 2024 · c229e31 · c229e31
1 parent a23df3d
commit c229e31
Showing 1 changed file with 23 additions and 29 deletions.
diff --git a/charts/keep/README.md b/charts/keep/README.md
@@ -1,6 +1,6 @@
 # keep
 
-![Version: 0.1.25](https://img.shields.io/badge/Version-0.1.25-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.27.0](https://img.shields.io/badge/AppVersion-0.27.0-informational?style=flat-square)
+![Version: 0.1.45](https://img.shields.io/badge/Version-0.1.45-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.30.7](https://img.shields.io/badge/AppVersion-0.30.7-informational?style=flat-square)
 
 Keep Helm Chart
 
@@ -40,20 +40,22 @@ Keep Helm Chart
 | backend.enabled | bool | `true` |  |
 | backend.env[0].name | string | `"DATABASE_CONNECTION_STRING"` |  |
 | backend.env[0].value | string | `"mysql+pymysql://root@keep-database:3306/keep"` |  |
-| backend.env[1].name | string | `"SECRET_MANAGER_TYPE"` |  |
-| backend.env[1].value | string | `"k8s"` |  |
-| backend.env[2].name | string | `"PORT"` |  |
-| backend.env[2].value | string | `"8080"` |  |
-| backend.env[3].name | string | `"PUSHER_APP_ID"` |  |
-| backend.env[3].value | int | `1` |  |
-| backend.env[4].name | string | `"PUSHER_APP_KEY"` |  |
-| backend.env[4].value | string | `"keepappkey"` |  |
-| backend.env[5].name | string | `"PUSHER_APP_SECRET"` |  |
-| backend.env[5].value | string | `"keepappsecret"` |  |
-| backend.env[6].name | string | `"PUSHER_HOST"` |  |
-| backend.env[6].value | string | `"keep-websocket"` |  |
-| backend.env[7].name | string | `"PUSHER_PORT"` |  |
-| backend.env[7].value | int | `6001` |  |
+| backend.env[1].name | string | `"DATABASE_NAME"` |  |
+| backend.env[1].value | string | `"keep-database"` |  |
+| backend.env[2].name | string | `"SECRET_MANAGER_TYPE"` |  |
+| backend.env[2].value | string | `"k8s"` |  |
+| backend.env[3].name | string | `"PORT"` |  |
+| backend.env[3].value | string | `"8080"` |  |
+| backend.env[4].name | string | `"PUSHER_APP_ID"` |  |
+| backend.env[4].value | int | `1` |  |
+| backend.env[5].name | string | `"PUSHER_APP_KEY"` |  |
+| backend.env[5].value | string | `"keepappkey"` |  |
+| backend.env[6].name | string | `"PUSHER_APP_SECRET"` |  |
+| backend.env[6].value | string | `"keepappsecret"` |  |
+| backend.env[7].name | string | `"PUSHER_HOST"` |  |
+| backend.env[7].value | string | `"keep-websocket"` |  |
+| backend.env[8].name | string | `"PUSHER_PORT"` |  |
+| backend.env[8].value | int | `6001` |  |
 | backend.extraInitContainers | list | `[]` |  |
 | backend.extraVolumeMounts | list | `[]` |  |
 | backend.extraVolumes | list | `[]` |  |
@@ -81,12 +83,13 @@ Keep Helm Chart
 | backend.service.port | int | `8080` |  |
 | backend.service.type | string | `"ClusterIP"` |  |
 | backend.tolerations | list | `[]` |  |
-| backend.waitForDatabase | bool | `true` |  |
+| backend.waitForDatabase.enabled | bool | `true` |  |
+| backend.waitForDatabase.port | int | `3306` |  |
 | database.affinity | object | `{}` |  |
 | database.autoscaling.enabled | bool | `false` |  |
 | database.enabled | bool | `true` |  |
 | database.env[0].name | string | `"MYSQL_ALLOW_EMPTY_PASSWORD"` |  |
-| database.env[0].value | string | `"yes"` |  |
+| database.env[0].value | bool | `true` |  |
 | database.env[1].name | string | `"MYSQL_DATABASE"` |  |
 | database.env[1].value | string | `"keep"` |  |
 | database.env[2].name | string | `"MYSQL_PASSWORD"` |  |
@@ -109,6 +112,7 @@ Keep Helm Chart
 | database.pv.size | string | `"5Gi"` |  |
 | database.pv.storageClass | string | `""` |  |
 | database.pvc.enabled | bool | `true` |  |
+| database.pvc.retain | bool | `false` |  |
 | database.pvc.size | string | `"5Gi"` |  |
 | database.pvc.storageClass | string | `""` |  |
 | database.replicaCount | int | `1` |  |
@@ -172,22 +176,12 @@ Keep Helm Chart
 | global.ingress.annotations | object | `{}` |  |
 | global.ingress.backendPrefix | string | `"/v2"` |  |
 | global.ingress.className | string | `"nginx"` |  |
+| global.ingress.classType | string | `""` |  |
 | global.ingress.enabled | bool | `true` |  |
 | global.ingress.frontendPrefix | string | `"/"` |  |
 | global.ingress.hosts | list | `[]` |  |
 | global.ingress.tls | list | `[]` |  |
 | global.ingress.websocketPrefix | string | `"/websocket"` |  |
-| ingress-nginx.controller.admissionWebhooks.certManager.enabled | bool | `false` |  |
-| ingress-nginx.controller.admissionWebhooks.failurePolicy | string | `"Ignore"` |  |
-| ingress-nginx.controller.admissionWebhooks.patch.enabled | bool | `true` |  |
-| ingress-nginx.controller.admissionWebhooks.patch.image.pullPolicy | string | `"IfNotPresent"` |  |
-| ingress-nginx.controller.allowSnippetAnnotations | bool | `true` |  |
-| ingress-nginx.controller.service.annotations | object | `{}` |  |
-| ingress-nginx.controller.service.enabled | bool | `true` |  |
-| ingress-nginx.controller.service.ports.http | int | `80` |  |
-| ingress-nginx.controller.service.ports.https | int | `443` |  |
-| ingress-nginx.controller.service.type | string | `"LoadBalancer"` |  |
-| ingress-nginx.enabled | bool | `true` |  |
 | isGKE | bool | `false` |  |
 | nameOverride | string | `""` |  |
 | namespace | string | `"keep"` |  |
@@ -240,4 +234,4 @@ Keep Helm Chart
 | websocket.tolerations | list | `[]` |  |
 
 ----------------------------------------------
-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.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)