From f4f95537ceaa3325e603b24df4a8b9cdd492a230 Mon Sep 17 00:00:00 2001 From: Aleksejs Spiridonovs Date: Tue, 29 Oct 2024 16:32:56 +0200 Subject: [PATCH 1/3] UX: cover common use case of building plan offline. FIX: --diff-mode parameters --- docs/cli.md | 2 ++ docs/flags/diff-mode.md | 6 ++++-- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/cli.md b/docs/cli.md index 11e26cd8..b92b576d 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 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). + A plan includes: - Downloaded remote charts diff --git a/docs/flags/diff-mode.md b/docs/flags/diff-mode.md index 0facb89a..e482a7b7 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` to build a plan without kubernetes. + ![diff example](assets/diff.png) From c6c9717675411cf698233aac506c3c7edc053832 Mon Sep 17 00:00:00 2001 From: Aleksejs Spiridonovs Date: Tue, 29 Oct 2024 16:42:06 +0200 Subject: [PATCH 2/3] UX: add cross-links --- docs/cli.md | 2 +- docs/flags/diff-mode.md | 2 +- docs/yaml.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/cli.md b/docs/cli.md index b92b576d..bac58e22 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -40,7 +40,7 @@ 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 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). +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`](cli/#-diff-mode) or `--diff-mode=none` with [`offline_kube_version`](yaml/#offline_kube_version). A plan includes: diff --git a/docs/flags/diff-mode.md b/docs/flags/diff-mode.md index e482a7b7..6c698ea2 100644 --- a/docs/flags/diff-mode.md +++ b/docs/flags/diff-mode.md @@ -7,6 +7,6 @@ - `local` - diff with local plan - `none` - disable diff -Combine `--diff-mode=local` or `--diff-mode=none` with `offline_kube_version` to build a plan without kubernetes. +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) From 265002482d44e44b08672f0b818d2edc7d839478 Mon Sep 17 00:00:00 2001 From: Aleksejs Spiridonovs Date: Tue, 29 Oct 2024 17:28:29 +0200 Subject: [PATCH 3/3] DOC: proper term: schema validation --- docs/cli.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/cli.md b/docs/cli.md index bac58e22..a18ccbd7 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -40,7 +40,7 @@ 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 check against manifests of 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). +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: