Skip to content

Update st2sensorcontainer docs #865

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Mar 18, 2019
Merged

Update st2sensorcontainer docs #865

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e5c3448
Update st2sensorcontainer docs
warrenvw Mar 12, 2019
e5a5867
Remove two spaces on each line in yaml code-block
warrenvw Mar 12, 2019
d852dee
Add newline after code-block::
warrenvw Mar 12, 2019
8192b11
Merge branch 'master' into st2sensorcontainer
warrenvw Mar 13, 2019
8db7afe
Merge branch 'master' into st2sensorcontainer
LindsayHill Mar 13, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 19 additions & 5 deletions docs/source/install/k8s_ha.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -309,11 +309,25 @@ 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 <https://github.com/StackStorm/st2/pull/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
_______________
Expand Down