Skip to content

Commit 8faf0b8

Browse files
authored
Merge pull request #1050 from arms11/redis-as-coordination-backend-docs
Updated k8s_ha documentation for redis as backend coordination
2 parents f9603d5 + 4c6f8d5 commit 8faf0b8

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

docs/source/install/k8s_ha.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ This document provides an installation blueprint for a Highly Available StackSto
55
based on `Kubernetes <https://kubernetes.io/>`__, a container orchestration platform at planet scale.
66

77
The cluster deploys a minimum of 2 replicas for each component of StackStorm microservices for redundancy and reliability. It
8-
also configures backends like MongoDB HA Replicaset, RabbitMQ HA and etcd cluster that st2 relies on for database,
8+
also configures backends like MongoDB HA Replicaset, RabbitMQ HA and Redis Sentinel cluster that st2 relies on for database,
99
communication bus, and distributed coordination respectively. That raises a fleet of more than ``30`` pods total.
1010

1111
The source code for K8s resource templates is available as a GitHub repo:
@@ -111,7 +111,7 @@ Get all logs for entire StackStorm cluster with dependent services for Helm rele
111111
112112
kubectl logs -l release=<release-name>
113113
114-
Grab all logs only for stackstorm backend services, excluding st2web and DB/MQ/etcd:
114+
Grab all logs only for stackstorm backend services, excluding st2web and DB/MQ/redis:
115115

116116
.. code-block:: bash
117117
@@ -234,7 +234,7 @@ ___________
234234
Multiple st2notifier processes can run in active-active mode, using connections to RabbitMQ and MongoDB and generating triggers based on
235235
action execution completion as well as doing action rescheduling.
236236
In an HA deployment there must be a minimum of ``2`` replicas of st2notifier running, requiring a coordination backend,
237-
which in our case is etcd.
237+
which in our case is redis.
238238

239239
st2sensorcontainer
240240
__________________
@@ -262,7 +262,7 @@ st2actionrunner
262262
_______________
263263
Stackstorm workers that actually execute actions.
264264
``5`` replicas for K8s Deployment are configured by default to increase StackStorm ability to execute actions without excessive queuing.
265-
Relies on ``etcd`` for coordination. This is likely the first thing to lift if you have a lot of actions
265+
Relies on ``redis`` for coordination. This is likely the first thing to lift if you have a lot of actions
266266
to execute per time period in your StackStorm cluster.
267267

268268
st2scheduler
@@ -301,10 +301,10 @@ By default ``3`` nodes of RabbitMQ are deployed via K8s StatefulSet.
301301
For more advanced RabbitMQ configuration, please refer to official `rabbitmq-ha <https://github.com/helm/charts/tree/master/stable/rabbitmq-ha>`_
302302
Helm chart repository, - all settings could be overridden via ``values.yaml``.
303303

304-
etcd
305-
____
306-
StackStorm employs etcd as a distributed coordination backend, required for st2 cluster components to work properly in an HA scenario.
307-
`3` node Raft cluster is deployed via external official Helm chart dependency `stable/etcd-operator <https://github.com/helm/charts/tree/master/stable/etcd-operator>`_.
304+
redis
305+
_____
306+
StackStorm employs redis as a distributed coordination backend, required for st2 cluster components to work properly in an HA scenario.
307+
`3` node cluster with Sentinel is deployed via external official Helm chart dependency `bitnami/redis <https://github.com/bitnami/charts/tree/master/bitnami/redis>`_.
308308
As any other Helm dependency, it's possible to further configure it for specific scaling needs via ``values.yaml``.
309309

310310
Feedback Needed!

0 commit comments

Comments
 (0)