Merge pull request #58 from helmwave/0.27.x

0.27.x

Author: zhilyaev

.gitignore

@@ -31,3 +31,4 @@ Temporary Items
 
 .idea/
 site/
+**/.helmwave/

docs/anno.md

@@ -34,18 +34,13 @@ metadata:
 
 ## [kubedog's annotations](https://github.com/werf/kubedog) 🐶
 
-> Kubedog will track all your resources by default.
+!!! danger "Kubedog can't be enabled when there are releases in multiple contexts."
+
 
 [example](examples/kubedog/README.md)
 
 inspired by [werf annotations](https://werf.io/documentation/reference/deploy_annotations.html)
 
-> First step you need enable kubedog for helmwave.
->
->  ```shell
->  export HELMWAVE_KUBEDOG_ENABLED=true
->  ```
-
 ---
 
 ### `helmwave.dev/track-termination-mode`

docs/assets/yaml-schema-idea-bar.png

@@ -8,7 +8,7 @@ Let's see how we can get it working on popular CI software.
 
 ## :material-github: GitHub action
 
-- [official github action](https://github.com/marketplace/actions/helmwave-installer)
+You can use [official github action](https://github.com/marketplace/actions/helmwave-installer)
 
 ```yaml
 name: Deploy
@@ -24,7 +24,7 @@ jobs:
       - uses: helmwave/[email protected]
         name: Install helmwave
         with:
-          version: '0.27.2'
+          version: '0.27.3'
       - name: templating helmwave.yml.tpl  
         run: helmwave yml
       - name: plan
@@ -44,12 +44,12 @@ helmwave:
   environment:
     name: "ref/$CI_COMMIT_REF_SLUG"
   image:
-    name: diamon/helmwave:0.27.2
+    name: diamon/helmwave:0.27.3
     entrypoint: [""]
   before_script:
     - printenv | grep HELMWAVE
   script:
-    - helmwave yml # if it needs
+    - helmwave yml
     - helmwave build
     - helmwave up
   artifacts:
@@ -81,7 +81,7 @@ variables:
   after_script:
     - ls -la $HELMWAVE_PLAN
   image:
-    name: ghcr.io/helmwave/helmwave:0.27.2
+    name: ghcr.io/helmwave/helmwave:0.27.3
     entrypoint: [ '' ]
 
 ###############  BUILD  ################

docs/assets/yaml-schema-idea-file.png

@@ -7,7 +7,7 @@ deploy to prod:
   environment:
     name: prod
   image:
-    name: ghcr.io/helmwave/helmwave:0.17.2
+    name: ghcr.io/helmwave/helmwave:0.27.3
     entrypoint: [""]
   before_script:
   - printenv | grep HELMWAVE

docs/assets/yaml-schema-idea.png

@@ -6,7 +6,7 @@ If you want to install each application in your own namespace.
 
 **Project structure**
 
-```console
+```shell
 ├── README.md
 ├── helmwave.yml.tpl
 ├── values

docs/assets/yaml-schema-vscode.png

@@ -1,4 +1,4 @@
-version: 0.27.2
+version: 0.27.3
 
 repositories:
   - name: bitnami

docs/ci.md

@@ -1,4 +1,4 @@
-version: 0.27.2
+version: 0.27.3
 
 
 repositories:

docs/cli.md

@@ -1,15 +1,30 @@
 # Release object
 
+> This an example is demonstrating how to use the `release` object.
+
 **Project Structure**
 
-```console
+```shell
 .
 ├── README.md
 ├── _.yml
 └── helmwave.yml
 
 ```
 
+**Create `helmwave.yml`**
+
+```yaml
+{% include "helmwave.yml" %}
+```
+
+
+**Create `_.yml`**
+
+```yaml
+{% include "_.yml" %}
+```
+
 **Run build**
 
 ```shell

docs/examples/apps-per-ns/.gitlab-ci.yml

@@ -4,15 +4,13 @@ repositories:
 
 releases:
 - name: a
-  chart:
-    name: bitnami/nginx
+  chart: bitnami/nginx
   namespace: test
   values:
   - _.yml
 
 - name: b
-  chart:
-    name: bitnami/nginx
+  chart: bitnami/nginx
   namespace: test
   values:
     - _.yml

docs/examples/apps-per-ns/README.md

@@ -1,23 +1,24 @@
-# Umbrella chart is evil
+# ☂️ Umbrella chart is evil
 
 > Helmwave is only what you actually need.
 
-Why Umbrella chart is evil?
+Why is Umbrella chart evil?
 
 - You must keep extra chart.
 - You have new layer for conventional values.
 - Umbrella chart doesn't provide separate your environments.
-- When sub-chart modified you need fix it twice.
+- When sub-chart is modified, you need to fix it twice.
 
-Suppose that you need to describe next architecture.
+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.*
 
-**helmwave.yml**
+Example of **helmwave.yml** for this architecture.
 
 ```yaml
 {% include "helmwave.yml" %}

docs/examples/apps-per-ns/helmwave.yml

@@ -1,4 +1,4 @@
-version: 0.27.2
+version: 0.27.3
 
 repositories:
   - name: bitnami

docs/examples/apps-per-ns/helmwave.yml.tpl

@@ -1,6 +1,13 @@
-# Kubedog
+# 🐶 Kubedog
 
-[full documentation](../../anno/#kubedogs)
+!!! info "The first thing you need to do is turn on `kubedog`"
+
+    ```shell
+    export HELMWAVE_KUBEDOG_ENABLED=true
+    ```
+
+Kubedog will track all your resources by default.
+For more information, see the [annotation's documentation](../../anno/#kubedogs).
 
 **Project Structure**
 
@@ -28,18 +35,18 @@ We are going to use `commonAnnotations`.
 
 **Run**
 
-```console
+```shell
 helmwave up --build --kubedog
 ```
 
 or 
 
-```console
+```shell
 export HELMWAVE_KUBEDOG_ENABLED=true
 export HELMWAVE_AUTO_BUILD=true
 helmwave up
 ```
 
-Log with helmwave v0.27.2
+**Output**
 
 ![img.png](img.png)

docs/examples/built-in-release/README.md

@@ -1,4 +1,4 @@
-version: 0.27.2
+version: 0.27.3
 
 repositories:
   - name: bitnami
@@ -13,3 +13,5 @@ releases:
       - values.yml
     namespace: my-redis
     create_namespace: true
+    wait: true
+    timeout: 3m

docs/examples/built-in-release/helmwave.yml

@@ -2,7 +2,7 @@
 
 Just add `oci://` to your chart name and define a registry.
 
-`cat helmwave.yml`
+**`cat helmwave.yml`**
 
 ```yaml
 {% include "helmwave.yml" %}

docs/examples/hate-umbrella/README.md

@@ -1,4 +1,4 @@
-version: 0.24.4
+version: 0.27.3
 
 registries:
   - host: localhost:5000
@@ -9,4 +9,4 @@ releases:
   - name: my
     chart:
       name: oci://localhost:5000/my-chart
-      version: 0.2.0 # prefer
+      version: 0.2.0 # best practice

docs/examples/hate-umbrella/helmwave.yml

@@ -1,6 +1,6 @@
 # OCI public
 
-This example demonstrate how to use public repositories with ghcr.io
+This example demonstrates how to use public repositories with `ghcr.io`
 
 `cat helmwave.yml`
 

docs/examples/kubedog/README.md

@@ -1,4 +1,4 @@
-version: 0.24.4
+version: 0.27.3
 
 registries:
   - host: ghcr.io
@@ -7,4 +7,4 @@ releases:
   - name: my
     chart:
       name: oci://ghcr.io/helmwave/unit-test-oci
-      version: 0.1.0 # prefer
+      version: 0.1.0 # best practice

docs/examples/kubedog/helmwave.yml

@@ -38,7 +38,7 @@ Suppose that `CI_COMMIT_SHORT_SHA` contains commit short sha hash.
 
 **Run**
 
-```console
+```shell
 helmwave build
 helmwave up
 ```

docs/examples/oci-private/README.md

@@ -1,4 +1,4 @@
-version: 0.27.2
+version: 0.27.3
 
 repositories:
   - name: bitnami

docs/examples/oci-private/helmwave.yml

@@ -42,7 +42,7 @@ This values will override default values
 
 **Run**
 
-```console
+```shell
 helmwave build
 helmwave up
 ```

docs/examples/oci-public/README.md

@@ -1,4 +1,4 @@
-version: 0.27.2
+version: 0.27.3
 
 releases:
   - name: my-release

docs/examples/oci-public/helmwave.yml

@@ -1,6 +1,6 @@
 # Private GitHub repo 
 
-```console
+```shell
 .
 ├── README.md
 ├── helmwave.yml

docs/examples/pass-git-commit/README.md

@@ -1,12 +1,13 @@
-version: 0.27.2
+version: 0.27.3
 
 repositories:
   - name: your-private-git-repo-hosted-charts
-    url: https://[email protected]/foo/bar/master/
+    url: https://[email protected]/foo/bar/main/
 
 .options: &options
   namespace: ips
   create_namespace: true
+  wait: true
 
 releases:
   - name: hello

docs/examples/pass-git-commit/helmwave.yml

@@ -1,13 +1,14 @@
-version: 0.27.2
+version: 0.27.3
 
 repositories:
   - name: your-private-git-repo-hosted-charts
-    url: https://{{ requiredEnv "GITHUB_TOKEN"}}@raw.githubusercontent.com/foo/bar/master/
+    url: https://{{ requiredEnv "GITHUB_TOKEN"}}@raw.githubusercontent.com/foo/bar/main/
 
 
 .options: &options
   namespace: {{ requiredEnv "NS" }}
   create_namespace: true
+  wait: true
 
 
 releases:

docs/examples/pass-git-tag/README.md

@@ -1,8 +1,8 @@
 # Private GitLab repo 
 
-Learn more about GitLab Helm Registry: https://docs.gitlab.com/ee/user/packages/helm_repository/
+Learn more about GitLab Helm Registry [here](https://docs.gitlab.com/ee/user/packages/helm_repository/)
 
-```console
+```shell
 .
 ├── README.md
 └── helmwave.yml.tpl
@@ -20,7 +20,7 @@ Your `.gitlab-ci.yml`
 helmwave:
   stage: deploy
   image:
-    name: ghcr.io/helmwave/helmwave:0.27.2
+    name: ghcr.io/helmwave/helmwave:0.27.3
     entrypoint: [""]
   before_script:
   - printenv | grep HELMWAVE

docs/examples/pass-git-tag/helmwave.yml

@@ -1,4 +1,4 @@
-version: 0.27.2
+version: 0.27.3
 
 repositories:
   # Docs: https://docs.gitlab.com/ee/user/packages/helm_repository/