Skip to content

Commit f4f9553

Browse files
authored
UX: cover common use case of building plan offline. FIX: --diff-mode parameters
1 parent e8da87d commit f4f9553

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

docs/cli.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,8 @@ This command renders `helmwave.yml.tpl` to `helmwave.yml`.
4040

4141
Helmwave builds plan in complete plan directory (`.helmwave` by default) that other commands use.
4242

43+
Build process by default includes check against manifests of specific :simple-kubernetes: Kubernetes version (taken online), as well as diff. To build plan offline, combine `--diff-mode=local` or `--diff-mode=none` with [`offline_kube_version`](yaml/#offline_kube_version).
44+
4345
A plan includes:
4446

4547
- Downloaded remote charts

docs/flags/diff-mode.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,10 @@
33
> Introduced in [:material-tag: v0.12.0](https://github.com/helmwave/helmwave/releases/tag/v0.12.0)
44
55

6-
- `live` - diff with live cluster
7-
- `plan` - diff with local plan
6+
- `live` - diff with live :simple-kubernetes: cluster
7+
- `local` - diff with local plan
88
- `none` - disable diff
99

10+
Combine `--diff-mode=local` or `--diff-mode=none` with `offline_kube_version` to build a plan without kubernetes.
11+
1012
![diff example](assets/diff.png)

0 commit comments

Comments
 (0)