From a9273becb672f309760b4dabcaafa1f908cb9964 Mon Sep 17 00:00:00 2001 From: ksimm1 Date: Sat, 24 Jun 2023 22:52:02 -0700 Subject: [PATCH] feat(docs): metallb docs add kubectl cmd to first step (#9879) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit **Description** update metallb guide to include the kubectl delete command in first step to avoid confusion. ⚒️ 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 **🧪 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._ --- charts/enterprise/metallb-config/docs/setup-guide.md | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/charts/enterprise/metallb-config/docs/setup-guide.md b/charts/enterprise/metallb-config/docs/setup-guide.md index 04de8a55a98..cc848d8cf6c 100644 --- a/charts/enterprise/metallb-config/docs/setup-guide.md +++ b/charts/enterprise/metallb-config/docs/setup-guide.md @@ -20,7 +20,10 @@ With MetalLB installed, apps will not be reachable using the integrated loadbala 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) +If you encounter an error upon install, run the following command as root from system settings -> shell and attempt the install again: +```k3s kubectl delete --grace-period 30 --v=4 -k https://github.com/truecharts/manifests/delete``` + +If you previously had `metallb` installed and encounter an error, delete the old version, then run the above command before proceeding to install the `metallb` operator. ## 2. Set Address Pool & L2 Advertisement in MetalLB-Config @@ -87,9 +90,3 @@ 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