git.iko.soy/typeable/octopod
on master help sign in
Updated helm deployment guide (#119)

* first draft * update helm deployment guide and screenshots * fix linter errors * Compressed images * add note about chart version parameter * update octopod in octopod screenshot Co-authored-by: iko <ilyakooo0@gmail.com>

commita873765e4e5581993418d966c4e3b470a3af25d2 authorAlex-Sizov <45825279+Alex-Sizov@users.noreply.github.com> dateFri 1 Oct 2021, 17:33 (5 years ago) parent5480a1b
9 files changed+17−20
docs/en/Helm-based_deployment_guide.md+17−20 docs/images/dev2.png docs/images/octopod_app_keys_list.png docs/images/octopod_archive.png docs/images/octopod_blank.png docs/images/octopod_deployment_blank.png docs/images/octopod_deployment_filled.png docs/images/octopod_in_octopod_deployment.png docs/images/wordpress_blank.png
docs/en/Helm-based_deployment_guide.md+17−20
@@ -21,24 +21,21 @@ Click on the _New Deployment_ button:
2121
2222### The config
2323
24−Here you can fill your deployment parameters. Let's have it filled up!
24+As you can see we filled some parameters for you ― it's very convinient, because you don't want fill URL to your private helm repo over and over again, right?
2525
26−![](../images/octopod_deployment_filled.png)
27−
28−**Name** ― we've chosen `wordpress`, but you can choose whatever name you like.
26+All these parameters can be modified at the chart level, [here](../../charts/octopod/values.yaml#L90) is an example. Or you can, of course, override them manually from the Octopod UI.
2927
30−**Tag** ― `5.8.0`. We took the tag name from [chart parameters](https://github.com/bitnami/charts/blob/master/bitnami/wordpress/Chart.yaml#L4)
28+One thing is left to fill, though.
3129
32−**App Overrides:**
30+![](../images/octopod_deployment_filled.png)
3331
32+**Name** ― we've chosen `wordpress`, but you can choose whatever name you like.
3433
35−| Key | Value |
36−| -----------------: | ------------------ |
37−| `ingress.enabled` | `true` |
38−| `ingress.hostname` | `wordpress.lvh.me` |
34+Octopod loads all overrides from the [chart values](https://github.com/bitnami/charts/blob/master/bitnami/wordpress/values.yaml) dynamically for each chart you want to deploy.
3935
36+Try to add new App override to see list of available keys for the wordpress chart.
4037
41−We took these overrides from the [chart documentation](https://github.com/bitnami/charts/tree/master/bitnami/wordpress#traffic-exposure-parameters). Basically you can tweak any parameters from there.
38+![](../images/octopod_app_keys_list.png)
4239
4340### Deploy
4441
@@ -52,9 +49,7 @@ So here you have it, your first Octopod deployment!
5249
5350## Going further
5451
55−Right now you may be wondering, how did Octopod take wordpress from the bitnami repository when we haven't filled any repo information whatsoever? This is because we've set this up on the chart level [here](../../charts/octopod/values.yaml#L90).
56−
57−You can override all of this using deployment overrides. Let's dive right in!
52+As we can said earlier you can override all default parameters using Octopod UI. Let's dive right in!
5853
5954First, let's archive our wordpress deployment:
6055
@@ -68,8 +63,6 @@ And create one more deployment, this time using a different set of overrides:
6863
6964**Name:** octopod-internal
7065
71−**Tag:** 1.3.1
72−
7366**App Overrides:**
7467
7568| Key | Value |
@@ -83,11 +76,15 @@ And create one more deployment, this time using a different set of overrides:
8376| Key | Value |
8477| ----------------: | ------------------------------------- |
8578| `chart_name` | `octopod` |
86−| `chart_repo_name` | `typeable` |
8779| `chart_repo_url` | `https://typeable.github.io/octopod/` |
88−| `chart_version` | `0.5.1` |
80+| `chart_version` | `0.6.0` |
81+
82+## Where can I get these values?
83+
84+As in the previous example Octopod parsed the _App Overrides_ from the [chart values](../../charts/octopod/values.yaml), but the _Deployment Overrides_ are passed as configuration to the control scripts. You can read more about these parameters in the [control script docs](../../helm-control-scripts/README.md).
8985
86+`chart_repo_url`, `chart_name` parameters are usually provided by the chart developer. Version however is usually skipped and you encouraged to take the last one, but we think about this as a bad practice.
9087
91−As in the previous example we took the _App Overrides_ from the [chart documentation](../../charts/octopod/README.md#Parameters), but the _Deployment Overrides_ are passed as configuration to the control scripts. You can read more about these parameters in the [control script docs](../../helm-control-scripts/README.md).
88+If you not sure where to get the `chart_version` parameter you can add repo locally using `helm repo add` and then execute `helm search repo <CHART_NAME> -l` too see the whole list of available chart versions.
9289
93−Now you have Octopod inside Octopod! Now you can install your own helm chart!
90+Now you have Octopod inside Octopod! Try to install your own chart with Octopod!
docs/images/dev2.png

Binary file not shown.

docs/images/octopod_app_keys_list.pngnew file

Binary file not shown.

docs/images/octopod_archive.png

Binary file not shown.

docs/images/octopod_blank.png

Binary file not shown.

docs/images/octopod_deployment_blank.png

Binary file not shown.

docs/images/octopod_deployment_filled.png

Binary file not shown.

docs/images/octopod_in_octopod_deployment.png

Binary file not shown.

docs/images/wordpress_blank.png

Binary file not shown.