Merge pull request #246 from cognifloyd/1sensor-cleanup

Improve one-sensor-per-pod UX: require "ref" in st2.packs.sensors

Author: cognifloyd

CHANGELOG.md

@@ -5,6 +5,7 @@
 * Allow adding custom env variables to any Deployment or Job. (#120) (by @AngryDeveloper)
 * Template the contents of st2.config and the values in st2chatops.env. This allows adding secrets defined elsewhere in values. (#249) (by @cognifloyd)
 * Set default/sample RBAC config files to "" (empty string) to prevent adding them. This is needed because they cannot be removed by overriding the roles/mappings values. (#247) (by @cognifloyd)
+* Make configuring `stackstorm/sensor-mode=all-sensors-in-one-pod` more obvious by using `st2.packs.sensors` only for `one-sensor-per-pod`. `all-sensors-in-one-pod` mode now only uses values from `st2sensorcontainer`. (#246) (by @cognifloyd)
 
 ## v0.70.0
 * New feature: Shared packs volumes `st2.packs.volumes`. Allow using cluster-specific persistent volumes to store packs, virtualenvs, and (optionally) configs. This enables using `st2 pack install`. It even works with `st2packs` images in `st2.packs.images`. (#199) (by @cognifloyd)

templates/deployments.yaml

@@ -1016,11 +1016,13 @@ spec:
       tolerations: {{- toYaml . | nindent 8 }}
     {{- end }}
 
-{{- $one_sensor_per_pod := or (gt (len $.Values.st2.packs.sensors) 1) (index $.Values.st2.packs.sensors 0 "ref") }}
-{{- range .Values.st2.packs.sensors }}
+{{- $one_sensor_per_pod := not ($.Values.st2.packs.sensors | empty) }}
+{{- range ($one_sensor_per_pod | ternary ($.Values.st2.packs.sensors) (until 1)) }}
   {{- $sensor := omit $.Values.st2sensorcontainer "name" "ref" "postStartScript" }}
-  {{- range $key, $val := . }}
-    {{- $_ := set $sensor $key $val }}
+  {{- if $one_sensor_per_pod }}
+    {{- range $key, $val := . }}
+      {{- $_ := set $sensor $key $val }}
+    {{- end }}
   {{- end }}
   {{- $name := print "st2sensorcontainer" (include "hyphenPrefix" $sensor.name) }}
 ---
@@ -1106,9 +1108,9 @@ spec:
           - --config-file=/etc/st2/st2.docker.conf
           - --config-file=/etc/st2/st2.user.conf
           - --single-sensor-mode
-          - --sensor-ref={{ $sensor.ref }}
+          - --sensor-ref={{ required "You must define `ref` for everything in st2.packs.sensors. This assigns each sensor to a pod." $sensor.ref }}
         {{- end }}
-        {{- if .env }}
+        {{- if $sensor.env }}
         env: {{- include "stackstorm-ha.customEnv" . | nindent 8 }}
         {{- end }}
         envFrom:

values.yaml

@@ -153,33 +153,24 @@ st2:
     #   (2) run one sensor per pod using st2.packs.sensors (here).
     # Each sensor node needs to be provided with proper partition information to share work with other sensor
     # nodes so that the same sensor does not run on different nodes.
-    # Defaults come from st2sensorcontainer (see below), with per-sensor overrides defined here.
-    sensors:
-      # With only one sensor listed here, we use all-sensors-in-one-pod mode, unless that sensor has a `ref`.
-      # To partition sensors with one-sensor-per-node, override st2.packs.sensors.
-      # In one-sensor-per-pod mode, make sure each sensor here has both `name` and `ref` (which sensor to run in the pod).
-      # NOTE: Do not modify this file.
-      - name:
-        livenessProbe: {}
-        readinessProbe: {}
-        annotations: {}
-        resources:
-          requests:
-            memory: "100Mi"
-            cpu: "50m"
-        # Override default image settings (for now, only tag can be overridden)
-        image: {}
-          ## Note that Helm templating is supported in this block!
-          #tag: "{{ .Values.image.tag }}"
-        # Additional advanced settings to control pod/deployment placement
-        affinity: {}
-        nodeSelector: {}
-        tolerations: []
-        env: {}
-        # HTTP_PROXY: http://proxy:1234
-        serviceAccount:
-          attach: false
-        # note: postStartScript is not valid here. Use st2sensorcontainer.postStartScript instead.
+    # When this is empty (the default), the chart adds one pod to run all sensors.
+    sensors: []
+      # This is a list of sensor pods (stackstorm/sensor-mode=one-sensor-per-pod).
+      # Each entry should have `name` (the pod name) and `ref` (which sensor to run in the pod).
+      # Each entry can also include other pod settings (annotations, image, resources, etc).
+      # These optional pod settings default to the values in st2sensorcontainer,
+      # note: postStartScript is not valid in st2.packs.sensors. Use st2sensorcontainer.postStartScript instead.
+      #
+      # This example only defines name and ref, accepting all defaults in st2sensorcontainer:
+      # - name: some-sensor-node
+      #   ref: some_pack.some_sensor
+      #
+      # This example also uses a custom image tag:
+      # - name: another-sensor-node
+      #   ref: some_pack.another_sensor
+      #   image:
+      #     tag: 3.5.0-another_sensor-r1
+
   # Import data into StackStorm's Key/Value datastore (https://docs.stackstorm.com/datastore.html)
   keyvalue:
     #- name: st2_version
@@ -560,8 +551,11 @@ st2actionrunner:
   postStartScript: ""
 
 # https://docs.stackstorm.com/reference/ha.html#st2sensorcontainer
-# Please see st2.packs.sensors for each sensor instance's config.
-# This contains default settings for all sensor pods.
+# It is possible to run st2sensorcontainer(s) in one of these modes:
+#   (1) run all sensors in one pod (1 deployment with 1 pod, the default); or
+#   (2) run one sensor per pod using st2.packs.sensors (see above).
+# To use the default mode (all sensors in one pod), st2.packs.sensors must be empty.
+# For one-sensor-per-pod, define defaults here and add config for each sensor to st2.packs.sensors (above).
 st2sensorcontainer:
   resources:
     requests: