Merge pull request #59 from helmwave/0.27.x

0.27.x

Author: r3nic1e

README.md

@@ -1,4 +1,4 @@
-# [helmwave.github.io/docs](https://helmwave.github.io/docs)
+# [docs.helmwave.app](https://docs.helmwave.app)
 
 > The helmwave's docs
 
@@ -14,9 +14,10 @@ mike serve
 
 ### Prod
 
-Done automatically via GitHub Actions. Fresh created branches will update `latest` symlink, other pushes will just trigger deploy of corresponding version.
+Done automatically via GitHub Actions.
+Fresh-created branches will update `latest` symlink, other pushes will just trigger deploy of a corresponding version.
 
-The only thing you need to update is helmwave version in:
+The only thing you need to update is `helmwave` version in:
 
 - [examples](docs/examples)
 - [docs/tpl.md](docs/tpl.md)

docs/anno.md

@@ -37,7 +37,7 @@ metadata:
 !!! danger "Kubedog can't be enabled when there are releases in multiple contexts."
 
 
-[example](examples/kubedog/README.md)
+[:material-duck: example](examples/kubedog/README.md)
 
 inspired by [werf annotations](https://werf.io/documentation/reference/deploy_annotations.html)
 

docs/ci.md

@@ -58,7 +58,7 @@ helmwave:
     expire_in: 2 week
 ```
 
-See  the [example](../examples/apps-per-ns/#cicd-with-gitlab-ci)
+See  the [:material-duck: example](../examples/apps-per-ns/#cicd-with-gitlab-ci)
 
 
 ###  Kube-Linter and Helmwave

docs/cli.md

@@ -11,7 +11,7 @@ VERSION:
    0.27.3
 
 DESCRIPTION:
-   This tool helps you compose your helm releases!
+   This tool helps you compose your :simple-helm: helm releases!
    0. $ helmwave yml
    1. $ helmwave build
    2. $ helmwave up
@@ -43,13 +43,29 @@ GLOBAL OPTIONS:
 
 ```
 
+!!! note "workflow"
+
+    ```mermaid
+    flowchart TD
+        helmwave.yml.tpl -- yml --> helmwave.yml -- build --> .helmwave/planfile
+        .helmwave/planfile --> up(up)
+        .helmwave/planfile --> down(down)
+        .helmwave/planfile --> ls(ls)
+        .helmwave/planfile --> s(status)
+        .helmwave/planfile --> r(rollback)
+        .helmwave/planfile --> g(graph)
+        .helmwave/planfile --> v(validate)
+        .helmwave/planfile --> diff(diff)
+    ```
+    *If you don't see a graph, please reload the page.*
+
 ## step 0: templating
 
 ### `yml`
 
 This command renders `helmwave.yml.tpl` to `helmwave.yml`.
 
-!!! info "Flags"
+!!! success "Flags"
 
     ```shell
     --tpl value             Main tpl file (default: "helmwave.yml.tpl") [$HELMWAVE_TPL]
@@ -86,7 +102,7 @@ You can pass `--yml` flag into [`build`](#build) command for launching [`yml`](#
     --graph-width value                                set ceil width: 1 – disable graph; 0 – full names; N>1 – show only N symbols; N<0 – drop N symbols from end. (default: 0) [$HELMWAVE_GRAPH_WIDTH]
     --skip-unchanged                                   skip unchanged releases (default: false) [$HELMWAVE_SKIP_UNCHANGED]
     --diff-mode value                                  You can set: [ live | local | none ] (default: "live") [$HELMWAVE_DIFF_MODE]
-    --charts-cache-dir value                           enable caching of helm charts in specified directory [$HELMWAVE_CHARTS_CACHE]
+    --charts-cache-dir value                           enable caching of :simple-helm: helm charts in specified directory [$HELMWAVE_CHARTS_CACHE]
     --yml                                              auto helmwave.yml.tpl --> helmwave.yml (default: false) [$HELMWAVE_AUTO_YML, $HELMWAVE_AUTO_YAML]
     --wide value                                       show line around changes (default: 5) [$HELMWAVE_DIFF_WIDE]
     --show-secret                                      show secret in diff (default: true) [$HELMWAVE_DIFF_SHOW_SECRET]
@@ -108,7 +124,7 @@ And you can also use `--yml` flag that renders `helmwave.yml.tpl` to `helmwave.y
 
 ### `up`
 
-Helmwave will install repositories and helm-releases from a plan.
+Helmwave will install repositories and :simple-helm: helm releases from a plan.
 
 !!! info "Flags"
 
@@ -119,15 +135,15 @@ Helmwave will install repositories and helm-releases from a plan.
     --kubedog-start-delay value                        delay kubedog start, don't make it too late (default: 1s) [$HELMWAVE_KUBEDOG_START_DELAY]
     --kubedog-timeout value                            timeout of kubedog multitrackers (default: 5m0s) [$HELMWAVE_KUBEDOG_TIMEOUT]
     --kubedog-log-width value                          Set kubedog max log line width (default: 140) [$HELMWAVE_KUBEDOG_LOG_WIDTH]
-    --progress                                         Enable progress logs of helm (INFO log level) (default: false) [$HELMWAVE_PROGRESS]
+    --progress                                         Enable progress logs of :simple-helm: helm (INFO log level) (default: false) [$HELMWAVE_PROGRESS]
     --parallel-limit value                             Limit amount of parallel releases (default: 0) [$HELMWAVE_PARALLEL_LIMIT]
     --plandir value, -p value                          path to plandir (default: ".helmwave/") [$HELMWAVE_PLANDIR, $HELMWAVE_PLAN]
     --tags value, -t value [ --tags value, -t value ]  build releases by tags: -t tag1 -t tag3,tag4 [$HELMWAVE_TAGS]
     --match-all-tags                                   match all provided tags (default: false) [$HELMWAVE_MATCH_ALL_TAGS]
     --graph-width value                                set ceil width: 1 – disable graph; 0 – full names; N>1 – show only N symbols; N<0 – drop N symbols from end. (default: 0) [$HELMWAVE_GRAPH_WIDTH]
     --skip-unchanged                                   skip unchanged releases (default: false) [$HELMWAVE_SKIP_UNCHANGED]
     --diff-mode value                                  You can set: [ live | local | none ] (default: "live") [$HELMWAVE_DIFF_MODE]
-    --charts-cache-dir value                           enable caching of helm charts in specified directory [$HELMWAVE_CHARTS_CACHE]
+    --charts-cache-dir value                           enable caching of :simple-helm: helm charts in specified directory [$HELMWAVE_CHARTS_CACHE]
     --yml                                              auto helmwave.yml.tpl --> helmwave.yml (default: false) [$HELMWAVE_AUTO_YML, $HELMWAVE_AUTO_YAML]
     --wide value                                       show line around changes (default: 5) [$HELMWAVE_DIFF_WIDE]
     --show-secret                                      show secret in diff (default: true) [$HELMWAVE_DIFF_SHOW_SECRET]
@@ -151,7 +167,7 @@ $ helmwave down
 
 ### `ls`
 
-Helmwave will get a list of helm-releases from a plan.
+Helmwave will get a list of :simple-helm: helm releases from a plan.
 
 ```bash
 $ helmwave ls      
@@ -169,7 +185,7 @@ $ helmwave ls
 
 ### `status`
 
-Helmwave try getting status of helm-releases from plan.
+Helmwave try getting status of :simple-helm: helm releases from a plan.
 
 ```bash
 $ helmwave status      
@@ -198,7 +214,14 @@ $ helmwave status
 
 ### `rollback`
 
-Rollback helm-releases from plan.
+Rollback :simple-helm: helm releases from a plan.
+
+!!! info "Flags"
+
+    ```shell
+    --revision value  rollback all releases to this revision (default: -1)
+    ```
+
 
 ```bash
 $ helmwave rollback      
@@ -209,10 +232,15 @@ $ helmwave rollback
 
 ### `graph`
 
-Show only graph of helm releases from plan.
+Show only :material-graph: graph of :simple-helm: helm releases from plan.
 
-You can use `--graph-width` option to set width of graph.
+!!! info "Flags"
+
+    ```shell
+    --graph-width value  set ceil width: 1 – disable graph; 0 – full names; N>1 – show only N symbols; N<0 – drop N symbols from end. (default: 0) [$HELMWAVE_GRAPH_WIDTH]
+    ```
 
+> Graph draws with [:simple-github: helmwave/asciigraph](https://github.com/helmwave/asciigraph)
 
 
 ### `validate`
@@ -225,14 +253,31 @@ Helmwave will validate plan.
 
 Diff has 2 subcommands 
 
-- `helmwave diff live` will diff with manifests in the k8s-cluster 
+- `helmwave diff live` will diff with manifests in the :simple-kubernetes: kubernetes cluster 
 - `helmwave diff plan` will diff with your another local plan.
 
----
+!!! info "Flags"
+
+    ```shell
+    --wide value   show line around changes (default: 5) [$HELMWAVE_DIFF_WIDE]
+    --show-secret  show secret in diff (default: true) [$HELMWAVE_DIFF_SHOW_SECRET]
+    --3-way-merge  show 3-way merge diff (default: false) [$HELMWAVE_DIFF_3_WAY_MERGE]
+    ```
+
+
 
 ## Logs
 
-> Logs options. Helmwave use [logrus](https://github.com/sirupsen/logrus) as internal logger.
+> Helmwave uses [:simple-github: sirupsen/logrus](https://github.com/sirupsen/logrus) as internal logger.
+
+!!! info "Flags"
+
+    ```shell
+    --log-format value  You can set: [ text | json | pad | emoji ] (default: "emoji") [$HELMWAVE_LOG_FORMAT]
+    --log-level value   You can set: [ debug | info | warn  | fatal | panic | trace ] (default: "info") [$HELMWAVE_LOG_LEVEL, $HELMWAVE_LOG_LVL]
+    --log-color         Force color (default: true) [$HELMWAVE_LOG_COLOR]
+    --log-timestamps    Add timestamps to log messages (default: false) [$HELMWAVE_LOG_TIMESTAMPS]
+    ```
 
 ### Log Format
 
@@ -253,7 +298,7 @@ Helmwave supports several log-format
 |    incompatible version    |        ❌         |   ✅    |    ✅    |    ✅    |    ✅    |    ✅    |
 |         helm-debug         |        ❌         |   ❌    |    ✅    |    ✅    |    ✅    |    ✅    |
 |        file content        |        ❌         |   ❌    |    ✅    |    ✅    |    ✅    |    ✅    |
-| helm manifests, bug report |        ❌         |   ❌    |    ❌    |    ❌    |    ❌    |    ✅    |
+| :simple-helm: helm manifests, bug report |        ❌         |   ❌    |    ❌    |    ❌    |    ❌    |    ✅    |
 
 `info` is preferred loglevel.
 
@@ -329,7 +374,7 @@ helmwave <cmd>
 
 ## schema
 
-You can generate json schema for autocomplete and validate `helmwave.yml` in your IDE.
+You can generate json schema for autocomplete and validate `helmwave.yml` in your [IDE](../ide).
 
 ```shell
 helmwave schema > helmwave.schema.json

docs/examples/hate-umbrella/README.md

@@ -9,14 +9,14 @@ Why is Umbrella chart evil?
 - Umbrella chart doesn't provide separate your environments.
 - When sub-chart is modified, you need to fix it twice.
 
-Suppose that you need to describe the next architecture.
+!!! info "Suppose that you need to describe the next architecture."
 
-```mermaid
-graph LR
-  frontend --> api --> rabbitmq & minio_s3
-  consumer --> rabbitmq & minio_s3 & postgresql
-```
-*If you don't see a graph, please reload the page.*
+    ```mermaid
+    graph LR
+      frontend --> api --> rabbitmq & minio_s3
+      consumer --> rabbitmq & minio_s3 & postgresql
+    ```
+    *If you don't see a graph, please reload the page.*
 
 Example of **helmwave.yml** for this architecture.
 

docs/examples/kubedog/README.md

@@ -35,6 +35,8 @@ We are going to use `commonAnnotations`.
 
 **Run**
 
+!!! tip "You can combine `--kubedog` and [`--progress`](../cli/#log-level)"
+
 ```shell
 helmwave up --build --kubedog
 ```

docs/examples/private-env/README.md

@@ -0,0 +1,35 @@
+# Private environment
+
+**`helmwave.yml`**
+
+```yaml
+{% include "helmwave.yml" %}
+```
+
+**Disable diff**
+
+You can also use `local`
+
+```shell
+export HELMWAVE_DIFF_MODE=none
+```
+
+**build a plan**
+
+you can also use `--charts-cache-dir`.
+
+```shell
+helmwave build
+```
+
+**upload plan to private environment**
+
+```shell
+whatever you want
+```
+
+**on the private environment**
+
+```shell
+helmwave up
+```

docs/examples/private-env/helmwave.yml

@@ -0,0 +1,11 @@
+repositories:
+  - name: jetstack
+    url: https://charts.jetstack.io
+
+releases:
+  - name: cert-manager
+    chart:
+      name: jetstack/cert-manager
+      version: v1.12.1
+    offline_kube_version: 1.22.2
+    namespace: cert-manager

docs/examples/private-gitlab-repo/README.md

@@ -1,6 +1,6 @@
 # Private GitLab repo 
 
-Learn more about GitLab Helm Registry [here](https://docs.gitlab.com/ee/user/packages/helm_repository/)
+Learn more about GitLab :simple-helm: helm Registry [here](https://docs.gitlab.com/ee/user/packages/helm_repository/)
 
 ```shell
 .

docs/examples/quick-start/README.md

@@ -2,10 +2,10 @@
 
 <script async id="asciicast-591181" src="https://asciinema.org/a/591181.js"></script>
 
-1. **[Install helmwave](../../install)** 
+1. **[📥 Install helmwave](../../install)** 
 2. **Create `helmwave.yml`**
 
-    Suppose the `helmwave.yml` representing the desired state of your helm releases looks like:
+    Suppose the `helmwave.yml` representing the desired state of your :simple-helm: helm releases looks like:
 
     ```yaml
     {% include "helmwave.yml" %}
@@ -35,10 +35,10 @@
     [🙃 aka INFO]: Success 2 / 2
     ```
 
-5. **Check**
+5. **Check ✔️**
 
     ```shell
-    $ helm list -n my-namespace
+    $ :simple-helm: helm list -n my-namespace
     NAME    NAMESPACE       REVISION        UPDATED                                 STATUS          CHART           APP VERSION
     a       my-namespace    1               2023-06-13 16:25:42.446056 +0400 +04    deployed        nats-7.8.3      2.9.17     
     b       my-namespace    1               2023-06-13 16:25:42.444662 +0400 +04    deployed        nats-7.8.3      2.9.17
@@ -49,4 +49,4 @@
     b-nats-0   1/1     Running   0          36s
     ```
 
-6. **Congratulations!**
+6. **Congratulations! 🥳**

docs/examples/values-delimiter-flags/README.md

@@ -1,6 +1,6 @@
 # Delimiter flags for values
 
-Sometimes we need to include strings in values that will be templated by helm itself (via `tpl` function). In this case we can change helmwave delimiters, so it won't render foreign expressions.
+Sometimes we need to include strings in values that will be templated by :simple-helm: helm itself (via `tpl` function). In this case we can change helmwave delimiters, so it won't render foreign expressions.
 
 `cat values.yml`