summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorStephen Randall <stephen.randall@appsbroker.com>2019-03-04 16:44:12 +0000
committerStephen Randall <stephen.randall@appsbroker.com>2019-03-04 16:44:12 +0000
commit8984172ff6dd2b039e42ca0cd832cb80e37cef50 (patch)
tree9b26a4c922d3f1cad5fcef4d71c2af298a8b6306
parent87a5e7f030a3a19d7cf1654d18e5fe4725cc5707 (diff)
downloadwekan-8984172ff6dd2b039e42ca0cd832cb80e37cef50.tar.gz
wekan-8984172ff6dd2b039e42ca0cd832cb80e37cef50.tar.bz2
wekan-8984172ff6dd2b039e42ca0cd832cb80e37cef50.zip
Readme updates
-rw-r--r--helm/wekan/README.md54
1 files changed, 52 insertions, 2 deletions
diff --git a/helm/wekan/README.md b/helm/wekan/README.md
index 072c0548..d3af930c 100644
--- a/helm/wekan/README.md
+++ b/helm/wekan/README.md
@@ -2,7 +2,57 @@
## Features
- o Uses a MongoDB replica set by default - this allows fault-tolerant and scalable MongoDB deployment (or just set the replicas to 1 for a single server install)
+o Uses a MongoDB replica set by default - this allows fault-tolerant
+ and scalable MongoDB deployment (or just set the replicas to 1 for
+ a single server install)
- o Optional Horizontal Pod Autoscaler (HPA), so that your Wekan pods will scale automatically with increased CPU load.
+o Optional Horizontal Pod Autoscaler (HPA), so that your Wekan pods
+ will scale automatically with increased CPU load.
+## The configurable values (values.yaml)
+
+Scaling Wekan:
+
+```yaml
+## Configuration for wekan component
+##
+
+replicaCount: 1
+```
+**replicaCount** Will set the initial number of replicas for the Wekan pod (and container)
+
+```yaml
+## Configure an horizontal pod autoscaler
+##
+autoscaling:
+ enabled: true
+ config:
+ minReplicas: 1
+ maxReplicas: 16
+ ## Note: when setting this, a `resources.request.cpu` is required. You
+ ## likely want to set it to `1` or some lower value.
+ ##
+ targetCPUUtilizationPercentage: 80
+```
+This section (if *enabled* is set to **true**) will enable the Kubernetes Horizontal Pod Autoscaler (HPA).
+
+**minReplicas:** this is the minimum number of pods to scale down to (We recommend setting this to the same value as **replicaCount**).
+
+**maxReplicas:** this is the maximum number of pods to scale up to.
+
+**targetCPUUtilizationPercentage:** This is the CPU at which the HPA will scale-out the number of Wekan pods.
+
+```yaml
+mongodb-replicaset:
+ enabled: true
+ replicas: 3
+ replicaSetName: rs0
+ securityContext:
+ runAsUser: 1000
+ fsGroup: 1000
+ runAsNonRoot: true
+```
+
+This section controls the scale of the MongoDB redundant Replica Set.
+
+**replicas:** This is the number of MongoDB instances to include in the set. You can set this to 1 for a single server - this will still allow you to scale-up later with a helm upgrade.