# redis-commander

A Helm chart for redis-commander

![Version: 0.6.0](https://img.shields.io/badge/Version-0.6.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: latest](https://img.shields.io/badge/AppVersion-latest-informational?style=flat-square)

## Install

Install using this repo after local git checkout itself with setting redis server host value
to `redis`

```sh
cd <git-repo>
helm -n myspace install redis-web-ui ./k8s/helm-chart/redis-commander --set redis.host=redis
```

## Values

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| affinity | object | `{}` | optional set pod affinity definitions for kubernetes |
| autoscaling | object | `{"enabled":false,"maxReplicas":1,"minReplicas":1,"targetCPUUtilizationPercentage":80}` | Autoscaling configuration for k8s deployment |
| configMapData | object | `{}` | optional data to add to the configmap generated by this helm chart.  This might be useful if extra files shall be created inside the docker container which can be mounted  defining the "volumeMounts" and "volumes" below. |
| 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 either file "example-values-as-json.yaml" where the file content is written as json  formatted string or file "example-values-as-yml.yaml" with all config values for the file are defined as 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 |
| httpAuth.username | string | `""` | Specify http basic username and password to protect access to redis commander web ui |
| image.apparmorProfile | string | `"runtime/default"` | Enable AppArmor per default when available on k8s host, change to "unconfined" to disable. Either AppArmor or SecComp may be enabled by the container runtime |
| image.pullPolicy | string | `"Always"` | Deployment pull policy, either "Always" or "IfNotPresent" |
| image.repository | string | `"ghcr.io/joeferner/redis-commander"` | Docker image for deployment |
| image.seccompProfile | string | `"runtime/default"` | Enable SecComp profile when used by cluster, change to "unconfined" to disable. Either AppArmor or SecComp may be enabled by the container runtime |
| image.tag | string | `""` | Overrides the image tag whose default is the chart appVersion. |
| imagePullSecrets | list | `[]` | Optional image pull secrets for private docker registries |
| ingress.annotations | object | `{}` | Add additional annotations for the ingess spec Example:   'kubernetes.io/ingress.class: nginx' or 'kubernetes.io/tls-acme: "true"' |
| ingress.className | string | `""` | optional name of an IngressClass used for this Ingress, available since k8s 1.18 https://kubernetes.io/docs/concepts/services-networking/ingress/#the-ingress-resource |
| ingress.enabled | bool | `false` | Enable Ingress for the service |
| ingress.hosts[0] | object | `{"host":"chart-example.local","paths":["/"]}` | Host name to use for the ingress definition |
| ingress.hosts[0].paths | list | `["/"]` | list of paths within the given host for path-based routing, otherwise the root path "/" will be used |
| ingress.legacy | bool | `false` | Use *Legacy*, deprecated Ingress versions. Ingress apiVersions prior to `networking.k8s.io/v1` are deprecated and removed in kubernetes 1.22. Set the `legacy` flag to *true* if you are using kubernetes older than 1.19 or OpenShift v3 and require support for the older API versions. |
| ingress.pathType | string | `"ImplementationSpecific"` | Set the pathType for the v1 Ingress resource.  This setting is ignored for `legacy` Ingress resources. Details on **Path Type** are available here; https://kubernetes.io/docs/concepts/services-networking/ingress/#path-types |
| ingress.tls | list | `[]` |  |
| istio.enabled | bool | `false` | Enable Istio VirtualService for the service The endpoint (target) is defined by the regular k8s service already defined by the chart |
| istio.gateway | string | `""` | Gateway name to use for the istio definition |
| istio.host | string | `""` | Host name to use for the istio definition |
| istio.hostPrefix | string | `"/"` | Host prefix to use for the istio definition |
| kubeVersion | string | `""` | Optional override Kubernetes version |
| nameOverride | string | `""` |  |
| nodeSelector | object | `{}` | optional set pod node selector definitions for kubernetes |
| podAnnotations | object | `{}` |  |
| podSecurityContext | object | `{}` |  |
| redis.host | string | `"redis-master"` | Specifies a single Redis host |
| redis.hosts | string | `""` | Alternative: Specifies multiple redis endpoints <label:host:port>,... instead of one in "redis.host" Example: "local:localhost:6379,myredis:10.10.20.30" |
| redis.password | string | `""` | Specifies redis password |
| redis.username | string | `""` | Specifies redis username - supported since Redis 6.0 with ACL support. |
| replicaCount | int | `1` | Number of replicas to create for deployment, should be 1 |
| resources | object | `{}` | We usually recommend not to specify default resources and to leave this as a conscious choice for the user. This also increases chances charts run on environments with little resources, such as Minikube. If you do want to specify resources, uncomment the following lines, adjust them as necessary, and remove the curly braces after 'resources:'. |
| securityContext | object | `{"allowPrivilegeEscalation":false,"capabilities":{"drop":["ALL"]},"readOnlyRootFilesystem":false,"runAsNonRoot":true}` | Configuration of the linux security context for the docker image. This restricts the rights of the running docker image as far as possible. "readOnlyRootFilesystem" must be set to false to auto-generate a config file with multiple redis hosts or sentinel hosts |
| service.annotations | object | `{}` | Add additional annotations for the service spec Example:   'my.custom.annotation: value' |
| service.port | int | `80` | External port where service is available |
| service.type | string | `"ClusterIP"` | Type of k8s service to export |
| 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 | `[]` | 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 of  the time also require setting a "volumes" entry. |
| volumes | 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 of  the time also require setting a "volumeMounts" entry. |

## Example

Another alternative is the usage of the helm repo hosted at the github pages site.

```sh
# add repo
helm repo add redis-commander https://joeferner.github.io/redis-commander/

# custom values
cat > myvalues.yaml <<EOF
redis.host: redis-master
# env:
# - name: FOLDING_CHAR
#   value: "/"
ingress:
  enabled: true
  annotations:
    kubernetes.io/ingress.class: nginx
  hosts:
    - host: redis-ui.example.com
      paths: ["/"]
EOF

# install helm chart with the custom values
helm install \
  redis-web-ui \
  redis-commander/redis-commander \
  -f myvalues.yaml

```

## Potentially Breaking Changes

Chart version 0.20 switches to use the `networking.k8s.io/v1` apiVersion by default for Ingress resources.  This is a requirement for kubernetes 1.22 or later.
If you are using a version of kubernetes older than 1.19 or using OpenShift v3 you will need to set the `ingress.legacy` option to `true` to enable support for the deprecated Ingress versions.

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.7.0](https://github.com/norwoodj/helm-docs/releases/v1.7.0)