From 1c3aa4c31a1087b64062f578dc8076f44b15eaf7 Mon Sep 17 00:00:00 2001 From: Stefan Seide Date: Tue, 10 Oct 2023 17:15:52 +0200 Subject: [PATCH] update helm chart documentation Signed-off-by: Stefan Seide --- k8s/helm-chart/redis-commander/README.md | 9 ++++++--- k8s/helm-chart/redis-commander/values.yaml | 15 +++++++++++++++ package-lock.json | 4 ++-- package.json | 2 +- 4 files changed, 24 insertions(+), 6 deletions(-) diff --git a/k8s/helm-chart/redis-commander/README.md b/k8s/helm-chart/redis-commander/README.md index 9b8dbb4b..47940a6e 100644 --- a/k8s/helm-chart/redis-commander/README.md +++ b/k8s/helm-chart/redis-commander/README.md @@ -18,8 +18,9 @@ helm -n myspace install redis-web-ui ./k8s/helm-chart/redis-commander --set redi | Key | Type | Default | Description | |-----|------|---------|-------------| -| affinity | object | `{}` | | +| affinity | object | `{}` | optional set pod affinity definitions for kubernetes | | autoscaling | object | `{"enabled":false,"maxReplicas":1,"minReplicas":1,"targetCPUUtilizationPercentage":80}` | Autoscaling configuration for k8s deployment | +| connections | object | `{}` | optional object to set the "local_production_json" property to let Helm render a "local-production.json" file from a configmap to preconfigure more complex configuration examples with connection data too without the need to set all parameter via environment variables (where available). For a working example see file "example-manifest.yaml" | | env | list | `[]` | Extra env vars for the main pod redis-commander in array structure ([{name: ... , value: ...}, {name: ... , value: ...}]). | | fullnameOverride | string | `""` | | | httpAuth.password | string | `""` | Specify http basic password for the web ui | @@ -40,7 +41,7 @@ helm -n myspace install redis-web-ui ./k8s/helm-chart/redis-commander --set redi | ingress.tls | list | `[]` | | | kubeVersion | string | `""` | Optional override Kubernetes version | | nameOverride | string | `""` | | -| nodeSelector | object | `{}` | | +| nodeSelector | object | `{}` | optional set pod node selector definitions for kubernetes | | podAnnotations | object | `{}` | | | podSecurityContext | object | `{}` | | | redis.host | string | `"redis-master"` | Specifies a single Redis host | @@ -56,7 +57,9 @@ helm -n myspace install redis-web-ui ./k8s/helm-chart/redis-commander --set redi | serviceAccount.annotations | object | `{}` | Annotations to add to the service account | | serviceAccount.create | bool | `false` | Specifies whether a service account should be created When no service account is created the account credentials of the default account are also not automatically mounted into the pod (automountServiceAccountToken: false), tokens only mounted when service account is used but Redis-Commander itself does not use the k8s api server token | | serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | -| tolerations | list | `[]` | | +| tolerations | list | `[]` | optional set pod toleration definitions for kubernetes | +| volumeMounts | list | `[]` | optional list of volumes to mount into the docker deployment. This can either be a local storage volume or a configmap to mount data as file. Each list item needs a "name" and a "mountPath". Setting this will most time also require setting a "volumes" entry. For a working example see file "example-manifest.yaml" | +| volumes | list | `[]` | optional list of volumes to mount into the docker deployment. This can either be a loca storage volume or a configmap to mount data as file. Each list item needs a "name" and a "mountPath". Setting this will most time also require setting a "volumeMounts" entry. For a working example see file "example-manifest.yaml" | ## Example diff --git a/k8s/helm-chart/redis-commander/values.yaml b/k8s/helm-chart/redis-commander/values.yaml index 6084d37b..2038583f 100644 --- a/k8s/helm-chart/redis-commander/values.yaml +++ b/k8s/helm-chart/redis-commander/values.yaml @@ -143,14 +143,29 @@ autoscaling: targetCPUUtilizationPercentage: 80 # targetMemoryUtilizationPercentage: 80 +# -- optional set pod node selector definitions for kubernetes nodeSelector: {} +# -- optional set pod toleration definitions for kubernetes tolerations: [] +# -- optional set pod affinity definitions for kubernetes affinity: {} +# -- optional object to set the "local_production_json" property to let Helm render a "local-production.json" +# file from a configmap to preconfigure more complex configuration examples with connection data too +# without the need to set all parameter via environment variables (where available). +# For a working example see file "example-manifest.yaml" connections: {} +# -- optional list of volumes to mount into the docker deployment. This can either be a local storage volume +# or a configmap to mount data as file. Each list item needs a "name" and a "mountPath". Setting this will most time +# also require setting a "volumes" entry. +# For a working example see file "example-manifest.yaml" volumeMounts: [] +# -- optional list of volumes to mount into the docker deployment. This can either be a loca storage volume +# or a configmap to mount data as file. Each list item needs a "name" and a "mountPath". Setting this will most time +# also require setting a "volumeMounts" entry. +# For a working example see file "example-manifest.yaml" volumes: [] diff --git a/package-lock.json b/package-lock.json index fff3c342..fefd5237 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "redis-commander", - "version": "0.9.0-rc2", + "version": "0.9.0-rc3", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "redis-commander", - "version": "0.9.0-rc2", + "version": "0.9.0-rc3", "hasInstallScript": true, "license": "MIT", "dependencies": { diff --git a/package.json b/package.json index f8808a84..57611b8f 100644 --- a/package.json +++ b/package.json @@ -8,7 +8,7 @@ "Stefan Seide