Update documentation

kapicorp · Jan 27, 2024 · 743f60d · 743f60d
1 parent 83c413f
commit 743f60d
Show file tree

Hide file tree

Showing 2 changed files with 41 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
@@ -61,3 +61,24 @@ which would be equivalent to always running:
 ```shell
 kapitan inventory --inventory-path=./some_path
 ```
+
+Please note that the configurations in top-level key `inventory` only have an effect when running `kapitan inventory`. If you want this configuration to also apply to other commands that take `--inventory-path` you also need to set the key in those sections in the config file.
+
+### inventory\_backend
+
+You may want to permanently select a non-default inventory backend. You can configure the inventory backend to use in the `inventory-backend` section of the **Kapitan** dotfile.
+
+```yaml
+inventory_backend:
+  inventory: reclass
+```
+
+which would be equivalent to always running
+
+```shell
+kapitan inventory --inventory-backend=reclass
+```
+
+Note that this configuration field applies to all commands that take `--inventory-backend`.
+
+Without any custom configuration, **Kapitan** will use [reclass](https://github.com/kapicorp/reclass) as the inventory backend.