From aecd7e57fe832951ede8d193a09bd744e818f564 Mon Sep 17 00:00:00 2001 From: John P Date: Fri, 22 Sep 2023 17:46:59 -0500 Subject: [PATCH] docs(metallb-config): Setup Guide Updates (#12191) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit **Description** ⚒️ Fixes a suggestion raised in the Discord server regarding the instructions apply to TrueCharts apps only. Made some of the wording consistent, and fixed a typo. **⚙️ Type of change** - [ ] ⚙️ Feature/App addition - [X] 🪛 Bugfix (Typo) - [ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to not work as expected) - [X] 🔃 Refactor of current code **🧪 How Has This Been Tested?** N/A **📃 Notes:** **✔️ Checklist:** - [X] ⚖️ My code follows the style guidelines of this project - [X] 👀 I have performed a self-review of my own code - [ ] #️⃣ I have commented my code, particularly in hard-to-understand areas - [X] 📄 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: John P Co-authored-by: StevenMcElligott <89483932+StevenMcElligott@users.noreply.github.com> --- charts/enterprise/metallb-config/Chart.yaml | 2 +- .../metallb-config/docs/setup-guide.md | 16 +++++++++++----- 2 files changed, 12 insertions(+), 6 deletions(-) diff --git a/charts/enterprise/metallb-config/Chart.yaml b/charts/enterprise/metallb-config/Chart.yaml index 9f1600807dc..92819289f3e 100644 --- a/charts/enterprise/metallb-config/Chart.yaml +++ b/charts/enterprise/metallb-config/Chart.yaml @@ -22,7 +22,7 @@ sources: - https://github.com/metallb/metallb - https://metallb.universe.tf type: application -version: 3.0.0 +version: 3.0.1 annotations: truecharts.org/catagories: | - core diff --git a/charts/enterprise/metallb-config/docs/setup-guide.md b/charts/enterprise/metallb-config/docs/setup-guide.md index cc848d8cf6c..54a0b202931 100644 --- a/charts/enterprise/metallb-config/docs/setup-guide.md +++ b/charts/enterprise/metallb-config/docs/setup-guide.md @@ -4,7 +4,7 @@ The guide walks through a basic configuration of MetalLB for a single address po :::warning -With MetalLB installed, apps will not be reachable using the integrated loadbalancer. You cannot combine two different loadbalancers in TrueNAS SCALE. +With MetalLB installed, apps will not be reachable using the integrated LoadBalancer. You cannot combine two different LoadBalancers in TrueNAS SCALE. ::: @@ -14,6 +14,12 @@ With MetalLB installed, apps will not be reachable using the integrated loadbala ![metallb-addtrains](img/metallb_guide_trains.png) +:::caution + +Our customized version of MetalLB is only intended for use with other TrueCharts applications. Other catalogs will likely not support our MetalLB application. MetalLB could technically work with TrueNAS catalog apps if they used the LoadBalancer service, but they don't as they use NodePort instead. These atypical configurations aren't officially supported nor encouraged by TrueCharts. + +::: + ## 1. Install MetalLB Operator from Operators Train ![metallb-apps](img/metallb_guide_apps.png) @@ -57,21 +63,21 @@ Once installed, `metallb-config` will always show as Stopped. ![metallb-specifyIP](img/metallb_guide_specifyIP.png) -With MetalLB installed, its is recommended (but optional) to specify IP addresses for your apps. +With MetalLB installed, it's recommended (but optional) to specify IP addresses for your apps. For each app, under **Networking and Services**, select `LoadBalancer` Service Type for the Main Service. In the **LoadBalancer IP** field, specify an IP address that is within the MetalLB address pool that you configured. Apply the same IP address to the **LoadBalancer IP** field on other services within the app. -## 4. Disable SCALE's Default Loadbalancer +## 4. Disable SCALE's Default LoadBalancer -With MetalLB installed and configured, you must now disable SCALE's default loadbalancer. +With MetalLB installed and configured, you must now disable SCALE's default LoadBalancer. In the SCALE UI, under **Apps** > **Settings** > **Advanced Settings** ![metallb-disable](img/metallb_guide_disableLB.png) -Uncheck `Enable Integrated Loadbalancer`. +Uncheck `Enable Integrated LoadBalancer`. **This will trigger a restart of Kubernetes and all apps**. After roughly 5-10 minutes, your apps will redeploy using the MetalLB-assigned IP addresses.