Release 1.8.2

ipspace · May 13, 2024 · cf00211 · cf00211
1 parent 9294ca0
commit cf00211
Show file tree

Hide file tree

Showing 15 changed files with 338 additions and 292 deletions.
diff --git a/README.md b/README.md
@@ -14,7 +14,7 @@ Interested? [Read the documentation](https://netlab.tools) and [installation gui
 
 ## Releases
 
-The latest release is [release 1.8.1-post1](https://github.com/ipspace/netlab/releases/tag/release_1.8.1-post1), and as always, it might have a few bugs. Should you encounter one of those creatures, please report it with [a GitHub issue](https://github.com/ipspace/netlab/issues/new/choose) and use release [1.8.0](https://github.com/ipspace/netlab/releases/tag/release_1.8.0) or [1.7.2](https://github.com/ipspace/netlab/releases/tag/release_1.7.2).
+The latest release is [release 1.8.2](https://github.com/ipspace/netlab/releases/tag/release_1.8.2), and as always, it might have a few bugs. Should you encounter one of those creatures, please report it with [a GitHub issue](https://github.com/ipspace/netlab/issues/new/choose) and use release [1.8.1-post1](https://github.com/ipspace/netlab/releases/tag/release_1.8.1-post1) or [1.7.2](https://github.com/ipspace/netlab/releases/tag/release_1.7.2).
 
 <!--
 If you encounter bugs using release 1.7.x, please downgrade to [1.6.4](https://github.com/ipspace/netlab/releases/tag/release_1.6.4) and [open a GitHub issue](https://github.com/ipspace/netlab/issues).

diff --git a/docs/caveats.md b/docs/caveats.md
@@ -268,7 +268,6 @@ See also [](caveats-junos).
 * Only supported on top of *Containerlab*
 * Supports container image release 23.3.1 or later (due to YANG model changes)
 * Requires the latest `nokia.grpc` Ansible Galaxy collection and its dependencies to be installed from the git repo. You can also use the **netlab install grpc** command to install them
-* MPLS and LDP only supported on 7250 IXR (clab.type in ['ixr6','ixr6e','ixr10','ixr10e'])
 
 ```
 ansible-galaxy collection install git+https://github.com/nokia/ansible-networking-collections.git#/grpc/
@@ -281,6 +280,8 @@ python3 -m pip install grpcio protobuf==3.20.1
 sudo pip3 install --upgrade 'ansible>=9.5.1'
 ```
 
+* MPLS and LDP are only supported on 7250 IXR (clab.type in ['ixr6','ixr6e','ixr10','ixr10e'])
+* Nokia SR Linux needs an EVPN control plane to enable VXLAN functionality. VXLAN ingress replication lists are built from EVPN Route Type 3 updates.
 * Inter-VRF route leaking is supported only in combination with BGP EVPN
 * SR Linux does not support multi-topology IS-IS.
 
@@ -323,4 +324,4 @@ It looks like the official VyOS container is not updated as part of the daily bu
 
 Other VyOS caveats:
 
-* Multi-topology IS-IS (assumed by the [IS-IS configuration module](module-isis)) cannot be configured with VyOS IS-IS CLI.
+* Multi-topology IS-IS (assumed by the [IS-IS configuration module](module-isis)) cannot be configured with VyOS IS-IS CLI ([bug report](https://vyos.dev/T6332)).
diff --git a/docs/module/bgp.md b/docs/module/bgp.md
@@ -73,6 +73,10 @@ The following features are only supported on a subset of platforms:
 | Sonic                 |  ✅ |  ✅ |  ✅ |  ✅ |  ✅ |
 | VyOS                  |  ✅ |  ✅ |  ✅ |  ❌  |  ✅  |
 
+```{tip}
+See [BGP Integration Tests Results](https://release.netlab.tools/_html/coverage.bgp) for more details.
+```
+
 ## Global BGP Configuration Parameters
 
 You could use *global* or *per-node* parameters to configure BGP autonomous systems and route reflectors:

diff --git a/docs/module/isis.md b/docs/module/isis.md
@@ -46,6 +46,10 @@ The following table describes per-platform support of individual IS-IS features:
 * On VyOS, IPv6 is enabled on all interfaces as soon as one has an IPv6 address.
 * Cisco ASA does not support P2P IS-IS links. You could add `isis.network_type: false` to point-to-point links connecting ASA to other devices.
 
+```{tip}
+See [IS-IS Integration Tests Results](https://release.netlab.tools/_html/coverage.isis) for more details.
+```
+
 ## Global Parameters
 
 * **isis.area** -- CLNS area prefix. Router address (NET) is computed from area prefix, 6-byte system ID (using **id** node attribute), and NSAP selector (.00)

diff --git a/docs/module/ospf.md b/docs/module/ospf.md
@@ -71,6 +71,10 @@ The following table describes per-platform support of individual router-level OS
 * Mikrotik RouterOS and VyOS support BFD on OSPF only with the system default values for interval and multiplier.
 * Dell OS10 does not support OSPF on the so-called *Virtual Network* interface, the VLAN implementation model currently used in our templates.
 
+```{tip}
+See [OSPFv2](https://release.netlab.tools/_html/coverage.ospf.ospfv2) and [OSPFv3](https://release.netlab.tools/_html/coverage.ospf.ospfv3) Integration Tests Results for more details.
+```
+
 OSPF is also supported on these [routing daemons](platform-daemons):
 
 | Operating system         | Areas | Reference<br/>bandwidth | OSPFv3 | BFD  | BFD<br/>Strict-Mode |

diff --git a/docs/module/vlan.md b/docs/module/vlan.md
@@ -38,6 +38,10 @@ VLANs are supported on these platforms:
 | Nokia SR OS           | ✅  | ✅  | ✅   | ✅ | ✅ |
 | VyOS                  | ✅  | ✅  | ✅   | ✅ | ✅ |
 
+```{tip}
+See [VLAN Integration Tests Results](https://release.netlab.tools/_html/coverage.vlan) for more details.
+```
+
 ## VLAN Connectivity Model
 
 The VLAN configuration module assumes you're creating a sane design in which:

diff --git a/docs/module/vrf.md b/docs/module/vrf.md
@@ -57,6 +57,7 @@ These platforms support routing protocols in VRFs:
 ```{note}
 * IS-IS and EIGRP cannot be run within a VRF, but both configuration modules are VRF-aware -- they will not try to configure IS-IS or EIGRP routing on VRF interfaces
 * IBGP within a VRF instance does not work. PE-routers and CE-routers MUST HAVE different BGP AS numbers
+* See [VRF Integration Tests Results](https://release.netlab.tools/_html/coverage.vrf) for more details.
 ```
 
 ## Parameters

diff --git a/docs/module/vxlan.md b/docs/module/vxlan.md
@@ -32,12 +32,12 @@ The following table describes per-platform support of individual VXLAN features:
 | Cumulus Linux      | ✅  | ✅  |  ❌  |
 | Dell OS10          | ✅  | ✅  |  ❌  |
 | FRR                | ✅  | ✅  | ✅  |
-| Nokia SR Linux     | ✅  |  ❌  |  ❌  |
+| Nokia SR Linux     | ✅ [❗](caveats-srlinux)  |  ❌  |  ❌  |
 | Nokia SR OS        | ✅  |  ❌  |  ❌  |
 | VyOS               | ✅  | ✅  | ✅  |
 
-```{note}
-* Nokia SR Linux needs EVPN control plane to enable VXLAN functionality. VXLAN ingress replication lists are built from EVPN Route Type 3 updates.
+```{tip}
+See [VXLAN Integration Tests Results](https://release.netlab.tools/_html/coverage.vxlan) for more details.
 ```
 
 ## Global and Node Parameters

diff --git a/docs/netlab/initial.md b/docs/netlab/initial.md
@@ -1,3 +1,4 @@
+(netlab-initial)=
 # Deploying Initial Device Configurations
 
 **netlab initial** command uses expanded Ansible inventory data created with **[netlab create](create.md)** command, device-specific Jinja2 templates, and an internal Ansible playbook to deploy initial device configurations.

diff --git a/docs/platforms.md b/docs/platforms.md
@@ -229,6 +229,10 @@ The following interface addresses are supported on various platforms:
 | Sonic                 | ✅  | ✅  | ✅  |
 | VyOS                  | ✅  | ✅  | ✅  |
 
+```{tip}
+See [Initial Configuration Integration Tests Results](https://release.netlab.tools/_html/coverage.initial) for more details.
+```
+
 ## Supported Configuration Modules
 
 (platform-routing-support)=
@@ -263,6 +267,10 @@ Routing protocol [configuration modules](module-reference.md) are supported on t
 **Notes:**
 * FRHP = First-Hop Redundancy Protocol (anycast gateway or VRRP)
 
+```{tip}
+See [integration test results](https://release.netlab.tools/) for more details.
+```
+
 Routing protocol [configuration modules](module-reference.md) are also supported on these daemons:
 
 | Operating system      | [OSPF](module/ospf.md) | [IS-IS](module/isis.md) | [BGP](module/bgp.md) | [BFD](module/bfd.md) |