From d7da8e863f30a6975b89a1bba34855d83bed59e3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Carlos=20Juan=20G=C3=B3mez=20Pe=C3=B1alver?= Date: Thu, 9 Apr 2020 17:31:13 +0100 Subject: [PATCH] feat: argo-cd can deploy Redis HA (#270) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * feat: argo-cd can deploy Redis HA Signed-off-by: Carlos Juan Gómez Peñalver * fix: add unarchived subchart redis-ha Signed-off-by: Carlos Juan Gómez Peñalver * fix: Redis HA upgraded since 4.3.4 contains a bug on the chart Signed-off-by: Carlos Juan Gómez Peñalver * docs: how to configure Redis and Redis HA * fix: add missing chart folder Signed-off-by: Carlos Juan Gómez Peñalver * fix: Helm bug with subcharts and alias * fix: Chart version * fix: Remove archived subcharts Signed-off-by: Carlos Juan Gómez Peñalver * fix: lint script Signed-off-by: Carlos Juan Gómez Peñalver * Revert "fix: lint script" This reverts commit f4b81cbb6fc6d6c271f07b3d271a110b43edb9dd. * fix: lint and publish scripts Signed-off-by: Carlos Juan Gómez Peñalver * fix: align test-image versions Signed-off-by: Carlos Juan Gómez Peñalver * fix: remove sudo from scripts Signed-off-by: Carlos Juan Gómez Peñalver * fix: add required repositories to helm Signed-off-by: Carlos Juan Gómez Peñalver * fix: simplify expression Signed-off-by: Carlos Juan Gómez Peñalver * fix: bump up chart version Signed-off-by: Carlos Juan Gómez Peñalver Co-authored-by: Spencer Gilbert --- .circleci/config.yml | 4 +- .gitignore | 2 +- charts/argo-cd/Chart.yaml | 2 +- charts/argo-cd/README.md | 37 +- charts/argo-cd/charts/redis-ha/Chart.yaml | 21 + charts/argo-cd/charts/redis-ha/OWNERS | 6 + charts/argo-cd/charts/redis-ha/README.md | 230 +++++++++++ .../redis-ha/ci/haproxy-enabled-values.yaml | 10 + .../charts/redis-ha/templates/NOTES.txt | 25 ++ .../charts/redis-ha/templates/_configs.tpl | 275 +++++++++++++ .../charts/redis-ha/templates/_helpers.tpl | 83 ++++ .../redis-ha/templates/redis-auth-secret.yaml | 12 + .../templates/redis-ha-announce-service.yaml | 41 ++ .../templates/redis-ha-configmap.yaml | 25 ++ .../redis-ha-exporter-script-configmap.yaml | 11 + .../redis-ha/templates/redis-ha-pdb.yaml | 15 + .../redis-ha/templates/redis-ha-role.yaml | 19 + .../templates/redis-ha-rolebinding.yaml | 19 + .../redis-ha/templates/redis-ha-service.yaml | 35 ++ .../templates/redis-ha-serviceaccount.yaml | 12 + .../templates/redis-ha-servicemonitor.yaml | 35 ++ .../templates/redis-ha-statefulset.yaml | 319 +++++++++++++++ .../templates/redis-haproxy-deployment.yaml | 151 ++++++++ .../templates/redis-haproxy-service.yaml | 42 ++ .../redis-haproxy-serviceaccount.yaml | 12 + .../redis-haproxy-servicemonitor.yaml | 34 ++ .../tests/test-redis-ha-configmap.yaml | 27 ++ .../templates/tests/test-redis-ha-pod.yaml | 20 + charts/argo-cd/charts/redis-ha/values.yaml | 362 ++++++++++++++++++ charts/argo-cd/requirements.lock | 6 + charts/argo-cd/requirements.yaml | 5 + charts/argo-cd/templates/_helpers.tpl | 7 + .../deployment.yaml | 4 +- .../argocd-repo-server/deployment.yaml | 3 +- .../templates/argocd-server/deployment.yaml | 3 +- .../argo-cd/templates/redis/deployment.yaml | 3 +- charts/argo-cd/templates/redis/service.yaml | 3 +- charts/argo-cd/values.yaml | 18 + charts/argo-ci/charts/argo-0.5.2.tgz | Bin 19907 -> 0 bytes charts/argo/charts/minio-5.0.6.tgz | Bin 16763 -> 0 bytes scripts/lint.sh | 21 +- scripts/publish.sh | 25 +- 42 files changed, 1951 insertions(+), 33 deletions(-) create mode 100644 charts/argo-cd/charts/redis-ha/Chart.yaml create mode 100644 charts/argo-cd/charts/redis-ha/OWNERS create mode 100644 charts/argo-cd/charts/redis-ha/README.md create mode 100644 charts/argo-cd/charts/redis-ha/ci/haproxy-enabled-values.yaml create mode 100644 charts/argo-cd/charts/redis-ha/templates/NOTES.txt create mode 100644 charts/argo-cd/charts/redis-ha/templates/_configs.tpl create mode 100644 charts/argo-cd/charts/redis-ha/templates/_helpers.tpl create mode 100644 charts/argo-cd/charts/redis-ha/templates/redis-auth-secret.yaml create mode 100644 charts/argo-cd/charts/redis-ha/templates/redis-ha-announce-service.yaml create mode 100644 charts/argo-cd/charts/redis-ha/templates/redis-ha-configmap.yaml create mode 100644 charts/argo-cd/charts/redis-ha/templates/redis-ha-exporter-script-configmap.yaml create mode 100644 charts/argo-cd/charts/redis-ha/templates/redis-ha-pdb.yaml create mode 100644 charts/argo-cd/charts/redis-ha/templates/redis-ha-role.yaml create mode 100644 charts/argo-cd/charts/redis-ha/templates/redis-ha-rolebinding.yaml create mode 100644 charts/argo-cd/charts/redis-ha/templates/redis-ha-service.yaml create mode 100644 charts/argo-cd/charts/redis-ha/templates/redis-ha-serviceaccount.yaml create mode 100644 charts/argo-cd/charts/redis-ha/templates/redis-ha-servicemonitor.yaml create mode 100644 charts/argo-cd/charts/redis-ha/templates/redis-ha-statefulset.yaml create mode 100644 charts/argo-cd/charts/redis-ha/templates/redis-haproxy-deployment.yaml create mode 100644 charts/argo-cd/charts/redis-ha/templates/redis-haproxy-service.yaml create mode 100644 charts/argo-cd/charts/redis-ha/templates/redis-haproxy-serviceaccount.yaml create mode 100644 charts/argo-cd/charts/redis-ha/templates/redis-haproxy-servicemonitor.yaml create mode 100644 charts/argo-cd/charts/redis-ha/templates/tests/test-redis-ha-configmap.yaml create mode 100644 charts/argo-cd/charts/redis-ha/templates/tests/test-redis-ha-pod.yaml create mode 100644 charts/argo-cd/charts/redis-ha/values.yaml create mode 100644 charts/argo-cd/requirements.lock delete mode 100644 charts/argo-ci/charts/argo-0.5.2.tgz delete mode 100644 charts/argo/charts/minio-5.0.6.tgz diff --git a/.circleci/config.yml b/.circleci/config.yml index 072c6736..4156df56 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -2,7 +2,7 @@ version: 2.1 jobs: lint: docker: - - image: gcr.io/kubernetes-charts-ci/test-image:v3.0.1 + - image: gcr.io/kubernetes-charts-ci/test-image:v3.1.0 steps: - checkout - run: ct lint --config .circleci/chart-testing.yaml --lint-conf .circleci/lintconf.yaml @@ -11,7 +11,7 @@ jobs: publish: docker: # We just need an image with `helm` on it. Handily we know of one already. - - image: gcr.io/kubernetes-charts-ci/test-image:v3.0.1 + - image: gcr.io/kubernetes-charts-ci/test-image:v3.1.0 steps: # install the additional keys needed to push to Github. Alex Collins owns these keys. - add_ssh_keys diff --git a/.gitignore b/.gitignore index ad3d67a1..f501fc92 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,4 @@ output .vscode .DS_Store -*.tgz +**/*.tgz diff --git a/charts/argo-cd/Chart.yaml b/charts/argo-cd/Chart.yaml index a07fef62..07f93ec3 100644 --- a/charts/argo-cd/Chart.yaml +++ b/charts/argo-cd/Chart.yaml @@ -2,7 +2,7 @@ apiVersion: v1 appVersion: "1.5.1" description: A Helm chart for ArgoCD, a declarative, GitOps continuous delivery tool for Kubernetes. name: argo-cd -version: 2.1.2 +version: 2.2.0 home: https://github.com/argoproj/argo-helm icon: https://raw.githubusercontent.com/argoproj/argo/master/docs/assets/argo.png keywords: diff --git a/charts/argo-cd/README.md b/charts/argo-cd/README.md index e419f734..44163122 100644 --- a/charts/argo-cd/README.md +++ b/charts/argo-cd/README.md @@ -13,7 +13,7 @@ This chart currently installs the non-HA version of ArgoCD. ## Upgrading -### 1.8.7 to 2.0.0 +### 1.8.7 to 2.x.x `controller.extraArgs`, `repoServer.extraArgs` and `server.extraArgs` are not arrays of strings intead of a map @@ -75,8 +75,8 @@ Helm v3 has removed the `install-crds` hook so CRDs are now populated by files i ## ArgoCD Controller -| Key | Type | Default | Description | -|-----|------|---------|-------------| +| Key | Default | Description | +|-----|---------|-------------| | controller.affinity | Assign custom affinity rules to the deployment https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ | `{}` | | controller.args.operationProcessors | define the controller `--operation-processors` | `"10"` | | controller.args.statusProcessors | define the controller `--status-processors` | `"20"` | @@ -121,8 +121,8 @@ Helm v3 has removed the `install-crds` hook so CRDs are now populated by files i ## Argo Repo Server -| Key | Type | Default | Description | -|-----|------|---------|-------------| +| Key | Default | Description | +|-----|---------|-------------| | repoServer.affinity | Assign custom affinity rules to the deployment https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ | `{}` | | repoServer.autoscaling.enabled | Enable Horizontal Pod Autoscaler (HPA) for the repo server | `false` | | repoServer.autoscaling.minReplicas | Minimum number of replicas for the repo server HPA | `1` | @@ -168,8 +168,8 @@ Helm v3 has removed the `install-crds` hook so CRDs are now populated by files i ## Argo Server -| Key | Type | Default | Description | -|-----|------|---------|-------------| +| Key | Default | Description | +|-----|---------|-------------| | server.affinity | Assign custom affinity rules to the deployment https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ | `{}` | | server.autoscaling.enabled | Enable Horizontal Pod Autoscaler (HPA) for the server | `false` | | server.autoscaling.minReplicas | Minimum number of replicas for the server HPA | `1` | @@ -234,8 +234,8 @@ Helm v3 has removed the `install-crds` hook so CRDs are now populated by files i ## Dex -| Key | Type | Default | Description | -|-----|------|---------|-------------| +| Key | Default | Description | +|-----|---------|-------------| | dex.affinity | Assign custom affinity rules to the deployment https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ | `{}` | | dex.containerPortGrpc | GRPC container port | `5557` | | dex.containerPortHttp | HTTP container port | `5556` | @@ -263,8 +263,14 @@ Helm v3 has removed the `install-crds` hook so CRDs are now populated by files i ## Redis -| Key | Type | Default | Description | -|-----|------|---------|-------------| +When Redis is completely disabled from the chart (`redis.enabled=false`) and +an external Redis instance wants to be used or +when Redis HA subcart is enabled (`redis.enabled=true and redis-ha.enabled=true`) +but HA proxy is disabled `redis-ha.haproxy.enabled=false` Redis flags need to be specified +through `xxx.extraArgs` + +| Key | Default | Description | +|-----|---------|-------------| | redis.affinity | Assign custom affinity rules to the deployment https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ | `{}` | | redis.containerPort | Redis container port | `6379` | | redis.enabled | Enable redis | `true` | @@ -280,3 +286,12 @@ Helm v3 has removed the `install-crds` hook so CRDs are now populated by files i | redis.resources | Resource limits and requests for redis | `{}` | | redis.servicePort | Redis service port | `6379` | | redis.tolerations | Tolerations for use with node taints https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ | `[]` | +| redis-ha | Configures Redis HA subchart https://github.com/helm/charts/tree/master/stable/redis-ha | | | +| redis-ha.enabled | Enables the Redis HA subchart and disables the custom Redis single node deployment| `false` | +| redis-ha.exporter.enabled | If `true`, the prometheus exporter sidecar is enabled | `true` | +| redis-ha.persistentVolume.enabled | Configures persistency on Redis nodes | `false` +| redis-ha.redis.masterGroupName | Redis convention for naming the cluster group: must match `^[\\w-\\.]+$` and can be templated | `argocd` +| redis-ha.redis.config | Any valid redis config options in this section will be applied to each server (see `redis-ha` chart) | `` | +| redis-ha.redis.config.save | Will save the DB if both the given number of seconds and the given number of write operations against the DB occurred. `""` is disabled | `""` | +| redis-ha.haproxy.enabled | Enabled HAProxy LoadBalancing/Proxy | `true` | +| redis-ha.haproxy.metrics.enabled | HAProxy enable prometheus metric scraping | `true` | diff --git a/charts/argo-cd/charts/redis-ha/Chart.yaml b/charts/argo-cd/charts/redis-ha/Chart.yaml new file mode 100644 index 00000000..04a04fdf --- /dev/null +++ b/charts/argo-cd/charts/redis-ha/Chart.yaml @@ -0,0 +1,21 @@ +apiVersion: v1 +appVersion: 5.0.6 +description: Highly available Kubernetes implementation of Redis +engine: gotpl +home: http://redis.io/ +icon: https://upload.wikimedia.org/wikipedia/en/thumb/6/6b/Redis_Logo.svg/1200px-Redis_Logo.svg.png +keywords: +- redis +- keyvalue +- database +maintainers: +- email: salimsalaues@gmail.com + name: ssalaues +- email: aaron.layfield@gmail.com + name: dandydeveloper +name: redis-ha +sources: +- https://redis.io/download +- https://github.com/scality/Zenko/tree/development/1.0/kubernetes/zenko/charts/redis-ha +- https://github.com/oliver006/redis_exporter +version: 4.4.2 diff --git a/charts/argo-cd/charts/redis-ha/OWNERS b/charts/argo-cd/charts/redis-ha/OWNERS new file mode 100644 index 00000000..cf4f87d5 --- /dev/null +++ b/charts/argo-cd/charts/redis-ha/OWNERS @@ -0,0 +1,6 @@ +approvers: +- ssalaues +- dandydeveloper +reviewers: +- ssalaues +- dandydeveloper \ No newline at end of file diff --git a/charts/argo-cd/charts/redis-ha/README.md b/charts/argo-cd/charts/redis-ha/README.md new file mode 100644 index 00000000..ba93ce0f --- /dev/null +++ b/charts/argo-cd/charts/redis-ha/README.md @@ -0,0 +1,230 @@ +# Redis + +[Redis](http://redis.io/) is an advanced key-value cache and store. It is often referred to as a data structure server since keys can contain strings, hashes, lists, sets, sorted sets, bitmaps and hyperloglogs. + +## TL;DR; + +```bash +$ helm install stable/redis-ha +``` + +By default this chart install 3 pods total: + * one pod containing a redis master and sentinel container (optional prometheus metrics exporter sidecar available) + * two pods each containing a redis slave and sentinel containers (optional prometheus metrics exporter sidecars available) + +## Introduction + +This chart bootstraps a [Redis](https://redis.io) highly available master/slave statefulset in a [Kubernetes](http://kubernetes.io) cluster using the Helm package manager. + +## Prerequisites + +- Kubernetes 1.8+ with Beta APIs enabled +- PV provisioner support in the underlying infrastructure + +## Upgrading the Chart + +Please note that there have been a number of changes simplifying the redis management strategy (for better failover and elections) in the 3.x version of this chart. These changes allow the use of official [redis](https://hub.docker.com/_/redis/) images that do not require special RBAC or ServiceAccount roles. As a result when upgrading from version >=2.0.1 to >=3.0.0 of this chart, `Role`, `RoleBinding`, and `ServiceAccount` resources should be deleted manually. + +### Upgrading the chart from 3.x to 4.x + +Starting from version `4.x` HAProxy sidecar prometheus-exporter removed and replaced by the embedded [HAProxy metrics endpoint](https://github.com/haproxy/haproxy/tree/master/contrib/prometheus-exporter), as a result when upgrading from version 3.x to 4.x section `haproxy.exporter` should be removed and the `haproxy.metrics` need to be configured for fit your needs. + +## Installing the Chart + +To install the chart + +```bash +$ helm install stable/redis-ha +``` + +The command deploys Redis on the Kubernetes cluster in the default configuration. By default this chart install one master pod containing redis master container and sentinel container along with 2 redis slave pods each containing their own sentinel sidecars. The [configuration](#configuration) section lists the parameters that can be configured during installation. + +> **Tip**: List all releases using `helm list` + +## Uninstalling the Chart + +To uninstall/delete the deployment: + +```bash +$ helm delete +``` + +The command removes all the Kubernetes components associated with the chart and deletes the release. + +## Configuration + +The following table lists the configurable parameters of the Redis chart and their default values. + +| Parameter | Description | Default | +|:--------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------------------| +| `image` | Redis image | `redis` | +| `imagePullSecrets` | Reference to one or more secrets to be used when pulling redis images | [] | +| `tag` | Redis tag | `5.0.6-alpine` | +| `replicas` | Number of redis master/slave pods | `3` | +| `serviceAccount.create` | Specifies whether a ServiceAccount should be created | `true` | +| `serviceAccount.name` | The name of the ServiceAccount to create | Generated using the redis-ha.fullname template | +| `rbac.create` | Create and use RBAC resources | `true` | +| `redis.port` | Port to access the redis service | `6379` | +| `redis.masterGroupName` | Redis convention for naming the cluster group: must match `^[\\w-\\.]+$` and can be templated | `mymaster` | +| `redis.config` | Any valid redis config options in this section will be applied to each server (see below) | see values.yaml | +| `redis.customConfig` | Allows for custom redis.conf files to be applied. If this is used then `redis.config` is ignored | `` | +| `redis.resources` | CPU/Memory for master/slave nodes resource requests/limits | `{}` | +| `sentinel.port` | Port to access the sentinel service | `26379` | +| `sentinel.quorum` | Minimum number of servers necessary to maintain quorum | `2` | +| `sentinel.config` | Valid sentinel config options in this section will be applied as config options to each sentinel (see below) | see values.yaml | +| `sentinel.customConfig` | Allows for custom sentinel.conf files to be applied. If this is used then `sentinel.config` is ignored | `` | +| `sentinel.resources` | CPU/Memory for sentinel node resource requests/limits | `{}` | +| `init.resources` | CPU/Memory for init Container node resource requests/limits | `{}` | +| `auth` | Enables or disables redis AUTH (Requires `redisPassword` to be set) | `false` | +| `redisPassword` | A password that configures a `requirepass` and `masterauth` in the conf parameters (Requires `auth: enabled`) | `` | +| `authKey` | The key holding the redis password in an existing secret. | `auth` | +| `existingSecret` | An existing secret containing a key defined by `authKey` that configures `requirepass` and `masterauth` in the conf parameters (Requires `auth: enabled`, cannot be used in conjunction with `.Values.redisPassword`) | `` | +| `nodeSelector` | Node labels for pod assignment | `{}` | +| `tolerations` | Toleration labels for pod assignment | `[]` | +| `hardAntiAffinity` | Whether the Redis server pods should be forced to run on separate nodes. | `true` | +| `additionalAffinities` | Additional affinities to add to the Redis server pods. | `{}` | +| `securityContext` | Security context to be added to the Redis server pods. | `{runAsUser: 1000, fsGroup: 1000, runAsNonRoot: true}` | +| `affinity` | Override all other affinity settings with a string. | `""` | +| `persistentVolume.size` | Size for the volume | 10Gi | +| `persistentVolume.annotations` | Annotations for the volume | `{}` | +| `persistentVolume.reclaimPolicy` | Method used to reclaim an obsoleted volume. `Delete` or `Retain` | `""` | +| `emptyDir` | Configuration of `emptyDir`, used only if persistentVolume is disabled and no hostPath specified | `{}` | +| `exporter.enabled` | If `true`, the prometheus exporter sidecar is enabled | `false` | +| `exporter.image` | Exporter image | `oliver006/redis_exporter` | +| `exporter.tag` | Exporter tag | `v0.31.0` | +| `exporter.port` | Exporter port | `9121` | +| `exporter.annotations` | Prometheus scrape annotations | `{prometheus.io/path: /metrics, prometheus.io/port: "9121", prometheus.io/scrape: "true"}` | +| `exporter.extraArgs` | Additional args for the exporter | `{}` | +| `exporter.script` | A custom custom Lua script that will be mounted to exporter for collection of custom metrics. Creates a ConfigMap and sets env var `REDIS_EXPORTER_SCRIPT`. | | +| `exporter.serviceMonitor.enabled` | Use servicemonitor from prometheus operator | `false` | +| `exporter.serviceMonitor.namespace` | Namespace the service monitor is created in | `default` | +| `exporter.serviceMonitor.interval` | Scrape interval, If not set, the Prometheus default scrape interval is used | `nil` | +| `exporter.serviceMonitor.telemetryPath` | Path to redis-exporter telemetry-path | `/metrics` | +| `exporter.serviceMonitor.labels` | Labels for the servicemonitor passed to Prometheus Operator | `{}` | +| `exporter.serviceMonitor.timeout` | How long until a scrape request times out. If not set, the Prometheus default scape timeout is used | `nil` | +| `haproxy.enabled` | Enabled HAProxy LoadBalancing/Proxy | `false` | +| `haproxy.replicas` | Number of HAProxy instances | `3` | +| `haproxy.image.repository`| HAProxy Image Repository | `haproxy` | +| `haproxy.image.tag` | HAProxy Image Tag | `2.0.1` | +| `haproxy.image.pullPolicy`| HAProxy Image PullPolicy | `IfNotPresent` | +| `haproxy.imagePullSecrets`| Reference to one or more secrets to be used when pulling haproxy images | [] | +| `haproxy.annotations` | HAProxy template annotations | `{}` | +| `haproxy.customConfig` | Allows for custom config-haproxy.cfg file to be applied. If this is used then default config will be overwriten | `` | +| `haproxy.extraConfig` | Allows to place any additional configuration section to add to the default config-haproxy.cfg | `` | +| `haproxy.resources` | HAProxy resources | `{}` | +| `haproxy.emptyDir` | Configuration of `emptyDir` | `{}` | +| `haproxy.service.type` | HAProxy service type "ClusterIP", "LoadBalancer" or "NodePort" | `ClusterIP` | +| `haproxy.service.nodePort` | HAProxy service nodePort value (haproxy.service.type must be NodePort) | not set | +| `haproxy.service.annotations` | HAProxy service annotations | `{}` | +| `haproxy.stickyBalancing` | HAProxy sticky load balancing to Redis nodes. Helps with connections shutdown. | `false` | +| `haproxy.hapreadport.enable` | Enable a read only port for redis slaves | `false` | +| `haproxy.hapreadport.port` | Haproxy port for read only redis slaves | `6380` | +| `haproxy.metrics.enabled` | HAProxy enable prometheus metric scraping | `false` | +| `haproxy.metrics.port` | HAProxy prometheus metrics scraping port | `9101` | +| `haproxy.metrics.portName` | HAProxy metrics scraping port name | `exporter-port` | +| `haproxy.metrics.scrapePath` | HAProxy prometheus metrics scraping port | `/metrics` | +| `haproxy.metrics.serviceMonitor.enabled` | Use servicemonitor from prometheus operator for HAProxy metrics | `false` | +| `haproxy.metrics.serviceMonitor.namespace` | Namespace the service monitor for HAProxy metrics is created in | `default` | +| `haproxy.metrics.serviceMonitor.interval` | Scrape interval, If not set, the Prometheus default scrape interval is used | `nil` | +| `haproxy.metrics.serviceMonitor.telemetryPath` | Path to HAProxy metrics telemetry-path | `/metrics` | +| `haproxy.metrics.serviceMonitor.labels` | Labels for the HAProxy metrics servicemonitor passed to Prometheus Operator | `{}` | +| `haproxy.metrics.serviceMonitor.timeout` | How long until a scrape request times out. If not set, the Prometheus default scape timeout is used | `nil` | +| `haproxy.init.resources` | Extra init resources | `{}` | +| `haproxy.timeout.connect` | haproxy.cfg `timeout connect` setting | `4s` | +| `haproxy.timeout.server` | haproxy.cfg `timeout server` setting | `30s` | +| `haproxy.timeout.client` | haproxy.cfg `timeout client` setting | `30s` | +| `haproxy.timeout.check` | haproxy.cfg `timeout check` setting | `2s` | +| `haproxy.priorityClassName` | priorityClassName for `haproxy` deployment | not set | +| `haproxy.securityContext` | Security context to be added to the HAProxy deployment. | `{runAsUser: 1000, fsGroup: 1000, runAsNonRoot: true}` | +| `haproxy.hardAntiAffinity` | Whether the haproxy pods should be forced to run on separate nodes. | `true` | +| `haproxy.affinity` | Override all other haproxy affinity settings with a string. | `""` | +| `haproxy.additionalAffinities` | Additional affinities to add to the haproxy server pods. | `{}` | +| `podDisruptionBudget` | Pod Disruption Budget rules | `{}` | +| `priorityClassName` | priorityClassName for `redis-ha-statefulset` | not set | +| `hostPath.path` | Use this path on the host for data storage | not set | +| `hostPath.chown` | Run an init-container as root to set ownership on the hostPath | `true` | +| `sysctlImage.enabled` | Enable an init container to modify Kernel settings | `false` | +| `sysctlImage.command` | sysctlImage command to execute | [] | +| `sysctlImage.registry` | sysctlImage Init container registry | `docker.io` | +| `sysctlImage.repository` | sysctlImage Init container name | `busybox` | +| `sysctlImage.tag` | sysctlImage Init container tag | `1.31.1` | +| `sysctlImage.pullPolicy` | sysctlImage Init container pull policy | `Always` | +| `sysctlImage.mountHostSys`| Mount the host `/sys` folder to `/host-sys` | `false` | +| `sysctlImage.resources` | sysctlImage resources | `{}` | +| `schedulerName` | Alternate scheduler name | `nil` | + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, + +```bash +$ helm install \ + --set image=redis \ + --set tag=5.0.5-alpine \ + stable/redis-ha +``` + +The above command sets the Redis server within `default` namespace. + +Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example, + +```bash +$ helm install -f values.yaml stable/redis-ha +``` + +> **Tip**: You can use the default [values.yaml](values.yaml) + +## Custom Redis and Sentinel config options + +This chart allows for most redis or sentinel config options to be passed as a key value pair through the `values.yaml` under `redis.config` and `sentinel.config`. See links below for all available options. + +[Example redis.conf](http://download.redis.io/redis-stable/redis.conf) +[Example sentinel.conf](http://download.redis.io/redis-stable/sentinel.conf) + +For example `repl-timeout 60` would be added to the `redis.config` section of the `values.yaml` as: + +```yml + repl-timeout: "60" +``` + +Note: + +1. Some config options should be renamed by redis version，e.g.: + + ``` + # In redis 5.x，see https://raw.githubusercontent.com/antirez/redis/5.0/redis.conf + min-replicas-to-write: 1 + min-replicas-max-lag: 5 + + # In redis 4.x and redis 3.x，see https://raw.githubusercontent.com/antirez/redis/4.0/redis.conf and https://raw.githubusercontent.com/antirez/redis/3.0/redis.conf + min-slaves-to-write 1 + min-slaves-max-lag 5 + ``` + +Sentinel options supported must be in the the `sentinel