home/charts
2
0
Fork 0
mirror of https://github.com/wahyd4/charts.git synced 2026-08-19 10:06:18 +10:00
Code Issues Packages Projects Releases Wiki Activity

[bitnami/redis-cluster] Update instruction for nodes in values.yaml (#5735)

Browse Source 
* Update instruction for nodes in values.yaml

It might be a case, where people will override the node count and will set to something less than 3 and will not necessarily understand the inclusion of replica count. More importantly, if the node count does not allow at least 3 master nodes to be created e.g. nodes=3/4 with replicas=1, the cluster creation will fail.

This has to be clearly mentioned to avoid further confusion.

* Update readme

* Bump patch number

* Fix trailing spaces

* Update readme and values.yaml comments as per review

Co-authored-by: Abdul Munim Dibosh <mdabdulmunim@airasia.com>
This commit is contained in:
Abdul Munim Dibosh
2021-03-15 12:23:10 +01:00
committed by GitHub
co-authored by Abdul Munim Dibosh
parent 92d67eb892
commit 175da9d388
3 changed files with 13 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
bitnami/redis-cluster/Chart.yaml
+1 -1
View File
@@ -23,4 +23,4 @@ name: redis-cluster
sources:
- https://github.com/bitnami/bitnami-docker-redis
- http://redis.io/
version: 4.4.0
version: 4.4.1
bitnami/redis-cluster/README.md
+5 -3
View File
@@ -251,8 +251,8 @@ The following table lists the configurable parameters of the Redis<sup>TM</sup>
| Parameter | Description | Default |
|-------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------|----------------|
| `cluster.init` | Enable the creation of a job that initializes the Redis<sup>TM</sup> Cluster | `true` |
| `cluster.nodes` | Number of nodes in the Redis<sup>TM</sup> cluster | `6` |
| `cluster.replicas` | Number of replicas for every master in the cluster | `1` |
| `cluster.nodes` | Total Number of nodes in the Redis<sup>TM</sup> cluster including `replicas`. See the "Cluster topology" section | `6` |
| `cluster.replicas` | Number of replicas for every master in the cluster | `1` |
| `cluster.externalAccess.enabled` | Enable access to the Redis<sup>TM</sup> cluster from Outside the Kubernetes Cluster | `false` |
| `cluster.externalAccess.service.type` | Type for the services used to expose every Pod | `LoadBalancer` |
| `cluster.externalAccess.service.port` | Port for the services used to expose every Pod | `6379` |
@@ -338,7 +338,9 @@ To modify the Redis<sup>TM</sup> version used in this chart you can specify a [v
### Cluster topology
The Helm Chart will deploy by default 3 redis masters and 3 replicas. By default the Redis<sup>TM</sup> Cluster is not accessible from outside the Kubernetes cluster, to access the Redis<sup>TM</sup> Cluster from outside you have to set `cluster.externalAccess.enabled=true` at deployment time. It will create in the first installation only 6 LoadBalancer services, one for each Redis<sup>TM</sup> node, once you have the external IPs of each service you will need to perform an upgrade passing those IPs to the `cluster.externalAccess.service.loadbalancerIP` array.
To successfully set the cluster up, it will need to have at least 3 master nodes. The total number of nodes is calculated like- `nodes = numOfMasterNodes + numOfMasterNodes * replicas`. Hence, the defaults `cluster.nodes = 6` and `cluster.replicas = 1` means, 3 master and 3 replica nodes will be deployed by the chart.
By default the Redis<sup>TM</sup> Cluster is not accessible from outside the Kubernetes cluster, to access the Redis<sup>TM</sup> Cluster from outside you have to set `cluster.externalAccess.enabled=true` at deployment time. It will create in the first installation only 6 LoadBalancer services, one for each Redis<sup>TM</sup> node, once you have the external IPs of each service you will need to perform an upgrade passing those IPs to the `cluster.externalAccess.service.loadbalancerIP` array.
The replicas will be read-only replicas of the masters. By default only one service is exposed (when not using the external access mode). You will connect your client to the exposed service, regardless you need to read or write. When a write operation arrives to a replica it will redirect the client to the proper master node. For example, using `redis-cli` you will need to provide the `-c` flag for `redis-cli` to follow the redirection automatically.
bitnami/redis-cluster/values.yaml
+7
View File
@@ -47,6 +47,13 @@ cluster:
init: true
## Number of Redis(TM) nodes to be deployed
##
## Note:
## This is total number of nodes including the replicas. Meaning there will be 3 master and 3 replica
## nodes (as replica count is set to 1 by default, there will be 1 replica per master node).
## Hence, nodes = numberOfMasterNodes + numberOfMasterNodes * replicas
##
## The number of master nodes should always be >= 3, otherwise cluster creation will fail
##
nodes: 6
## Parameter to be passed as --cluster-replicas to the redis-cli --cluster create
## 1 means that we want a replica for every master created