add a spot of additional docs for the values.yaml

small-hack · Aug 8, 2023 · 670dc25 · 670dc25
1 parent d635118
commit 670dc25
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 7 deletions.
diff --git a/charts/bitwarden-eso-provider/Chart.yaml b/charts/bitwarden-eso-provider/Chart.yaml
@@ -15,7 +15,7 @@ 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.2.1
+version: 0.2.2
 
 # renovate: image=jessebot/bweso
 appVersion: "v0.1.0"

diff --git a/charts/bitwarden-eso-provider/README.md b/charts/bitwarden-eso-provider/README.md
@@ -1,6 +1,6 @@
 # bitwarden-eso-provider
 
-![Version: 0.2.1](https://img.shields.io/badge/Version-0.2.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v0.1.0](https://img.shields.io/badge/AppVersion-v0.1.0-informational?style=flat-square)
+![Version: 0.2.2](https://img.shields.io/badge/Version-0.2.2-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v0.1.0](https://img.shields.io/badge/AppVersion-v0.1.0-informational?style=flat-square)
 
 Helm chart to use Bitwarden as a Provider for External Secrets Operator
 
@@ -16,9 +16,9 @@ Helm chart to use Bitwarden as a Provider for External Secrets Operator
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|
 | affinity | object | `{}` |  |
-| autoscaling.enabled | bool | `false` |  |
-| autoscaling.maxReplicas | int | `100` |  |
-| autoscaling.minReplicas | int | `1` |  |
+| autoscaling.enabled | bool | `false` | enable pod autoscaling |
+| autoscaling.maxReplicas | int | `100` | max number of pods to spin up |
+| autoscaling.minReplicas | int | `1` | minimum number of pods to keep |
 | autoscaling.targetCPUUtilizationPercentage | int | `80` |  |
 | bitwarden_eso_provider.auth.clientID | string | `""` | bitwarden client ID to use to grabs secrets in the pod, ignored if existingSecret is set |
 | bitwarden_eso_provider.auth.clientSecret | string | `""` | bitwarden client Secret to use to grabs secrets in the pod, ignored if existingSecret is set |
@@ -39,7 +39,7 @@ Helm chart to use Bitwarden as a Provider for External Secrets Operator
 | nodeSelector | object | `{}` |  |
 | podAnnotations | object | `{}` | additional annotations to apply to the bitwarden ESO provider pod |
 | podSecurityContext | object | `{}` |  |
-| replicaCount | int | `1` |  |
+| replicaCount | int | `1` | replicas to deploy of this pod |
 | resources | object | `{}` |  |
 | securityContext | object | `{}` |  |
 | service.port | int | `80` | port to broadcast for k8s service internally on the cluster |

diff --git a/charts/bitwarden-eso-provider/values.yaml b/charts/bitwarden-eso-provider/values.yaml
@@ -2,7 +2,7 @@
 # This is a YAML-formatted file.
 # Declare variables to be passed into your templates.
 
-# replicas to deploy of this pod
+# -- replicas to deploy of this pod
 replicaCount: 1
 
 image:
@@ -85,8 +85,11 @@ resources: {}
   #   memory: 128Mi
 
 autoscaling:
+  # -- enable pod autoscaling
   enabled: false
+  # -- minimum number of pods to keep
   minReplicas: 1
+  # -- max number of pods to spin up
   maxReplicas: 100
   targetCPUUtilizationPercentage: 80
   # targetMemoryUtilizationPercentage: 80