minimize mentions of MCLAG across sections #264
Conversation
Signed-off-by: Pau Capdevila <[email protected]>
|
🚀 Deployed on https://preview-264--hedgehog-docs.netlify.app |
There was a problem hiding this comment.
Pull request overview
This PR minimizes mentions of MCLAG across documentation sections by promoting ESLAG as the recommended multi-homing approach and deprecating MCLAG. The changes reflect a strategic shift toward EVPN Multi-Homing (ESLAG) as the preferred redundancy technology.
Changes:
- Updated terminology from "non-MCLAG leaf" to "orphan leaf" for consistency
- Added deprecation warnings for MCLAG with recommendations to use ESLAG
- Reorganized documentation to prioritize ESLAG over MCLAG, including reordering sections and simplifying examples
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/vlab/running.md | Updated default topology description to recommend ESLAG-only configuration and changed flag examples from MCLAG to ESLAG |
| docs/vlab/overview.md | Added recommendation for ESLAG-only topologies with configuration example |
| docs/vlab/demo.md | Changed terminology from "non-MCLAG leaf" to "orphan leaf" and added ESLAG-only topology recommendation |
| docs/user-guide/host-settings.md | Simplified multi-homing section to focus on ESLAG, removing detailed MCLAG explanations |
| docs/user-guide/devices.md | Removed MCLAG example, added deprecation warning, and streamlined redundancy group documentation to focus on ESLAG |
| docs/user-guide/connections.md | Reordered sections to present ESLAG before MCLAG and added deprecation warning for MCLAG |
| docs/install-upgrade/build-wiring.md | Updated server connection types documentation and diagram to emphasize ESLAG over MCLAG |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ## Default topology | ||
|
|
||
| The default topology is Spine-Leaf with 2 spines, 2 MCLAG leaves, 2 ESLAG leaves and 1 non-MCLAG leaf. | ||
| The default topology is Spine-Leaf with 2 spines, 2 MCLAG leaves, 2 ESLAG leaves and 1 orphan leaf. |
There was a problem hiding this comment.
The description still mentions '2 MCLAG leaves' in the default topology, which contradicts the PR's goal of minimizing MCLAG mentions. Consider updating this to clarify that while MCLAG leaves exist in the default topology, ESLAG-only is recommended, or update the default topology description to reflect the recommended configuration.
| ### Spine-Leaf | ||
|
|
||
| By default, `hhfab vlab gen` creates 2 spines, 2 MCLAG leaves, 2 ESLAG leaves, and 1 orphan (non-LAG) leaf with 2 fabric connections (between each spine and leaf), 2 MCLAG peer links and 2 MCLAG session links. To generate the preceding topology, `hhfab vlab gen`. You can also configure the number of spines, leaves, connections, and so on. For example, flags `--spines-count` and `--mclag-leafs-count` allow you to set the number of spines and MCLAG leaves, respectively. For complete options, `hhfab vlab gen -h`. | ||
| By default, `hhfab vlab gen` creates 2 spines, 2 MCLAG leaves, 2 ESLAG leaves, and 1 orphan (non-LAG) leaf with 2 fabric connections (between each spine and leaf), 2 MCLAG peer links and 2 MCLAG session links. For an ESLAG-only topology (recommended), use `--mclag-leafs-count=0`. You can also configure the number of spines, leaves, connections, and so on. For example, flags `--spines-count` and `--eslag-leaf-groups` allow you to set the number of spines and ESLAG leaf groups, respectively. For complete options, `hhfab vlab gen -h`. |
There was a problem hiding this comment.
This sentence still prominently mentions MCLAG multiple times (MCLAG leaves, MCLAG peer links, MCLAG session links) while trying to recommend ESLAG. Consider restructuring to lead with the ESLAG recommendation first, then briefly note that the default includes MCLAG components for backward compatibility.
| @@ -26,8 +26,9 @@ The following packages needs to be installed: `qemu-kvm socat`. Docker is also r | |||
| into the OCI registry. | |||
|
|
|||
| By default, the VLAB topology is Spine-Leaf with 2 spines, 2 MCLAG leaves, 2 ESLAG leaves, and 1 "orphan" leaf, i.e. with | |||
There was a problem hiding this comment.
Similar to other sections, this description still lists MCLAG leaves as part of the default topology. For consistency with the PR's goal of minimizing MCLAG mentions, consider either updating the default topology or rephrasing to emphasize the ESLAG-only recommendation upfront.
Addresses #261 and #262