From f5c8e537c95c6efbf9df0300f74c03746b9095d8 Mon Sep 17 00:00:00 2001 From: Maidul Islam Date: Thu, 12 Oct 2023 11:01:21 +0100 Subject: [PATCH] generate documentation --- helm-charts/infisical/README.md | 21 ++++++++++++--------- helm-charts/infisical/values.yaml | 2 +- 2 files changed, 13 insertions(+), 10 deletions(-) diff --git a/helm-charts/infisical/README.md b/helm-charts/infisical/README.md index 427acd98c..4aca077a9 100644 --- a/helm-charts/infisical/README.md +++ b/helm-charts/infisical/README.md @@ -64,16 +64,17 @@ kubectl get secrets -n \ | Name | Description | Value | | --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------- | | `frontend.enabled` | Enable frontend | `true` | -| `frontend.name` | Backend name | `frontend` | -| `frontend.fullnameOverride` | Backend fullnameOverride | `""` | -| `frontend.podAnnotations` | Backend pod annotations | `{}` | -| `frontend.deploymentAnnotations` | Backend deployment annotations | `{}` | -| `frontend.replicaCount` | Backend replica count | `2` | -| `frontend.image.repository` | Backend image repository | `infisical/frontend` | -| `frontend.image.tag` | Backend image tag | `latest` | -| `frontend.image.pullPolicy` | Backend image pullPolicy | `IfNotPresent` | +| `frontend.name` | Frontend name | `frontend` | +| `frontend.fullnameOverride` | Frontend fullnameOverride | `""` | +| `frontend.podAnnotations` | Frontend pod annotations | `{}` | +| `frontend.deploymentAnnotations` | Frontend deployment annotations | `{}` | +| `frontend.replicaCount` | Frontend replica count | `2` | +| `frontend.image.repository` | Frontend image repository | `infisical/frontend` | +| `frontend.image.tag` | Frontend image tag | `latest` | +| `frontend.image.pullPolicy` | Frontend image pullPolicy | `IfNotPresent` | | `frontend.resources.limits.memory` | container memory limit [check the offical kubernetes documentations](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) | `100Mi` | -| `frontend.resources.requests.cpu` | container CPU request [check the offical kubernetes documentations](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) | `10m` | +| `frontend.resources.requests.cpu` | container CPU request [check the offical kubernetes documentations](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) | `100m` | +| `frontend.affinity` | Frontend pod affinity | `{}` | | `frontend.kubeSecretRef` | Backend secret resource reference name (containing required [frontend configuration variables](https://infisical.com/docs/self-hosting/configuration/envars)) | `""` | | `frontend.service.annotations` | Backend service annotations | `{}` | | `frontend.service.type` | Backend service type | `ClusterIP` | @@ -95,6 +96,7 @@ kubectl get secrets -n \ | `backend.image.pullPolicy` | Backend image pullPolicy | `IfNotPresent` | | `backend.resources.limits.memory` | container memory limit [check the offical kubernetes documentations](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) | `200Mi` | | `backend.resources.requests.cpu` | container CPU request [check the offical kubernetes documentations](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) | `150m` | +| `backend.affinity` | Backend pod affinity | `{}` | | `backend.kubeSecretRef` | Backend secret resource reference name (containing required [backend configuration variables](https://infisical.com/docs/self-hosting/configuration/envars)) | `""` | | `backend.service.annotations` | Backend service annotations | `{}` | | `backend.service.type` | Backend service type | `ClusterIP` | @@ -194,6 +196,7 @@ kubectl get secrets -n \ + ## Persistence The database persistence is enabled by default, your volumes will remain on your cluster even after uninstalling the chart. To disable persistence, set this value `mongodb.persistence.enabled: false` diff --git a/helm-charts/infisical/values.yaml b/helm-charts/infisical/values.yaml index 75f57e7bd..12706c56b 100644 --- a/helm-charts/infisical/values.yaml +++ b/helm-charts/infisical/values.yaml @@ -292,7 +292,7 @@ mongodb: ## rootPassword: root - ## @param auth.existingSecret Existing secret with MongoDB(®) credentials (keys: `mongodb-passwords`, `mongodb-root-password`, `mongodb-metrics-password`, `mongodb-replica-set-key`) + ## @param mongodb.auth.existingSecret Existing secret with MongoDB(®) credentials (keys: `mongodb-passwords`, `mongodb-root-password`, `mongodb-metrics-password`, `mongodb-replica-set-key`) ## NOTE: When it's set the previous parameters are ignored. ## existingSecret: ""