Skip to content
This repository has been archived by the owner on Jun 6, 2023. It is now read-only.

Commit

Permalink
keydb: add description
Browse files Browse the repository at this point in the history
  • Loading branch information
@Antiarchitect
Antiarchitect committed Apr 23, 2021
1 parent 2ba9582 commit 6cad219
Showing 1 changed file with 44 additions and 41 deletions.
85 changes: 44 additions & 41 deletions keydb/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,44 +30,47 @@ helm install keydb enapter/keydb

The following table lists the configurable parameters of the KeyDB chart and their default values.

| Parameter | Description | Default |
|:--------------------------------|:------------------------------------------------|:------------------------------------------|
| `image` | KeyDB docker image | `eqalpha/keydb:x86_64_v6.0.16` |
| `imagePullPolicy` | K8s imagePullPolicy | `IfNotPresent` |
| `nodes` | Number of KeyDB master pods | `3` |
| `password` | If enabled KeyDB servers are password-protected | `""` |
| `port` | KeyDB service port clients connect to | `6379` |
| `threads` | KeyDB server-threads per node | `2` |
| `appendonly` | KeyDB appendonly setting | `"no"` |
| `configExtraArgs` | Additional configuration arguments for KeyDB | `{}` |
| `podAnnotations` | KeyDB pods annotations | `{}` |
| `tolerations` | KeyDB tolerations setting | `{}` |
| `additionalAffinities` | Additional affinities for StatefulSet | `{}` |
| `livenessProbe` | LivenessProbe for KeyDB pods | Look values.yaml |
| `readinessProbe` | ReadinessProbe for KeyDB pods | Look values.yaml |
| `startupProbe` | StartupProbe for KeyDB pods | Look values.yaml |
| `persistentVolume.enabled` | Should PVC be created via volumeClaimTemplates | `true` |
| `persistentVolume.accessModes` | Volume access modes | `[ReadWriteOnce]` |
| `persistentVolume.size` | Size of the volume | `1Gi` |
| `persistentVolume.storageClass` | StorageClassName for volume | `` |
| `resources` | Resources for KeyDB containers | `{}` |
| `securityContext` | SecurityContext for KeyDB pods | `{}` |
| `service.annotations` | Service annotations | `{}` |
| `loadBalancer.enabled` | Create LoadBalancer service | `false` |
| `loadBalancer.annotations` | Annotations for LB | `{}` |
| `loadBalancer.extraSpec` | Additional spec for LB | `{}` |
| `serviceMonitor.enabled` | Prometheus operator ServiceMonitor | `false` |
| `serviceMonitor.labels` | Additional labels for ServiceMonitor | `{}` |
| `serviceMonitor.annotations` | Additional annotations for ServiceMonitor | `{}` |
| `serviceMonitor.interval` | ServiceMonitor scrape interval | `30s` |
| `serviceMonitor.scrapeTimeout` | ServiceMonitor scrape timeout | `nil` |
| `exporter.enabled` | Prometheus Exporter sidecar contaner | `false` |
| `exporter.image` | Exporter Image | `oliver006/redis_exporter:v1.12.1-alpine` |
| `exporter.pullPolicy` | Exporter imagePullPolicy | `IfNotPresent` |
| `exporter.port` | `prometheus.io/port` | `9121` |
| `exporter.scrapePath` | `prometheus.io/path` | `/metrics` |
| `exporter.livenessProbe` | LivenessProbe for sidecar Prometheus exporter | Look values.yaml |
| `exporter.readinessProbe` | ReadinessProbe for sidecar Prometheus exporter | Look values.yaml |
| `exporter.startupProbe` | StartupProbe for sidecar Prometheus exporter | Look values.yaml |
| `exporter.resources` | Resources for sidecar Prometheus container | `{}` |
| `exporter.extraArgs` | Additional arguments for exporter | `{}` |
| Parameter | Description | Default |
|:--------------------------------|:---------------------------------------------------|:------------------------------------------|
| `image` | KeyDB docker image | `eqalpha/keydb:x86_64_v6.0.16` |
| `imagePullPolicy` | K8s imagePullPolicy | `IfNotPresent` |
| `nodes` | Number of KeyDB master pods | `3` |
| `password` | If enabled KeyDB servers are password-protected | `""` |
| `port` | KeyDB service port clients connect to | `6379` |
| `threads` | KeyDB server-threads per node | `2` |
| `appendonly` | KeyDB appendonly setting | `"no"` |
| `configExtraArgs` | Additional configuration arguments for KeyDB | `{}` |
| `podAnnotations` | KeyDB pods annotations | `{}` |
| `tolerations` | KeyDB tolerations setting | `{}` |
| `additionalAffinities` | Additional affinities for StatefulSet | `{}` |
| `extraInitContainers` | Additional init containers for StatefulSet | `[]` |
| `extraContainers` | Additional sidecar containers for StatefulSet | `[]` |
| `extraVolumes` | Additional volumes for init and sidecar containers | `[]` |
| `livenessProbe` | LivenessProbe for KeyDB pods | Look values.yaml |
| `readinessProbe` | ReadinessProbe for KeyDB pods | Look values.yaml |
| `startupProbe` | StartupProbe for KeyDB pods | Look values.yaml |
| `persistentVolume.enabled` | Should PVC be created via volumeClaimTemplates | `true` |
| `persistentVolume.accessModes` | Volume access modes | `[ReadWriteOnce]` |
| `persistentVolume.size` | Size of the volume | `1Gi` |
| `persistentVolume.storageClass` | StorageClassName for volume | `` |
| `resources` | Resources for KeyDB containers | `{}` |
| `securityContext` | SecurityContext for KeyDB pods | `{}` |
| `service.annotations` | Service annotations | `{}` |
| `loadBalancer.enabled` | Create LoadBalancer service | `false` |
| `loadBalancer.annotations` | Annotations for LB | `{}` |
| `loadBalancer.extraSpec` | Additional spec for LB | `{}` |
| `serviceMonitor.enabled` | Prometheus operator ServiceMonitor | `false` |
| `serviceMonitor.labels` | Additional labels for ServiceMonitor | `{}` |
| `serviceMonitor.annotations` | Additional annotations for ServiceMonitor | `{}` |
| `serviceMonitor.interval` | ServiceMonitor scrape interval | `30s` |
| `serviceMonitor.scrapeTimeout` | ServiceMonitor scrape timeout | `nil` |
| `exporter.enabled` | Prometheus Exporter sidecar contaner | `false` |
| `exporter.image` | Exporter Image | `oliver006/redis_exporter:v1.12.1-alpine` |
| `exporter.pullPolicy` | Exporter imagePullPolicy | `IfNotPresent` |
| `exporter.port` | `prometheus.io/port` | `9121` |
| `exporter.scrapePath` | `prometheus.io/path` | `/metrics` |
| `exporter.livenessProbe` | LivenessProbe for sidecar Prometheus exporter | Look values.yaml |
| `exporter.readinessProbe` | ReadinessProbe for sidecar Prometheus exporter | Look values.yaml |
| `exporter.startupProbe` | StartupProbe for sidecar Prometheus exporter | Look values.yaml |
| `exporter.resources` | Resources for sidecar Prometheus container | `{}` |
| `exporter.extraArgs` | Additional arguments for exporter | `{}` |

0 comments on commit 6cad219

Please sign in to comment.