Docfix: CL 5.0 with NVUE cannot configure IBGP between loopbacks (#389)

ipspace · Sep 7, 2022 · c831408 · c831408
1 parent af60a88
commit c831408
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 5 deletions.
diff --git a/docs/caveats.md b/docs/caveats.md
@@ -18,6 +18,28 @@
 * *netlab* uses Cumulus VX containers created by Michael Kashin and downloaded from his Docker Hub account. Once Nvidia releases an official container image, change the container name with **defaults.devices.cumulus.clab.image** parameter (or by editing the `topology-defaults.yml` file included with *netlab*).
 * The Cumulus VX 4.4.0 Vagrant box for VirtualBox is broken. *netlab* is using Cumulus VX 4.3.0 with *virtualbox* virtualization provider.
 
+(caveats-cumulus-nvue)=
+
+## Cumulus 5.0 with NVUE
+
+You could configure Cumulus Linux 5.0 with configuration templates developed for Cumulus Linux 4.0 (use device type **cumulus** and specify desired device image), or with NVUE.
+
+NVUE has several shortcomings that prevent *netlab* from configuring basic designs like IBGP on top of IGP. Don't be surprised if the labs that work with **cumulus** device don't work with **cumulus_nvue** device, and please create a GitHub issue whenever you find a glitch. We'd love to know (at least) what doesn't work as expected.
+
+To run Cumulus Linux 5.x with **cumulus** device type, add the following lines to your lab topology:
+
+```
+defaults.devices.cumulus.libvirt.image: CumulusCommunity/cumulus-vx:5.2.0
+defaults.devices.cumulus.libvirt.memory: 2048
+```
+
+Alternatively, you could add the following lines to your `~/.topology-defaults.yml` file:
+
+```
+devices.cumulus.libvirt.image: CumulusCommunity/cumulus-vx:5.2.0
+devices.cumulus.libvirt.memory: 2048
+```
+
 ## Fortinet FortiOS
 
 * *FortiOS* VM images by default have a 15 day evaluation license. The VM has [limited capabilities](https://docs.fortinet.com/document/fortigate-private-cloud/6.0.0/fortigate-vm-on-kvm/504166/fortigate-vm-virtual-appliance-evaluation-license) without a license file. It will work for 15 days from first boot, at which point you must install a license file or recreate the vagrant box completely from scratch.

diff --git a/docs/module/bgp.md b/docs/module/bgp.md
@@ -36,18 +36,23 @@ More interesting BGP topologies can be created with [custom plugins](../plugins.
 
 ## Platform Support
 
-[Platforms supporting BGP configuration module](platform-routing-support) support most of the functionality mentioned above. The following features are only supported on a subset of platforms:
+[Platforms supporting BGP configuration module](platform-routing-support) support most of the functionality mentioned above with the following exceptions:
 
-| Operating system      | IPv6 LLA<br />EBGP sessions | Unnumbered<br />IPv4 EBGP sessions | local AS | IBGP<br>local AS | Configurable<br>default AF |
+* Cumulus Linux 5.2.0 using NVUE cannot configure IBGP sessions between loopback interfaces. Please [see caveats for more details](caveats-cumulus-nvue).
+
+The following features are only supported on a subset of platforms:
+
+| Operating system      | IPv6 LLA<br />EBGP sessions | Unnumbered IPv4<br />EBGP sessions | EBGP<br>local AS | IBGP<br>local AS | Configurable<br>default AF |
 | --------------------- | :-: | :-: | :-: | :-: | :-: |
 | Arista EOS            |  ❌  |  ❌  |  ✅ |  ✅ |  ✅ |
 | Cisco IOS/IOS XE      |  ❌  |  ❌  |  ✅ |  ✅ |  ✅ |
 | Cumulus Linux 4.x     |  ✅ |  ✅ |  ❌  |  ❌  |  ✅ |
-| Cumulus Linux 5.x     |  ✅ |  ✅ |  ❌  |  ❌  |  ❌  |
+| Cumulus Linux 5.x     |  ✅ |  ✅ |  ❌  |  ❌  |  ✅ |
 | Dell OS10             |  ❌  |  ❌  |  ✅ |  ❌  |  ❌  |
 | FRR 7.5.0             |  ✅ |  ❌  |  ✅  |  ✅  |  ✅ |
 | Nokia SR Linux        |  ✅ |  ❌ |  ✅ |  ✅  |  ✅  |
 
+
 ## Global BGP Configuration Parameters
 
 You could use *global* or *per-node* parameters to configure BGP autonomous systems and route reflectors:

diff --git a/docs/platforms.md b/docs/platforms.md
@@ -8,8 +8,8 @@
 | Cisco IOSv                                | iosv               |
 | Cisco CSR 1000v                           | csr                |
 | Cisco Nexus 9300v                         | nxos               |
-| Cumulus Linux                             | cumulus            |
-| Cumulus Linux 5.0 (NVUE)                            | cumulus_nvue            |
+| Cumulus Linux 4.x/5.x                     | cumulus            |
+| Cumulus Linux 5.0 (NVUE)                            | cumulus_nvue [❗](caveats.html#caveats-cumulus-nvue)           |
 | Fortinet FortiOS [❗](caveats.html#fortinet-fortios) | fortios            |
 | FRR 7.5.0                                 | frr                |
 | Generic Linux host                        | linux              |