Skip to content

Commit 743f60d

Browse files
committed
Update documentation
1 parent 83c413f commit 743f60d

File tree

2 files changed

+41
-16
lines changed

2 files changed

+41
-16
lines changed

docs/pages/commands/kapitan_compile.md

Lines changed: 20 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -148,24 +148,28 @@ The `--embed-refs` flags tells **Kapitan** to embed these references on compile,
148148
```
149149

150150
??? example "click to expand output"
151+
151152
```shell
152-
usage: kapitan compile [-h] [--search-paths JPATH [JPATH ...]]
153-
[--jinja2-filters FPATH] [--verbose] [--prune]
154-
[--quiet] [--output-path PATH] [--fetch]
155-
[--force-fetch] [--force] [--validate]
156-
[--parallelism INT] [--indent INT]
157-
[--refs-path REFS_PATH] [--reveal] [--embed-refs]
158-
[--inventory-path INVENTORY_PATH] [--cache]
159-
[--cache-paths PATH [PATH ...]]
160-
[--ignore-version-check] [--use-go-jsonnet]
161-
[--compose-node-name] [--schemas-path SCHEMAS_PATH]
162-
[--yaml-multiline-string-style STYLE]
163-
[--yaml-dump-null-as-empty]
164-
[--targets TARGET [TARGET ...] | --labels
165-
[key=value ...]]
166-
167-
optional arguments:
153+
usage: kapitan compile [-h] [--inventory-backend {reclass}]
154+
[--search-paths JPATH [JPATH ...]]
155+
[--jinja2-filters FPATH] [--verbose] [--prune]
156+
[--quiet] [--output-path PATH] [--fetch]
157+
[--force-fetch] [--force] [--validate]
158+
[--parallelism INT] [--indent INT]
159+
[--refs-path REFS_PATH] [--reveal] [--embed-refs]
160+
[--inventory-path INVENTORY_PATH] [--cache]
161+
[--cache-paths PATH [PATH ...]]
162+
[--ignore-version-check] [--use-go-jsonnet]
163+
[--compose-node-name] [--schemas-path SCHEMAS_PATH]
164+
[--yaml-multiline-string-style STYLE]
165+
[--yaml-dump-null-as-empty]
166+
[--targets TARGET [TARGET ...] | --labels
167+
[key=value ...]]
168+
169+
options:
168170
-h, --help show this help message and exit
171+
--inventory-backend {reclass}
172+
Select the inventory backend to use (default=reclass)
169173
--search-paths JPATH [JPATH ...], -J JPATH [JPATH ...]
170174
set search paths, default is ["."]
171175
--jinja2-filters FPATH, -J2F FPATH

docs/pages/commands/kapitan_dotfile.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,3 +61,24 @@ which would be equivalent to always running:
6161
```shell
6262
kapitan inventory --inventory-path=./some_path
6363
```
64+
65+
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.
66+
67+
### inventory\_backend
68+
69+
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.
70+
71+
```yaml
72+
inventory_backend:
73+
inventory: reclass
74+
```
75+
76+
which would be equivalent to always running
77+
78+
```shell
79+
kapitan inventory --inventory-backend=reclass
80+
```
81+
82+
Note that this configuration field applies to all commands that take `--inventory-backend`.
83+
84+
Without any custom configuration, **Kapitan** will use [reclass](https://github.com/kapicorp/reclass) as the inventory backend.

0 commit comments

Comments
 (0)