Update documentation

kapicorp · Jan 30, 2024 · 0c13d11 · 0c13d11
1 parent bdef3e3
commit 0c13d11
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 16 deletions.
diff --git a/docs/pages/commands/kapitan_compile.md b/docs/pages/commands/kapitan_compile.md
@@ -148,24 +148,28 @@ The `--embed-refs` flags tells **Kapitan** to embed these references on compile,
     ```
 
     ??? example "click to expand output"
+
         ```shell
-        usage: kapitan compile [-h] [--search-paths JPATH [JPATH ...]]
-                              [--jinja2-filters FPATH] [--verbose] [--prune]
-                              [--quiet] [--output-path PATH] [--fetch]
-                              [--force-fetch] [--force] [--validate]
-                              [--parallelism INT] [--indent INT]
-                              [--refs-path REFS_PATH] [--reveal] [--embed-refs]
-                              [--inventory-path INVENTORY_PATH] [--cache]
-                              [--cache-paths PATH [PATH ...]]
-                              [--ignore-version-check] [--use-go-jsonnet]
-                              [--compose-node-name] [--schemas-path SCHEMAS_PATH]
-                              [--yaml-multiline-string-style STYLE]
-                              [--yaml-dump-null-as-empty]
-                              [--targets TARGET [TARGET ...] | --labels
-                              [key=value ...]]
-
-        optional arguments:
+        usage: kapitan compile [-h] [--inventory-backend {reclass}]
+                       [--search-paths JPATH [JPATH ...]]
+                       [--jinja2-filters FPATH] [--verbose] [--prune]
+                       [--quiet] [--output-path PATH] [--fetch]
+                       [--force-fetch] [--force] [--validate]
+                       [--parallelism INT] [--indent INT]
+                       [--refs-path REFS_PATH] [--reveal] [--embed-refs]
+                       [--inventory-path INVENTORY_PATH] [--cache]
+                       [--cache-paths PATH [PATH ...]]
+                       [--ignore-version-check] [--use-go-jsonnet]
+                       [--compose-node-name] [--schemas-path SCHEMAS_PATH]
+                       [--yaml-multiline-string-style STYLE]
+                       [--yaml-dump-null-as-empty]
+                       [--targets TARGET [TARGET ...] | --labels
+                       [key=value ...]]
+
+        options:
           -h, --help            show this help message and exit
+          --inventory-backend {reclass}
+                                Select the inventory backend to use (default=reclass)
           --search-paths JPATH [JPATH ...], -J JPATH [JPATH ...]
                                 set search paths, default is ["."]
           --jinja2-filters FPATH, -J2F FPATH

diff --git a/docs/pages/commands/kapitan_dotfile.md b/docs/pages/commands/kapitan_dotfile.md
@@ -58,3 +58,14 @@ global:
 ```
 
 which would be equivalent to running any command with `--inventory-path=./some_path`.
+
+Another flag that you may want to set in the `global` section is `inventory-backend` to select a non-default inventory backend implementation.
+
+```yaml
+global:
+  inventory-backend: reclass
+```
+
+which would be equivalent to always running **Kapitan** with `--inventory-backend=reclass`.
+
+Please note that the `inventory-backend` flag currently can't be set through the command-specific sections of the **Kapitan** config file.