Document additional_facts parameter

projectsyn · Nov 14, 2023 · de824ca · de824ca
1 parent 2ae1243
commit de824ca
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/docs/modules/ROOT/pages/references/parameters.adoc b/docs/modules/ROOT/pages/references/parameters.adoc
@@ -57,6 +57,25 @@ defaults:: https://github.com/projectsyn/component-steward/blob/master/class/def
 
 The Steward and ArgoCD container image versions which the component should use.
 
+== `additional_facts`
+
+[horizontal]
+type:: dict
+default:: `{}`
+example::
++
+[source,yaml]
+----
+additional_facts:
+  myIdFromHierarchy: mx7bMF3VIfVpGhMZDnoW65oG08Wv9ICYXetH5DNM
+  glusterVersion:
+    major: 11
+    minor: 1
+----
+
+Additional facts to be added to the dynamic facts Steward provides to Lieutenant.
+Objects are serialized to JSON.
+
 == Example
 
 [source,yaml]