From e5c344828444c16e920544ae273a525ad5790429 Mon Sep 17 00:00:00 2001 From: Warren Van Winckel Date: Tue, 12 Mar 2019 15:04:52 -0700 Subject: [PATCH 1/3] Update st2sensorcontainer docs --- docs/source/install/k8s_ha.rst | 23 ++++++++++++++++++----- 1 file changed, 18 insertions(+), 5 deletions(-) diff --git a/docs/source/install/k8s_ha.rst b/docs/source/install/k8s_ha.rst index ebcf180c0..c838ff162 100644 --- a/docs/source/install/k8s_ha.rst +++ b/docs/source/install/k8s_ha.rst @@ -309,11 +309,24 @@ which in our case is etcd. st2sensorcontainer __________________ -st2sensorcontainer manages StackStorm sensors: starts, stops and restarts them as a subprocesses. -At the moment K8s configuration consists of Deployment with hardcoded ``1`` replica. -Future plans are to re-work this setup and benefit from Docker-friendly `single-sensor-per-container mode #4179 `_ -(since st2 ``v2.9``) as a way of :doc:`/reference/sensor_partitioning`, distributing the computing load -between many pods and relying on K8s failover/reschedule mechanisms, instead of running everything on ``1`` single instance of st2sensorcontainer. +st2sensorcontainer manages StackStorm sensors: It starts, stops and restarts them as subprocesses. +By default, deployment is configured with ``1`` replica containing all the sensors. + +st2sensorcontainer also supports a more Docker-friendly single-sensor-per-container mode as a way +of :doc:`/reference/sensor_partitioning`. This distributes the computing load between many pods and +relies on K8s failover/reschedule mechanisms, instead of running everything on a single instance of +st2sensorcontainer. The sensor(s) must be deployed as part of the custom packs image. + +As an example, override the default Helm values as follows: + +.. code-block:: yaml + st2: + packs: + sensors: + - name: github + ref: githubwebhook.GitHubWebhookSensor + - name: circleci + ref: circle_ci.CircleCIWebhookSensor st2actionrunner _______________ From e5a5867c7971ee8467d6a1269fb7f3149a9d4212 Mon Sep 17 00:00:00 2001 From: Warren Van Winckel Date: Tue, 12 Mar 2019 15:37:42 -0700 Subject: [PATCH 2/3] Remove two spaces on each line in yaml code-block --- docs/source/install/k8s_ha.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/source/install/k8s_ha.rst b/docs/source/install/k8s_ha.rst index c838ff162..ceb442872 100644 --- a/docs/source/install/k8s_ha.rst +++ b/docs/source/install/k8s_ha.rst @@ -320,13 +320,13 @@ st2sensorcontainer. The sensor(s) must be deployed as part of the custom packs i As an example, override the default Helm values as follows: .. code-block:: yaml - st2: - packs: - sensors: - - name: github - ref: githubwebhook.GitHubWebhookSensor - - name: circleci - ref: circle_ci.CircleCIWebhookSensor + st2: + packs: + sensors: + - name: github + ref: githubwebhook.GitHubWebhookSensor + - name: circleci + ref: circle_ci.CircleCIWebhookSensor st2actionrunner _______________ From d852dee83d70e8dd1e8b8565788d5d9876a22bfc Mon Sep 17 00:00:00 2001 From: Warren Van Winckel Date: Tue, 12 Mar 2019 15:53:20 -0700 Subject: [PATCH 3/3] Add newline after code-block:: --- docs/source/install/k8s_ha.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/source/install/k8s_ha.rst b/docs/source/install/k8s_ha.rst index ceb442872..e902096e0 100644 --- a/docs/source/install/k8s_ha.rst +++ b/docs/source/install/k8s_ha.rst @@ -320,6 +320,7 @@ st2sensorcontainer. The sensor(s) must be deployed as part of the custom packs i As an example, override the default Helm values as follows: .. code-block:: yaml + st2: packs: sensors: