doc: document balloons groupBy option

Signed-off-by: Antti Kervinen <[email protected]>
containers · Mar 6, 2024 · 66d7c54 · 66d7c54
1 parent c7d2f5f
commit 66d7c54
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/docs/resource-policy/policy/balloons.md b/docs/resource-policy/policy/balloons.md
@@ -121,6 +121,11 @@ Balloons policy parameters:
   - `namespaces` is a list of namespaces (wildcards allowed) whose
     pods should be assigned to this balloon type, unless overridden by
     pod annotations.
+  - `groupBy` groups containers into same balloon instances if
+    their GroupBy expressions evaluate to the same group.
+    Expressions are strings where key references like
+    `${pod/labels/mylabel}` will be substituted with corresponding
+    values.
   - `matchExpressions` is a list of container match expressions. These
     expressions are evaluated for all containers which have not been
     assigned otherwise to other balloons. If an expression matches,