diff --git a/charts/enterprise/metallb-config/Chart.yaml b/charts/enterprise/metallb-config/Chart.yaml index b4e04d5bdbb..dd8144f12cc 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: 1.1.7 +version: 1.1.8 annotations: truecharts.org/catagories: | - core diff --git a/charts/enterprise/metallb-config/docs/img/metallb_guide_apps.png b/charts/enterprise/metallb-config/docs/img/metallb_guide_apps.png new file mode 100644 index 00000000000..81b9f5b1171 Binary files /dev/null and b/charts/enterprise/metallb-config/docs/img/metallb_guide_apps.png differ diff --git a/charts/enterprise/metallb-config/docs/img/metallb_guide_trains.png b/charts/enterprise/metallb-config/docs/img/metallb_guide_trains.png new file mode 100644 index 00000000000..2e76f2d617f Binary files /dev/null and b/charts/enterprise/metallb-config/docs/img/metallb_guide_trains.png differ diff --git a/charts/enterprise/metallb-config/docs/setup-guide.md b/charts/enterprise/metallb-config/docs/setup-guide.md index a24b92c41a8..04de8a55a98 100644 --- a/charts/enterprise/metallb-config/docs/setup-guide.md +++ b/charts/enterprise/metallb-config/docs/setup-guide.md @@ -8,12 +8,26 @@ With MetalLB installed, apps will not be reachable using the integrated loadbala ::: -## 1. Configure Address Pool & L2 Advertisement +## Prerequisites + +- Add the Operators & Enterprise trains to your TrueCharts Catalog. + +![metallb-addtrains](img/metallb_guide_trains.png) + +## 1. Install MetalLB Operator from Operators Train + +![metallb-apps](img/metallb_guide_apps.png) + +Install `metallb` from `operators` train first. There is no config, so just hit save. + +If you previously had `metallb` installed and are attempting to upgrade, follow the steps specified below in [Migrating an existing MetalLB config to operator-based version](#migrating-an-existing-metallb-config-to-operator-version) + +## 2. Set Address Pool & L2 Advertisement in MetalLB-Config + +Install `metallb-config` from enterprise train and create a new entry under `Configure IP Address Pools Object` ![metallb-addpoolbasic](img/metallb_guide_addresspool_basic.png) -Create a new entry under `Configure IP Address Pools Object` - - **Name**: Enter a general name for this IP range. Something like _apps_ or _charts_ for this field is fine. - **Auto Assign**: if you want MetalLB Services to auto-assign IPs from the configured address pool without needing to specify per app. Recommendation is to keep this checked. You can still specify an IP for apps as needed (see step 3). @@ -30,15 +44,23 @@ Create a new entry under `Configure L2 Advertisements`. - **Name**: Enter a basic name for your layer 2 advertisement. - **Address Pool Entry:** This should match the **name** of the address pool created above (not the IP range itself). -_For users with VLANs or multiple subnets, you may reference multiple address pool objects under a single L2 Advertisement entry as needed._ - :::info -Once installed, MetalLB will always show as Stopped. +Once installed, `metallb-config` will always show as Stopped. ::: -## 2. Disable SCALE's Default Loadbalancer +## 3. Optional: Specify IP Address per App or Service + +![metallb-specifyIP](img/metallb_guide_specifyIP.png) + +With MetalLB installed, its is 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 With MetalLB installed and configured, you must now disable SCALE's default loadbalancer. @@ -48,19 +70,9 @@ In the SCALE UI, under **Apps** > **Settings** > **Advanced Settings** 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 addresses. +**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. -## 3. Optional: Specify IP Address per App or Service - -![metallb-specifyIP](img/metallb_guide_specifyIP.png) - -With MetalLB installed, you may optionally 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. - -You may need to stop & restart the app for the IP address to take affect. +## 5. Verify IP Addresses Are Assigned From your SCALE shell, run the command `k3s kubectl get svc -A` to verify the IP addresses assigned for each of your apps. The IPs will be listed under the `EXTERNAL-IP` column. @@ -75,3 +87,9 @@ Known Issue: On the SCALE Installed Applications page, the **Open** buttons on e ::: For details on other configuration options, please reference the [MetaLB documentation](https://metallb.universe.tf/configuration/) + +## Migrating an existing MetalLB config to operator version + +- remove the old `metallb` chart coming from the `enterprise` train +- run this in a **root** shell: `k3s kubectl delete --grace-period 30 --v=4 -k https://github.com/truecharts/manifests/delete` +- Proceed with Steps 1 & 2 in the setup guide above