Update docs and tests

aristanetworks · Sep 17, 2024 · fc03c97 · fc03c97
1 parent 83b44fb
commit fc03c97
Show file tree

Hide file tree

Showing 11 changed files with 189 additions and 104 deletions.
diff --git a/ansible_collections/arista/avd/docs/porting-guides/5.x.x.md b/ansible_collections/arista/avd/docs/porting-guides/5.x.x.md
@@ -284,6 +284,8 @@ It is possible to forcefully add or remove BGP configuration per VRF by setting:
 
 With AVD version 5.0.0 the default interface descriptions are changed to give better consistency.
 
+#### Router ID Loopback
+
 The default interface description for `Loopback0` changes to `ROUTER_ID` for all designs.
 Previously this description varied depending on the network design and chosen protocols.
 
@@ -297,6 +299,8 @@ The description can be reverted manually if needed:
 +router_id_loopback_description: "EVPN_Overlay_Peering"
 ```
 
+#### VTEP Loopback
+
 The default interface description for `Loopback1` (or the interface set with `vtep_loopback`) changes to `VXLAN_TUNNEL_SOURCE`.
 Previously the description was `VTEP_VXLAN_Tunnel_Source`.
 
@@ -306,6 +310,8 @@ The description can be reverted manually if needed:
 +vtep_loopback_description: "VTEP_VXLAN_Tunnel_Source"
 ```
 
+#### Out-of-band management interface
+
 The default interface description for the management interface changes to `OOB_MANAGEMENT`.
 Previously the description was `oob_management`.
 
@@ -315,9 +321,88 @@ The description can be reverted manually if needed:
 +mgmt_interface_description: "oob_management"
 ```
 
-### `wan_mode: autovpn` renamed `wan_mode: legacy-autovpn`
+#### Connected Endpoints ethernet interfaces
+
+The default interface description for the connected endpoints changes to `<endpoint_type>_<endpoint>_<endpoint_port>`.
+Previously the description was `<endpoint>_<endpoint_port>`.
+
+Setting the description directly on the connected endpoint adapter still takes precedence
+The description fields support templates. See the input variables documentation for available fields.
+
+The default descriptions can be reverted manually if needed:
+
+```diff
++default_connected_endpoints_description: "{endpoint}{endpoint_port?<_}"
+```
+
+#### Connected Endpoints port-channel interfaces
+
+The default interface description for the connected endpoints changes to `<endpoint_type>_<endpoint>_<endpoint_port_channel>`.
+Previously the description was `<adapter_description or endpoint>_<port_channel_description>`, so the description field
+set under `port_channel` was always added after the adapter description or name of the endpoint.
+
+In AVD 5.0.0 setting the `description` key under `port_channel` of the will replace the full port-channel interface description.
+The description fields support templates. See the input variables documentation for available fields.
+
+To retain the old descriptions, the value of the `description` key under `port_channel` must be *moved* to the new key
+`endpoint_port_channel` for *all* adapters. Also the default description template must be updated.
+
+```diff
+ servers:
+   - name: server01
+     adapters:
+       - <...>
+         description: My adapter description
+         port_channel:
+-          description: My description that was added after the adapter description
++          endpoint_port_channel: My description that was added after the adapter description
+
++default_connected_endpoints_port_channel_description: "{adapter_description_or_endpoint}{endpoint_port_channel?<_}"
+```
+
+#### Network Ports ethernet interfaces
+
+The default interface description for the `network_ports` data model changes to `<endpoint>`, allowing
+to use new `endpoint` key under `network_ports` which is used similar to the endpoint name under connected endpoints.
+Previously there was no default description.
+
+Setting the description directly under `network_ports` still takes precedence.
+The description fields support templates. See the input variables documentation for available fields.
+
+The default descriptions can be reverted manually if needed:
+
+```diff
++default_network_ports_description: ""
+```
+
+#### Network Ports port-channel interfaces
+
+The default interface description for port-channels under the `network_ports` data model changes to `<endpoint>_<endpoint_port_channel>`,
+allowing to use new `endpoint` key under `network_ports` which is used similar to the endpoint name under connected endpoints.
+Previously the description was `<network_port_description>_<port_channel_description>`, so the description field
+set under `port_channel` was always added after the `description` set directly under the `network_ports`.
+
+In AVD 5.0.0 setting the `description` key under `port_channel` of the will replace the full port-channel interface description.
+The description fields support templates. See the input variables documentation for available fields.
+
+To retain the old descriptions, the value of the `description` key under `port_channel` must be *moved* to the new key
+`endpoint_port_channel` for *all* network_ports. Also the default description template must be updated.
+
+```diff
+ network_ports:
+   - <...>
+     description: My ports description
+     port_channel:
+-      description: My description that was added after the adapter description
++      endpoint_port_channel: My description that was added after the adapter description
+
++default_network_ports_port_channel_description: "{adapter_description_or_endpoint}{endpoint_port_channel?<_}"
+```
+
+### `wan_mode: autovpn` renamed to `wan_mode: legacy-autovpn`
 
-With AVD version 5.0.0 the valid values for `wan_mode` key have changed. If using the `autovpn` mode in AVD 4.x, the `wan_mode` key needs to be updated to `legacy-autovpn`.
+With AVD version 5.0.0 the valid values for `wan_mode` key have changed.
+If using the `autovpn` mode in AVD 4.x, the `wan_mode` key needs to be updated to `legacy-autovpn`.
 
 ```diff
 -  wan_mode: autovpn

diff --git a/...e_collections/arista/avd/molecule/eos_designs_unit_tests/intended/configs/MH-L2LEAF1A.cfg b/...e_collections/arista/avd/molecule/eos_designs_unit_tests/intended/configs/MH-L2LEAF1A.cfg
@@ -61,7 +61,7 @@ interface Ethernet1
    channel-group 1 mode active
 !
 interface Ethernet10
-   description SERVER_server02_Eth1
+   description server02_Eth1
    no shutdown
    switchport
    link tracking group l2leaf-server02 downstream

diff --git a/...ble_collections/arista/avd/molecule/eos_designs_unit_tests/intended/configs/MH-LEAF1A.cfg b/...ble_collections/arista/avd/molecule/eos_designs_unit_tests/intended/configs/MH-LEAF1A.cfg
@@ -49,7 +49,7 @@ vrf instance MGMT
 vrf instance Tenant_X_OP_Zone
 !
 interface Port-Channel10
-   description SERVER_server01_ES1_PortChanne1
+   description server01_ES1_PortChanne1
    no shutdown
    switchport
    switchport access vlan 310
@@ -60,7 +60,7 @@ interface Port-Channel10
    link tracking group LT_GROUP1 downstream
 !
 interface Port-Channel11
-   description ROUTER_ROUTER02_WITH_SUBIF_Testing L2 subinterfaces
+   description ROUTER02_WITH_SUBIF_Testing L2 subinterfaces
    no shutdown
    no switchport
 !
@@ -97,7 +97,7 @@ interface Port-Channel11.104
       route-target import 5c:8e:1f:50:9f:c4
 !
 interface Port-Channel12
-   description SERVER_server03_AUTO_ESI_Auto-ESI PortChannel
+   description server03_AUTO_ESI_Auto-ESI PortChannel
    no shutdown
    switchport
    switchport access vlan 310
@@ -108,7 +108,7 @@ interface Port-Channel12
    link tracking group LT_GROUP1 downstream
 !
 interface Port-Channel13
-   description SERVER_server04_AUTO_ESI_Profile_Auto-ESI PortChannel from profile
+   description server04_AUTO_ESI_Profile_Auto-ESI PortChannel from profile
    no shutdown
    switchport
    switchport access vlan 310
@@ -119,7 +119,7 @@ interface Port-Channel13
    link tracking group LT_GROUP1 downstream
 !
 interface Port-Channel14
-   description SERVER_server05_AUTO_ESI_Profile_Override_Auto-ESI PortChannel overridden on server
+   description server05_AUTO_ESI_Profile_Override_Auto-ESI PortChannel overridden on server
    no shutdown
    switchport
    switchport access vlan 310
@@ -130,7 +130,7 @@ interface Port-Channel14
    link tracking group LT_GROUP1 downstream
 !
 interface Port-Channel15
-   description SERVER_server06_Single_Active_Port_Channel_Single-Active ESI
+   description server06_Single_Active_Port_Channel_Single-Active ESI
    no shutdown
    switchport
    switchport trunk allowed vlan 310
@@ -143,7 +143,7 @@ interface Port-Channel15
    lacp system-id 2873.c14b.64ec
 !
 interface Port-Channel16
-   description SERVER_server07_Single_Active_Port_Channel_Manual_DF_Single-Active ESI with Manual DF
+   description server07_Single_Active_Port_Channel_Manual_DF_Single-Active ESI with Manual DF
    no shutdown
    switchport
    switchport trunk allowed vlan 310
@@ -156,7 +156,7 @@ interface Port-Channel16
    lacp system-id ec11.73f8.7361
 !
 interface Port-Channel20
-   description SERVER_server11_Single_Active_Port_Channel_Manual_DF_Dont_Preempt_Single-Active ESI with Manual DF
+   description server11_Single_Active_Port_Channel_Manual_DF_Dont_Preempt_Single-Active ESI with Manual DF
    no shutdown
    switchport
    switchport trunk allowed vlan 310
@@ -169,7 +169,7 @@ interface Port-Channel20
    lacp system-id 47cb.834e.c0c7
 !
 interface Port-Channel22
-   description SERVER_server13_Single_Active_Port_Channel_Manual_DF_Dont_Preempt_modulus_Single-Active ESI with Manual DF
+   description server13_Single_Active_Port_Channel_Manual_DF_Dont_Preempt_modulus_Single-Active ESI with Manual DF
    no shutdown
    switchport
    switchport trunk allowed vlan 310
@@ -190,42 +190,42 @@ interface Ethernet1
    link tracking group LT_GROUP1 upstream
 !
 interface Ethernet10
-   description SERVER_server01_ES1_Eth1
+   description server01_ES1_Eth1
    no shutdown
    channel-group 10 mode active
 !
 interface Ethernet11
-   description ROUTER_ROUTER02_WITH_SUBIF_Eth1
+   description ROUTER02_WITH_SUBIF_Eth1
    no shutdown
    channel-group 11 mode active
 !
 interface Ethernet12
-   description SERVER_server03_AUTO_ESI_Eth1
+   description server03_AUTO_ESI_Eth1
    no shutdown
    channel-group 12 mode active
 !
 interface Ethernet13
-   description SERVER_server04_AUTO_ESI_Profile_Eth1
+   description server04_AUTO_ESI_Profile_Eth1
    no shutdown
    channel-group 13 mode active
 !
 interface Ethernet14
-   description SERVER_server05_AUTO_ESI_Profile_Override_Eth1
+   description server05_AUTO_ESI_Profile_Override_Eth1
    no shutdown
    channel-group 14 mode active
 !
 interface Ethernet15
-   description SERVER_server06_Single_Active_Port_Channel_Eth1
+   description server06_Single_Active_Port_Channel_Eth1
    no shutdown
    channel-group 15 mode active
 !
 interface Ethernet16
-   description SERVER_server07_Single_Active_Port_Channel_Manual_DF_Eth1
+   description server07_Single_Active_Port_Channel_Manual_DF_Eth1
    no shutdown
    channel-group 16 mode active
 !
 interface Ethernet17
-   description SERVER_server08_Single_Active_Ethernet_Eth1
+   description server08_Single_Active_Ethernet_Eth1
    no shutdown
    switchport trunk allowed vlan 310
    switchport mode trunk
@@ -237,7 +237,7 @@ interface Ethernet17
       route-target import 21:3f:36:b8:ff:71
 !
 interface Ethernet18
-   description SERVER_server09_All_Active_Ethernet_Eth1
+   description server09_All_Active_Ethernet_Eth1
    no shutdown
    switchport trunk allowed vlan 310
    switchport mode trunk
@@ -249,7 +249,7 @@ interface Ethernet18
       route-target import 00:dd:00:dd:00:dd
 !
 interface Ethernet19
-   description SERVER_server10_Single_Active_Ethernet_Manual_DF_Eth1
+   description server10_Single_Active_Ethernet_Manual_DF_Eth1
    no shutdown
    switchport trunk allowed vlan 310
    switchport mode trunk
@@ -261,12 +261,12 @@ interface Ethernet19
       route-target import 88:5b:86:cc:8b:ac
 !
 interface Ethernet20
-   description SERVER_server11_Single_Active_Port_Channel_Manual_DF_Dont_Preempt_Eth1
+   description server11_Single_Active_Port_Channel_Manual_DF_Dont_Preempt_Eth1
    no shutdown
    channel-group 20 mode active
 !
 interface Ethernet21
-   description SERVER_server12_Single_Active_Ethernet_Manual_DF_Dont_Preempt_Eth1
+   description server12_Single_Active_Ethernet_Manual_DF_Dont_Preempt_Eth1
    no shutdown
    switchport trunk allowed vlan 310
    switchport mode trunk
@@ -278,12 +278,12 @@ interface Ethernet21
       route-target import 5d:0b:68:d3:6f:f9
 !
 interface Ethernet22
-   description SERVER_server13_Single_Active_Port_Channel_Manual_DF_Dont_Preempt_modulus_Eth1
+   description server13_Single_Active_Port_Channel_Manual_DF_Dont_Preempt_modulus_Eth1
    no shutdown
    channel-group 22 mode active
 !
 interface Ethernet23
-   description SERVER_server14_Single_Active_Ethernet_Manual_DF_Dont_Preempt_modulus_Eth1
+   description server14_Single_Active_Ethernet_Manual_DF_Dont_Preempt_modulus_Eth1
    no shutdown
    switchport trunk allowed vlan 310
    switchport mode trunk