diff --git a/docs/cli.md b/docs/cli.md index 11e26cd8..a18ccbd7 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -40,6 +40,8 @@ This command renders `helmwave.yml.tpl` to `helmwave.yml`. Helmwave builds plan in complete plan directory (`.helmwave` by default) that other commands use. +Build process by default includes schema validation against specific :simple-kubernetes: Kubernetes version (taken online), as well as diff. To build plan offline, combine [`--diff-mode=local`](cli/#-diff-mode) or `--diff-mode=none` with [`offline_kube_version`](yaml/#offline_kube_version). + A plan includes: - Downloaded remote charts diff --git a/docs/flags/diff-mode.md b/docs/flags/diff-mode.md index 0facb89a..6c698ea2 100644 --- a/docs/flags/diff-mode.md +++ b/docs/flags/diff-mode.md @@ -3,8 +3,10 @@ > Introduced in [:material-tag: v0.12.0](https://github.com/helmwave/helmwave/releases/tag/v0.12.0) -- `live` - diff with live cluster -- `plan` - diff with local plan +- `live` - diff with live :simple-kubernetes: cluster +- `local` - diff with local plan - `none` - disable diff +Combine `--diff-mode=local` or `--diff-mode=none` with [`offline_kube_version`](yaml/#offline_kube_version) to build a plan without kubernetes. + ![diff example](assets/diff.png) diff --git a/docs/yaml.md b/docs/yaml.md index 35be80f2..6146d191 100644 --- a/docs/yaml.md +++ b/docs/yaml.md @@ -591,7 +591,7 @@ If `offline_kube_version` set helmwave will use this version to build plan. Without this option, helmwave will ask :simple-kubernetes: kubernetes for a version. It is very useful if you want to build a plan without access to a cluster. -Combine `offline_kube_version` and `--diff-mode=local` or `--diff-mode=none` to build a plan without kubernetes. +Combine `offline_kube_version` and [`--diff-mode=local`](cli/#-diff-mode) or `--diff-mode=none` to build a plan without kubernetes. [:material-duck: example](examples/private-env/README.md)