Skip to content

Commit

Permalink
Merge branch 'dev' into nexenio/refactor-refs-cmd-parser
Browse files Browse the repository at this point in the history
  • Loading branch information
MatteoVoges authored Jul 31, 2023
2 parents d8574d4 + 342f48b commit 0cb0af5
Show file tree
Hide file tree
Showing 48 changed files with 2,053 additions and 843 deletions.
3 changes: 2 additions & 1 deletion .gitmodules
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
[submodule "kapitan/reclass"]
path = kapitan/reclass
url = https://github.com/kapicorp/reclass.git
url = https://github.com/neXenio/reclass.git
branch = merged-features
7 changes: 7 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -57,3 +57,10 @@ local_serve_documentation:
mkdocs_gh_deploy: # to run locally assuming git ssh access
docker build -f Dockerfile.docs --no-cache -t kapitan-docs .
docker run --rm -it -v $(PWD):/src -v ~/.ssh:/root/.ssh -w /src kapitan-docs gh-deploy -f ./mkdocs.yml

pull_oc:
rm -rf omegaconf
git clone --branch 1080-add-list-deep-merging https://github.com/nexenio/omegaconf.git oc
pip install -r oc/requirements/dev.txt -e oc/
mv oc/omegaconf .
rm -rf oc
30 changes: 16 additions & 14 deletions docs/pages/commands/kapitan_compile.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,34 +72,34 @@ Compiles one or more targets selected matching **labels** with `--labels` or `-

see [**Labels**](/inventory/#target-labels) for more details

```shell
$ kapitan compile -l customer=acme
Compiled acme-project (0.14s)
Compiled acme-pipelines (0.10s)
```
```shell
$ kapitan compile -l customer=acme
Compiled acme-project (0.14s)
Compiled acme-pipelines (0.10s)
```

## Fetch on compile

Use the `--fetch` flag to fetch [**Remote Inventories**](/inventory/#remote-inventories) and the [**External Dependencies**](/external_dependencies/).

```shell
kapitan compile --fetch
```
```shell
kapitan compile --fetch
```

This will download the dependencies according to their configurations
By default, kapitan does not overwrite an existing item with the same name as that of the fetched inventory items.

Use the `--force-fetch` flag to force fetch (update cache with freshly fetched items) and overwrite inventory items of the same name in the `output_path`.

```shell
kapitan compile --force-fetch
```
```shell
kapitan compile --force-fetch
```

Use the `--cache` flag to cache the fetched items in the `.dependency_cache` directory in the root project directory.

```shell
kapitan compile --cache --fetch
```
```shell
kapitan compile --cache --fetch
```

## Embed references

Expand Down Expand Up @@ -209,6 +209,8 @@ The `--embed-refs` flags tells **Kapitan** to embed these references on compile,
--yaml-dump-null-as-empty
dumps all none-type entries as empty, default is
dumping as 'null'
--helm-refs enable kapitan ref engine on helm refs
--helm-refs-base64 encode .data key with base64 afterwards
--targets TARGET [TARGET ...], -t TARGET [TARGET ...]
targets to compile, default is all
--labels [key=value ...], -l [key=value ...]
Expand Down
Loading

0 comments on commit 0cb0af5

Please sign in to comment.