rabbit: add rabbit.mapping key to rabbit config

Problem: there is no documentation for the rabbit.mapping config key. Add it.
flux-framework · Jan 25, 2025 · e360b88 · e360b88
1 parent ade1abc
commit e360b88
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/tutorials/lab/rabbit_config.rst b/tutorials/lab/rabbit_config.rst
@@ -56,6 +56,10 @@ The ``rabbit`` config table captures site-general policies and options for
 Flux's interactions with the rabbits.
 
 
+**mapping** (string)
+  (required) Path to rabbitmapping file for the cluster, as generated by
+  `flux rabbitmapping`.
+
 **kubeconfig** (string)
   (optional) Path to kubeconfig file for Flux to use, ideally with restricted permissions.
   This can be left undefined if the file is placed at the path `~flux/.kube/config`