Release notes for release 2.0 (#2260)

ipspace · web-flow · commit 6c873100e88f · 2025-05-10T09:29:31.000+02:00
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.9.6](https://github.com/ipspace/netlab/releases/tag/release_1.9.6). It should be pretty stable, but if you encounter bugs, please report them as [GitHub issues](https://github.com/ipspace/netlab/issues/new/choose) and use release [1.9.5](https://github.com/ipspace/netlab/releases/tag/release_1.9.5) or [1.9.4-post2](https://github.com/ipspace/netlab/releases/tag/release_1.9.4-post2).
+The latest release is [release 2.0.0](https://github.com/ipspace/netlab/releases/tag/release_2.0.0). It should be pretty stable, but if you encounter bugs, please report them as [GitHub issues](https://github.com/ipspace/netlab/issues/new/choose) and use release [1.9.6](https://github.com/ipspace/netlab/releases/tag/release_1.9.6).
 
 <!--
 or [1.8.4-post2](https://github.com/ipspace/netlab/releases/tag/release_1.8.4-post2).
diff --git a/docs/caveats.md b/docs/caveats.md
@@ -197,19 +197,23 @@ ansible-galaxy collection install git+https://github.com/jmussmann/ansible_colle
 
 [^DD]: See [](topology/hierarchy.md) for an in-depth explanation of why attributes with hierarchical names work in *netlab*
 
-[^NXOM]: The platform limit is 3967. _netlab_ uses another VLAN as fake native VLAN.
+[^NXOM]: The platform limit is 3967. _netlab_ uses another VLAN as a fake native VLAN.
 
 (caveats-cumulus)=
 ## Cumulus Linux
 
+```{warning}
+Cumulus Linux 4.x is retired. While there are no plans to remove it from _netlab_, we will not add new features or run integration tests.
+```
+
 * The Cumulus VX 4.4.0 Vagrant box for VirtualBox is broken. *netlab* is using Cumulus VX 4.3.0 with *virtualbox* virtualization provider.
-* The Cumulus VX 4.x uses Python version 3.7, which recent versions of Ansible refuse to work with. The permanent fix is coming in release 1.9.3. Until then, use the **frrouting** device or [Cumulus VX 5.x image](caveats-cumulus-5x).
-* Both Cumulus VX 4.x and 5.x use relatively old versions of FRR (7.5 on 4.x, 8.4.3 on 5.x). One issue that was observed is that these older versions don't support OSPF passive interfaces inside VRFs (the config in the FRR template is silently ignored)
+* The Cumulus VX 4.x uses Python version 3.7, which recent versions of Ansible refuse to work with. We have to use the **raw** module to communicate with Cumulus VX 4.x virtual machines.
+* Cumulus VX 4.x uses an ancient versions of FRR (7.5; current release is 10.2) with numerous issues or. For example, it silently ignores OSPF passive interfaces inside VRFs
 
 _netlab_ uses the VLAN-aware bridge paradigm to configure VLANs on Cumulus Linux. That decision results in the following restrictions:
 
 * The _netlab_-generated Cumulus Linux VLAN configuration cannot use routed subinterfaces; *ifupdown2* version shipping with Cumulus Linux 4.4.0 refuses to create VLAN subinterfaces in combination with a VLAN-aware bridge.
-* The _netlab_-generated Cumulus Linux VLAN configuration cannot use routed native VLAN; *ifupdown2* enslaves physical ports to the bridge and cannot configure IP addresses on physical ports.
+* The _netlab_-generated Cumulus Linux VLAN configuration cannot use a routed native VLAN; *ifupdown2* enslaves physical ports to the bridge and cannot configure IP addresses on physical ports.
 * FRRouting version bundled with Cumulus Linux 4.4 cannot run OSPFv3 in VRFs and fails to advertise local IPv6 prefixes in other areas.
 
 See also [other FRRouting caveats](caveats-frr).
diff --git a/docs/module/srv6.md b/docs/module/srv6.md
@@ -1,3 +1,4 @@
+(module-srv6)=
 # Segment Routing over IPv6 (srv6) Configuration Module
 
 This configuration module configures SRv6 over IS-IS with IBGP to advertise SID reachability
diff --git a/docs/outputs/d2.md b/docs/outputs/d2.md
@@ -1,3 +1,4 @@
+(outputs-d2)=
 # Declarative Diagramming (D2) Output Module
 
 *d2* output module create a description of network topology in [D2 diagram scripting language](https://d2lang.com/tour/intro). You can use that description with [D2 commands](https://d2lang.com/tour/install) to create topology diagrams.
diff --git a/docs/plugins/firewall.zonebased.md b/docs/plugins/firewall.zonebased.md
@@ -1,3 +1,4 @@
+(plugin-firewall-zonebased)=
 # Zone-Based Firewall plugin
 
 This plugin creates simple Zone-Based Firewall configuration for specific nodes.
diff --git a/docs/release-archive.md b/docs/release-archive.md
@@ -3,6 +3,134 @@ Release Notes Archive
 
 This page describes _netlab_ releases that are at least 18 months old. Newer release notes are [here](release.md).
 
+**[Release 1.6.4](release-1.6.4) (2023-10-23)**
+
+* Implement simple BGP routing policies in [bgp.policy plugin](plugins/bgp.policy.md)
+* Implement **[remove_private_as](bgp-session-as-path)**, passive BGP peers and [BFD for BGP neighbors](bgp-session-platforms) in [bgp.session plugin](plugins/bgp.session)
+* [Selectively apply BGP session attributes](bgp-session-apply) to IBGP and EBGP sessions
+* [Enable external tools](tools-enable-default) in user defaults
+* [Default groups](default-groups) allow you to specify user- or project-wide groups in the defaults files.
+
+{.text-right}
+[More features...](release-1.6.4)
+
+**[Release 1.6.3](release-1.6.3) (2023-10-06)**
+
+* [EBGP multihop sessions](plugins/ebgp.multihop.md)
+* [ebgp.utils plugin](plugin-bgp-session) supports TCP-AO, configurable BGP timers, and Generic TTL Security Mechanism (TTL session protection)
+* [OSPF reports](module/ospf.md)
+* Shorter version of [BGP neighbor report](module/bgp.md)
+* [BFD on Cumulus Linux](bfd-platform)
+
+{.text-right}
+[More features...](release-1.6.3)
+
+**[Release 1.6.2](release-1.6.2) (2023-08-26)**
+
+* [Support for ArubaOS-CX with containerlab](platforms.md#supported-virtual-network-devices)
+* Display a subset of available reports in **[netlab show reports](netlab-show-reports)** command
+* Display warnings in reports relying on **ipaddr** Ansible filter
+* Add IPv6 prefixes and neighbors to BGP reports
+* Add IPv6 column to text addressing report
+* Make some report columns optional to reduce the report width
+* Implement [inter-VRF route leaking](module/vrf.md#platform-support) for Cumulus/FRR
+
+**[Release 1.6.1](release-1.6.1) (2023-08-18)**
+
+* **[netlab report](netlab/report.md)** can generate Markdown markup (ideal for augmenting documentation written in Markdown)
+* BGP AS number and BGP neighbor reports (text, Markdown, HTML)
+* [Make user/system default locations configurable](defaults-locations)
+
+**[Release 1.6.0](release-1.6.0) (2023-08-01)**
+
+* New commands: **[netlab report](netlab/report.md)**, **[netlab graph](netlab/graph.md)** and **[netlab inspect](netlab/inspect.md)**
+* New reports: node and link addressing, lab wiring, management IP addresses and credentials
+* Improved **[netlab show](netlab/show.md)** command can display [configuration modules](modules.md), [output modules](outputs/index.md), [virtualization providers](providers.md) and reports
+* [Connect containers to outside world](clab-network-external) through *macvlan* interfaces
+* Host-to-lab-device port forwarding with [*libvirt*](libvirt-port-forwarding) and *[containerlab](clab-port-forwarding)*
+* Nokia SR OS OSPF P2MP support
+
+{.text-right}
+[More features...](release-1.6.0)
+
+**[Release 1.5.4](release-1.5.4) (2023-06-10)**
+
+* [Juniper vPTX/vEVO](platforms.md) support by Stefano Sasso (initial configuration, IPv4+IPv6, OSPFv2/v3, IS-IS, BGP, BFD, VLANs, VRFs, MPLS, SR-MPLS)
+* [Juniper vSRX](platforms.md) can be run as a *vrnetlab*-packaged container (by Stefano Sasso)
+* Documentation migrated to [netlab.tools](https://netlab.tools)
+
+**[Release 1.5.3](release-1.5.3) (2023-05-15)**
+
+* ['unknown' device type](platform-unknown) can be used to deploy devices not yet supported by *netlab*
+* [Public *libvirt* networks](libvirt-network-external) can be used to connect labs to outside world
+* MPLS VPN support for SR OS
+* Improved virtualization provider installation testing with (hopefully) useful error messages
+
+{.text-right}
+[More features...](release-1.5.3)
+
+**[Release 1.5.2](release-1.5.2) (2023-04-27)**
+
+* [External network management tools](extools.md)
+* [Aruba AOS-CX Support](platforms.md)
+* [Reusable topology components](components.md)
+* [Tunnel interfaces](links-tunnel)
+* Add `--force flag to '[netlab down](netlab/down.md)' command
+* Use [Ansible filters in netlab templating system](labs/clab.md#jinja2-filters-available-in-custom-configuration-files)
+* Deploy [per-node custom configuration templates](dev/config/deploy.md#finding-custom-configuration-templates)
+
+**[Release 1.5.1](release-1.5.1) (2023-04-02)**
+
+* [Simplified definition of VLAN access links](module-vlan-creating-access-links)
+* [Simplified definition of VRF links](module-vrf-links)
+* [Link groups](link-groups)
+* Stricter type checks for node names, group names, VLAN names, VRF names, link roles, address pools, device names, and Linux bridges. Names must be *identifiers*: alphanumeric strings up to 16 characters long.
+* *netlab* status file [tracks active lab instances](netlab/status.md) -- used by **[netlab create](netlab/create.md)**, **[netlab up](netlab/up.md)** and **[netlab down](netlab/down.md)** commands to check for duplicate lab instances.
+* [Output module](outputs/d2.md) for [D2 diagram scripting language](https://d2lang.com/tour/intro)
+
+**[Release 1.5.0](release-1.5.0) (2023-01-28)**
+
+* [Multi-provider topologies](labs/multi-provider.md)
+* [Running multiple lab instances on Linux Servers](plugins/multilab.md)
+* Split large *libvirt* topology into [smaller **vagrant up** batches](labs/libvirt.md#starting-virtual-machines-in-batches)
+* [Use custom network/bridge name and IP subnet](labs/libvirt.md#libvirt-management-network) for `vagrant-libvirt` management network
+* ['loopback' link type](links.md#loopback-links) can be used to create additional loopback interfaces
+
+{.text-right}
+[More features...](release-1.5.0)
+
+**[Release 1.4.3](release-1.4.3) (2023-01-12)**
+
+* [IOS XRv](platforms.md) support (initial configuration, IPv4+IPv6, OSPFv2/v3, IS-IS, BGP)
+* [MPLS, LDP and L3VPN](module/mpls.md) support on FRR
+* [Rewrite Linux container deployment](clab-linux) to remove Python and `ip` dependencies
+* [Custom templates for container configuration files](clab-config-template)
+
+**[Release 1.4.2](release-1.4.2) (2022-12-18)**
+
+* [Juniper vMX](platforms.md) support
+* Junos BFD, VRF, MPLS, SR-MPLS, and MPLS/VPN support
+* Full VLAN support on vMX and routed VLAN interfaces on vSRX
+* CSR 1000v VLAN and VXLAN support
+* VyOS containerlab support
+
+**[Release 1.4.1](release-1.4.1) (2022-11-25)**
+
+* Cisco ASAv support
+* VRRP and anycast gateway on Dell OS10
+* VRRP on VyOS
+* Unnumbered OSPF interfaces on VyOS
+* Add support for all EVPN bundle services
+
+**[Release 1.4.0](release-1.4.0) (2022-11-04)**
+
+* EVPN asymmetric IRB
+* Anycast gateway and VRRP
+* EVPN MPLS transport
+* New address allocation algorithm for links with small IPv4 prefixes
+* Tighter control of VXLAN-enabled and EVPN-controlled VLANs and VRFs
+* Unmanaged and unprovisioned devices
+
 **[Release 1.3.2](release/1.3.md) (2022-10-01)**
 
 * Mikrotik RouterOS version 7 support by Stefano Sasso, including IPv4, IPv6, VLANs, VRFs, OSPFv2, OSPFv3, BGP, MPLS, MPLS/VPN
@@ -271,6 +399,9 @@ Refactored configuration gathering -- use explicit **device_facts** modules or p
    :caption: Individual release notes
    :maxdepth: 2
 
+   release/1.6.md
+   release/1.5.md
+   release/1.4.md
    release/1.3.md
    release/1.2.md
    release/1.1.md
diff --git a/docs/release.md b/docs/release.md
diff --git a/docs/release/2.0.md b/docs/release/2.0.md

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+(module-srv6)=`
`1`	`2`	`# Segment Routing over IPv6 (srv6) Configuration Module`
`2`	`3`
`3`	`4`	`This configuration module configures SRv6 over IS-IS with IBGP to advertise SID reachability`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+(outputs-d2)=`
`1`	`2`	`# Declarative Diagramming (D2) Output Module`
`2`	`3`
`3`	`4`	`d2 output module create a description of network topology in [D2 diagram scripting language](https://d2lang.com/tour/intro). You can use that description with [D2 commands](https://d2lang.com/tour/install) to create topology diagrams.`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+(plugin-firewall-zonebased)=`
`1`	`2`	`# Zone-Based Firewall plugin`
`2`	`3`
`3`	`4`	`This plugin creates simple Zone-Based Firewall configuration for specific nodes.`