Skip to content

Commit

Permalink
Merge pull request #95 from needleshaped/main
Browse files Browse the repository at this point in the history
UX: cover common use case of building plan offline. FIX: --diff-mode parameters
  • Loading branch information
zhilyaev authored Oct 31, 2024
2 parents e8da87d + 2650024 commit 36d9370
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 3 deletions.
2 changes: 2 additions & 0 deletions docs/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 4 additions & 2 deletions docs/flags/diff-mode.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
2 changes: 1 addition & 1 deletion docs/yaml.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down

0 comments on commit 36d9370

Please sign in to comment.