Doc: Move WAN keys out of preview except for HA

aristanetworks · Mar 27, 2024 · 05aab7a · 05aab7a
1 parent ff1dee8
commit 05aab7a
Show file tree

Hide file tree

Showing 32 changed files with 399 additions and 583 deletions.
diff --git a/...avd/roles/eos_designs/docs/wan-preview.md → .../avd/roles/eos_designs/docs/how-to/wan.md b/...avd/roles/eos_designs/docs/wan-preview.md → .../avd/roles/eos_designs/docs/how-to/wan.md
diff --git a/ansible_collections/arista/avd/roles/eos_designs/docs/input-variables.md b/ansible_collections/arista/avd/roles/eos_designs/docs/input-variables.md
@@ -22,6 +22,9 @@ The input variables are documented below in tables and YAML.
 !!! warning
     Available features and variables may vary by platforms, refer to documentation on arista.com for specifics.
 
+!!! warning
+    All the keys marked as PREVIEW or children of a key marked as PREVIEW are subject to change and are not supported.
+
 ## Supported designs
 
 `eos_designs` supports multiple options such as L3LS-EVPN with 3-stage or 5-stage, L2LS and MPLS. The sections below highlight these 3 topologies, but you can extend `eos_designs` to support your own topology by using [`node_type_keys`](#node-type-customization) to create your own node type.
@@ -122,13 +125,18 @@ To customize or create new node types, please refer to [node type customization]
 
 ### L3LS EVPN
 
-| Node Type Key      | Underlay Router | Uplink Type | Default EVPN Role  | L2 Network Services | L3 Network Services | VTEP | MLAG Support | Connected Endpoints |
-| ------------------ | --------------- | ------------ | ----------------- | ------------------- | ------------------- | ---- | ------------ | ------------------- |
-| super_spine        | ✅              | p2p          | none              | ✘                   | ✘                   | ✘    | ✘            | ✘                  |
-| spine              | ✅              | p2p          | server            | ✘                   | ✘                   | ✘    | ✘            | ✘                  |
-| l3leaf             | ✅              | p2p          | client            | ✅                  | ✅                  | ✅   | ✅           | ✅                 |
-| l2leaf             | ✘               | port-channel | none              | ✅                  | ✘                   | ✘    | ✅           | ✅                 |
-| overlay_controller | ✅              | p2p          | server            | ✘                   | ✘                   | ✘    | ✘            | ✘                  |
+| Node Type Key      | Underlay Router | Uplink Type  | Default EVPN Role | L2 Network Services | L3 Network Services | VTEP | MLAG Support | Connected Endpoints | Defaut WAN Role | Default Underlay Routing Protocol | Default Overlay Routing Protocol |
+| ------------------ | --------------- | ------------ | ----------------- | ------------------- | ------------------- | ---- | ------------ | ------------------- | --------------- | --------------------------------- | -------------------------------- |
+| super_spine        | ✅              | p2p          | none              | ✘                   | ✘                   | ✘    | ✘            | ✘                   | ✘                | eBGP                             | eBGP                             |
+| spine              | ✅              | p2p          | server            | ✘                   | ✘                   | ✘    | ✘            | ✘                   | ✘                | eBGP                             | eBGP                             |
+| l3leaf             | ✅              | p2p          | client            | ✅                  | ✅                  | ✅   | ✅           | ✅                  | ✘                | eBGP                             | eBGP                             |
+| l2leaf             | ✘               | port-channel | none              | ✅                  | ✘                   | ✘    | ✅           | ✅                  | ✘                | eBGP                             | eBGP                             |
+| overlay_controller | ✅              | p2p          | server            | ✘                   | ✘                   | ✘    | ✘            | ✘                   | ✘                | eBGP                             | eBGP                             |
+| wan_rr             | ✅              | p2p-vrfs     | server            | ✘                   | ✅                  | ✅   | ✘            | ✘                   | server           | none                             | iBGP                             |
+| wan_router         | ✅              | p2p-vrfs     | client            | ✘                   | ✅                  | ✅   | ✘            | ✘                   | client           | none                             | iBGP                             |
+
+- `wan_router`: Edge routers for AutoVPN or Edge and Transit routers for CV Pathfinder depending on the `wan_mode` value.
+- `wan_rr`: AutoVPN RR or Pathfinder depending on the `wan_mode` value.
 
 ### L2LS
 
@@ -521,12 +529,24 @@ roles/eos_designs/docs/tables/node-type-isis-configuration.md
 roles/eos_designs/docs/tables/node-type-mpls-configuration.md
 --8<--
 
+### Node type WAN configuration
+
+--8<--
+roles/eos_designs/docs/tables/node-type-wan-configuration.md
+--8<--
+
 ### Node type PTP configuration
 
 --8<--
 roles/eos_designs/docs/tables/node-type-ptp-configuration.md
 --8<--
 
+### Node type L3 interfaces
+
+--8<--
+roles/eos_designs/docs/tables/node-type-l3-interfaces-configuration.md
+--8<--
+
 ## Default interface settings
 
 - Set default uplink, downlink, and MLAG interfaces, which will be used if these interfaces are not defined on a device (either directly or through inheritance).
@@ -700,6 +720,40 @@ roles/eos_designs/docs/tables/overlay-settings.md
 roles/eos_designs/docs/tables/evpn-settings.md
 --8<--
 
+## WAN Settings
+
+--8<--
+roles/eos_designs/docs/tables/wan-settings.md
+--8<--
+
+### WAN path-groups and carriers
+
+--8<--
+roles/eos_designs/docs/tables/wan-path-groups-and-carriers.md
+--8<--
+
+### WAN hierarchy
+
+!!! note
+
+    This section is only relevant for CV Pathfinder and not for AutoVPN
+
+--8<--
+roles/eos_designs/docs/tables/wan-cv-pathfinder-regions.md
+--8<--
+
+### WAN Virtual topologies
+
+--8<--
+roles/eos_designs/docs/tables/wan-virtual-topologies.md
+--8<--
+
+### Application Classification
+
+--8<--
+roles/eos_designs/docs/tables/application-classification.md
+--8<--
+
 ## Management settings
 
 --8<--
@@ -718,6 +772,12 @@ roles/eos_designs/docs/tables/management-source-interfaces-settings.md
 roles/eos_designs/docs/tables/management-sflow-settings.md
 --8<--
 
+### Flow Tracking Settings
+
+--8<--
+roles/eos_designs/docs/tables/flow-tracking-settings.md
+--8<--
+
 ### SNMP settings
 
 --8<--

diff --git a/...lections/arista/avd/roles/eos_designs/docs/tables/application-classification.md b/...lections/arista/avd/roles/eos_designs/docs/tables/application-classification.md
@@ -7,7 +7,7 @@
 
     | Variable | Type | Required | Default | Value Restrictions | Description |
     | -------- | ---- | -------- | ------- | ------------------ | ----------- |
-    | [<samp>application_classification</samp>](## "application_classification") | Dictionary |  |  |  | PREVIEW: WAN Preview |
+    | [<samp>application_classification</samp>](## "application_classification") | Dictionary |  |  |  | Application traffic recognition configuration. |
     | [<samp>&nbsp;&nbsp;categories</samp>](## "application_classification.categories") | List, items: Dictionary |  |  |  | List of categories. |
     | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;-&nbsp;name</samp>](## "application_classification.categories.[].name") | String | Required, Unique |  |  | Category name. |
     | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;applications</samp>](## "application_classification.categories.[].applications") | List, items: Dictionary |  |  |  | List of applications. |
@@ -49,7 +49,7 @@
 === "YAML"
 
     ```yaml
-    # PREVIEW: WAN Preview
+    # Application traffic recognition configuration.
     application_classification:
 
       # List of categories.

diff --git a/ansible_collections/arista/avd/roles/eos_designs/docs/tables/bgp-settings.md b/ansible_collections/arista/avd/roles/eos_designs/docs/tables/bgp-settings.md
@@ -54,6 +54,28 @@
     | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;password</samp>](## "bgp_peer_groups.ipvpn_gateway_peers.password") | String |  |  |  | Type 7 encrypted password. |
     | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;bfd</samp>](## "bgp_peer_groups.ipvpn_gateway_peers.bfd") | Boolean |  | `True` |  |  |
     | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;structured_config</samp>](## "bgp_peer_groups.ipvpn_gateway_peers.structured_config") | Dictionary |  |  |  | Custom structured config added under router_bgp.peer_groups.[name=<name>] for eos_cli_config_gen. |
+    | [<samp>&nbsp;&nbsp;wan_overlay_peers</samp>](## "bgp_peer_groups.wan_overlay_peers") | Dictionary |  |  |  |  |
+    | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;name</samp>](## "bgp_peer_groups.wan_overlay_peers.name") | String |  | `WAN-OVERLAY-PEERS` |  | Name of peer group. |
+    | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;password</samp>](## "bgp_peer_groups.wan_overlay_peers.password") | String |  |  |  | Type 7 encrypted password. |
+    | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;bfd</samp>](## "bgp_peer_groups.wan_overlay_peers.bfd") | Boolean |  | `True` |  |  |
+    | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;bfd_timers</samp>](## "bgp_peer_groups.wan_overlay_peers.bfd_timers") | Dictionary |  |  |  | Specify the BFD timers to override the default values.<br>It is recommended to keep BFD total timeout longer than the DPS timeout.<br>The Default BFD timeout is 10 x 1 seconds and the default DPS timeout is 5 x 1 seconds. |
+    | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;interval</samp>](## "bgp_peer_groups.wan_overlay_peers.bfd_timers.interval") | Integer | Required | `1000` | Min: 50<br>Max: 60000 | Interval in milliseconds. |
+    | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;min_rx</samp>](## "bgp_peer_groups.wan_overlay_peers.bfd_timers.min_rx") | Integer | Required | `1000` | Min: 50<br>Max: 60000 | Rate in milliseconds. |
+    | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;multiplier</samp>](## "bgp_peer_groups.wan_overlay_peers.bfd_timers.multiplier") | Integer | Required | `10` | Min: 3<br>Max: 50 |  |
+    | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;listen_range_prefixes</samp>](## "bgp_peer_groups.wan_overlay_peers.listen_range_prefixes") | List, items: String |  |  |  | Only used for nodes where `wan_role` is `server` like AutoVPN RRs and Pathfinders.<br>For clients, AVD will raise an error if the Loopback0 IP is not in any listen range. |
+    | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;-&nbsp;&lt;str&gt;</samp>](## "bgp_peer_groups.wan_overlay_peers.listen_range_prefixes.[]") | String |  |  |  | The prefixes to use in listen_range. |
+    | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;structured_config</samp>](## "bgp_peer_groups.wan_overlay_peers.structured_config") | Dictionary |  |  |  | Custom structured config added under router_bgp.peer_groups.[name=<name>] for eos_cli_config_gen. |
+    | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;ttl_maximum_hops</samp>](## "bgp_peer_groups.wan_overlay_peers.ttl_maximum_hops") | Integer |  | `1` |  |  |
+    | [<samp>&nbsp;&nbsp;wan_rr_overlay_peers</samp>](## "bgp_peer_groups.wan_rr_overlay_peers") | Dictionary |  |  |  | Configuration options for the peer-group created to peer between AutoVPN RRs or CV Pathfinders. |
+    | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;name</samp>](## "bgp_peer_groups.wan_rr_overlay_peers.name") | String |  | `WAN-RR-OVERLAY-PEERS` |  | Name of peer group. |
+    | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;password</samp>](## "bgp_peer_groups.wan_rr_overlay_peers.password") | String |  |  |  | Type 7 encrypted password. |
+    | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;bfd</samp>](## "bgp_peer_groups.wan_rr_overlay_peers.bfd") | Boolean |  | `True` |  |  |
+    | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;bfd_timers</samp>](## "bgp_peer_groups.wan_rr_overlay_peers.bfd_timers") | Dictionary |  |  |  | Specify the BFD timers to override the default values.<br>It is recommended to keep BFD total timeout longer than the DPS timeout.<br>The Default BFD timeout is 10 x 1 seconds and the default DPS timeout is 5 x 1 seconds. |
+    | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;interval</samp>](## "bgp_peer_groups.wan_rr_overlay_peers.bfd_timers.interval") | Integer | Required | `1000` | Min: 50<br>Max: 60000 | Interval in milliseconds. |
+    | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;min_rx</samp>](## "bgp_peer_groups.wan_rr_overlay_peers.bfd_timers.min_rx") | Integer | Required | `1000` | Min: 50<br>Max: 60000 | Rate in milliseconds. |
+    | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;multiplier</samp>](## "bgp_peer_groups.wan_rr_overlay_peers.bfd_timers.multiplier") | Integer | Required | `10` | Min: 3<br>Max: 50 |  |
+    | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;structured_config</samp>](## "bgp_peer_groups.wan_rr_overlay_peers.structured_config") | Dictionary |  |  |  | Custom structured config added under router_bgp.peer_groups.[name=<name>] for eos_cli_config_gen. |
+    | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;ttl_maximum_hops</samp>](## "bgp_peer_groups.wan_rr_overlay_peers.ttl_maximum_hops") | Integer |  | `1` |  |  |
     | [<samp>&nbsp;&nbsp;IPv4_UNDERLAY_PEERS</samp>](## "bgp_peer_groups.IPv4_UNDERLAY_PEERS") <span style="color:red">removed</span> | Dictionary |  |  |  | <span style="color:red">This key was removed. Support was removed in AVD version 4.0.0. Use <samp>bgp_peer_groups.ipv4_underlay_peers</samp> instead.</span> |
     | [<samp>&nbsp;&nbsp;MLAG_IPv4_UNDERLAY_PEER</samp>](## "bgp_peer_groups.MLAG_IPv4_UNDERLAY_PEER") <span style="color:red">removed</span> | Dictionary |  |  |  | <span style="color:red">This key was removed. Support was removed in AVD version 4.0.0. Use <samp>bgp_peer_groups.mlag_ipv4_underlay_peer</samp> instead.</span> |
     | [<samp>&nbsp;&nbsp;EVPN_OVERLAY_PEERS</samp>](## "bgp_peer_groups.EVPN_OVERLAY_PEERS") <span style="color:red">removed</span> | Dictionary |  |  |  | <span style="color:red">This key was removed. Support was removed in AVD version 4.0.0. Use <samp>bgp_peer_groups.evpn_overlay_peers</samp> instead.</span> |
@@ -173,6 +195,63 @@
 
         # Custom structured config added under router_bgp.peer_groups.[name=<name>] for eos_cli_config_gen.
         structured_config: <dict>
+      wan_overlay_peers:
+
+        # Name of peer group.
+        name: <str; default="WAN-OVERLAY-PEERS">
+
+        # Type 7 encrypted password.
+        password: <str>
+        bfd: <bool; default=True>
+
+        # Specify the BFD timers to override the default values.
+        # It is recommended to keep BFD total timeout longer than the DPS timeout.
+        # The Default BFD timeout is 10 x 1 seconds and the default DPS timeout is 5 x 1 seconds.
+        bfd_timers:
+
+          # Interval in milliseconds.
+          interval: <int; 50-60000; default=1000; required>
+
+          # Rate in milliseconds.
+          min_rx: <int; 50-60000; default=1000; required>
+          multiplier: <int; 3-50; default=10; required>
+
+        # Only used for nodes where `wan_role` is `server` like AutoVPN RRs and Pathfinders.
+        # For clients, AVD will raise an error if the Loopback0 IP is not in any listen range.
+        listen_range_prefixes:
+
+            # The prefixes to use in listen_range.
+          - <str>
+
+        # Custom structured config added under router_bgp.peer_groups.[name=<name>] for eos_cli_config_gen.
+        structured_config: <dict>
+        ttl_maximum_hops: <int; default=1>
+
+      # Configuration options for the peer-group created to peer between AutoVPN RRs or CV Pathfinders.
+      wan_rr_overlay_peers:
+
+        # Name of peer group.
+        name: <str; default="WAN-RR-OVERLAY-PEERS">
+
+        # Type 7 encrypted password.
+        password: <str>
+        bfd: <bool; default=True>
+
+        # Specify the BFD timers to override the default values.
+        # It is recommended to keep BFD total timeout longer than the DPS timeout.
+        # The Default BFD timeout is 10 x 1 seconds and the default DPS timeout is 5 x 1 seconds.
+        bfd_timers:
+
+          # Interval in milliseconds.
+          interval: <int; 50-60000; default=1000; required>
+
+          # Rate in milliseconds.
+          min_rx: <int; 50-60000; default=1000; required>
+          multiplier: <int; 3-50; default=10; required>
+
+        # Custom structured config added under router_bgp.peer_groups.[name=<name>] for eos_cli_config_gen.
+        structured_config: <dict>
+        ttl_maximum_hops: <int; default=1>
 
     # Do not advertise reachability to a prefix until that prefix has been installed in hardware.
     # This will eliminate any temporary black holes due to a BGP speaker advertising reachability to a prefix that may not yet be installed into the forwarding plane.

diff --git a/...ons/arista/avd/roles/eos_designs/docs/tables/node-type-key-wan-configuration.md b/...ons/arista/avd/roles/eos_designs/docs/tables/node-type-key-wan-configuration.md