From f7f1ee8d12a444cdf6f4f6851f49a96c0953b60c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Luis=20C=C3=A1novas?= Date: Thu, 8 Jun 2023 11:27:25 +0200 Subject: [PATCH] Update blocky installation-notes.md (#9467) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit **Description** The k8s-gateway section was a little confusing. Adding more details and examples to docs. ⚒️ Fixes **⚙️ Type of change** - [ ] ⚙️ Feature/App addition - [ ] 🪛 Bugfix - [ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] 🔃 Refactor of current code - [x] Docs update **🧪 How Has This Been Tested?** **📃 Notes:** **✔️ Checklist:** - [ ] ⚖️ My code follows the style guidelines of this project - [ ] 👀 I have performed a self-review of my own code - [ ] #️⃣ I have commented my code, particularly in hard-to-understand areas - [ ] 📄 I have made corresponding changes to the documentation - [ ] ⚠️ My changes generate no new warnings - [ ] 🧪 I have added tests to this description that prove my fix is effective or that my feature works - [ ] ⬆️ I increased versions for any altered app according to semantic versioning **➕ App addition** If this PR is an app addition please make sure you have done the following. - [ ] 🪞 I have opened a PR on [truecharts/containers](https://github.com/truecharts/containers) adding the container to TrueCharts mirror repo. - [ ] 🖼️ I have added an icon in the Chart's root directory called `icon.png` --- _Please don't blindly check all the boxes. Read them and only check those that apply. Those checkboxes are there for the reviewer to see what is this all about and the status of this PR with a quick glance._ --------- Signed-off-by: José Luis Cánovas Signed-off-by: Kjeld Schouten Co-authored-by: Kjeld Schouten --- charts/enterprise/blocky/docs/installation-notes.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/charts/enterprise/blocky/docs/installation-notes.md b/charts/enterprise/blocky/docs/installation-notes.md index 1dafeb1c325..f6b642412b5 100644 --- a/charts/enterprise/blocky/docs/installation-notes.md +++ b/charts/enterprise/blocky/docs/installation-notes.md @@ -55,10 +55,11 @@ However: this negatively affects rollback and high availability, so we _highly_ ## k8s-gateway -Our blocky Chart/App, includes build-in compatibility for [k8s_gateway](https://github.com/ori-edge/k8s_gateway), this tool can be used to ensure devices on your local network, connect directly to the LAN IP of any Charts/Apps using Ingress, instead of via the outside world or, in a lot of cases, having a bunch of connectivity issues. +Our blocky Chart/App includes build-in compatibility for [k8s_gateway](https://github.com/ori-edge/k8s_gateway). +This tool can be used to achieve [Split DNS](https://en.wikipedia.org/wiki/Split-horizon_DNS) to ensure devices on your local network connect directly to the LAN IP of any Charts/Apps using Ingress, instead of via the outside world or, in a lot of cases, having a bunch of connectivity issues. -The setup of k8s_gateway is simple: -Just add the domain(s), which will include and subdomains(!), to the k8s_gateway domains list. +To setup k8s_gateway add **your** root domain(s) to the `k8s_gateway` section domains list, e.g. `mydomain.com`. From that point onwards we will take care to automatically apply the required `conditional` settings in `blocky` as well. +This will automatically include all your app subdomains exposed via Ingress, e.g. `jellyfin.mydomain.com`. -Please be mindfull that using `Blocky Style` configuration using the `blockyConfig` object in `values.yaml`, might override this automatic setup. +Please be mindfull that using `Blocky Style` configuration, using the `blockyConfig` object in `values.yaml`, might override this automatic setup.