Refactor(eos_designs)!: Change L3 P2P descriptions for uplinks and p2…

…p_links (#4520)
aristanetworks · Sep 30, 2024 · e66076b · e66076b
1 parent 192c418
commit e66076b
Show file tree

Hide file tree

Showing 617 changed files with 3,828 additions and 3,168 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
@@ -391,6 +391,40 @@ The description can be reverted manually if needed:
 +vtep_loopback_description: "VTEP_VXLAN_Tunnel_Source"
 ```
 
+#### Underlay point-to-point L3 ethernet interfaces
+
+The interface description for the L3 point-to-point interfaces changes to `P2P_<peer>_<peer_interface>_VRF_<vrf>`. Previously the description was `P2P_LINK_TO_<peer | upper>_<peer_interface>_vrf_<vrf>`. The VRF suffix is only added when using `uplink_type: p2p-vrfs`.
+
+The interfaces using this are routed uplinks and `p2p_links` defined under `l3_edge` or `core_interfaces`.
+
+Setting the description directly on `p2p_links` defined under `l3_edge` or `core_interfaces` still takes precedence.
+
+The default descriptions can be reverted manually if needed:
+
+```diff
++default_underlay_p2p_ethernet_description: "P2P_LINK_TO_{peer!u}_{peer_interface}{vrf?<_vrf_}"
+```
+
+The description fields support templates. See the input variables documentation for available fields.
+
+#### Underlay point-to-point L3 port-channel interfaces
+
+The interface description for the L3 point-to-point port-channels changes to `P2P_<peer>_<peer_interface>`. Previously the default description was `P2P_LINK_TO_<peer>_<peer_interface>`.
+
+The port-channels using this are `p2p_links` defined under `l3_edge` or `core_interfaces`.
+
+Setting the description directly on `p2p_links` defined under `l3_edge` or `core_interfaces` still takes precedence.
+
+In AVD 5.0.0 it is also possible to control the port-channel description separately by setting the `description` key under `port_channel`. It will replace the full port-channel interface description.
+
+The default descriptions can be reverted manually if needed:
+
+```diff
++default_underlay_p2p_port_channel_description: "P2P_LINK_TO_{peer}_{peer_interface}"
+```
+
+The description fields support templates. See the input variables documentation for available fields.
+
 #### Out-of-band management interface
 
 The default interface description for the management interface changes to `OOB_MANAGEMENT`.

diff --git a/...e_collections/arista/avd/examples/campus-fabric/documentation/devices/SPINE1.md b/...e_collections/arista/avd/examples/campus-fabric/documentation/devices/SPINE1.md
@@ -324,7 +324,7 @@ vlan 4094
 
 | Interface | Description | Channel Group | IP Address | VRF |  MTU | Shutdown | ACL In | ACL Out |
 | --------- | ----------- | ------------- | ---------- | ----| ---- | -------- | ------ | ------- |
-| Ethernet52/1 | P2P_LINK_TO_WAN_Ethernet1/1 | - | 10.0.0.3/31 | default | 1500 | False | - | - |
+| Ethernet52/1 | P2P_WAN_Ethernet1/1 | - | 10.0.0.3/31 | default | 1500 | False | - | - |
 
 #### Ethernet Interfaces Device Configuration
 
@@ -351,7 +351,7 @@ interface Ethernet51/1
    channel-group 501 mode active
 !
 interface Ethernet52/1
-   description P2P_LINK_TO_WAN_Ethernet1/1
+   description P2P_WAN_Ethernet1/1
    no shutdown
    mtu 1500
    no switchport

diff --git a/...e_collections/arista/avd/examples/campus-fabric/documentation/devices/SPINE2.md b/...e_collections/arista/avd/examples/campus-fabric/documentation/devices/SPINE2.md
@@ -324,7 +324,7 @@ vlan 4094
 
 | Interface | Description | Channel Group | IP Address | VRF |  MTU | Shutdown | ACL In | ACL Out |
 | --------- | ----------- | ------------- | ---------- | ----| ---- | -------- | ------ | ------- |
-| Ethernet52/1 | P2P_LINK_TO_WAN_Ethernet1/1 | - | 10.0.0.5/31 | default | 1500 | False | - | - |
+| Ethernet52/1 | P2P_WAN_Ethernet1/1 | - | 10.0.0.5/31 | default | 1500 | False | - | - |
 
 #### Ethernet Interfaces Device Configuration
 
@@ -351,7 +351,7 @@ interface Ethernet51/1
    channel-group 501 mode active
 !
 interface Ethernet52/1
-   description P2P_LINK_TO_WAN_Ethernet1/1
+   description P2P_WAN_Ethernet1/1
    no shutdown
    mtu 1500
    no switchport

diff --git a/ansible_collections/arista/avd/examples/campus-fabric/intended/configs/SPINE1.cfg b/ansible_collections/arista/avd/examples/campus-fabric/intended/configs/SPINE1.cfg
@@ -119,7 +119,7 @@ interface Ethernet51/1
    channel-group 501 mode active
 !
 interface Ethernet52/1
-   description P2P_LINK_TO_WAN_Ethernet1/1
+   description P2P_WAN_Ethernet1/1
    no shutdown
    mtu 1500
    no switchport

diff --git a/ansible_collections/arista/avd/examples/campus-fabric/intended/configs/SPINE2.cfg b/ansible_collections/arista/avd/examples/campus-fabric/intended/configs/SPINE2.cfg
@@ -119,7 +119,7 @@ interface Ethernet51/1
    channel-group 501 mode active
 !
 interface Ethernet52/1
-   description P2P_LINK_TO_WAN_Ethernet1/1
+   description P2P_WAN_Ethernet1/1
    no shutdown
    mtu 1500
    no switchport

diff --git a/ansible_collections/arista/avd/examples/campus-fabric/intended/structured_configs/SPINE1.yml b/ansible_collections/arista/avd/examples/campus-fabric/intended/structured_configs/SPINE1.yml
@@ -300,14 +300,14 @@ ethernet_interfaces:
   peer: WAN
   peer_interface: Ethernet1/1
   peer_type: other
-  description: P2P_LINK_TO_WAN_Ethernet1/1
   switchport:
     enabled: false
   shutdown: false
   mtu: 1500
   ip_address: 10.0.0.3/31
   ospf_network_point_to_point: true
   ospf_area: 0.0.0.0
+  description: P2P_WAN_Ethernet1/1
 mlag_configuration:
   domain_id: SPINES
   local_interface: Vlan4094

diff --git a/ansible_collections/arista/avd/examples/campus-fabric/intended/structured_configs/SPINE2.yml b/ansible_collections/arista/avd/examples/campus-fabric/intended/structured_configs/SPINE2.yml
@@ -300,14 +300,14 @@ ethernet_interfaces:
   peer: WAN
   peer_interface: Ethernet1/1
   peer_type: other
-  description: P2P_LINK_TO_WAN_Ethernet1/1
   switchport:
     enabled: false
   shutdown: false
   mtu: 1500
   ip_address: 10.0.0.5/31
   ospf_network_point_to_point: true
   ospf_area: 0.0.0.0
+  description: P2P_WAN_Ethernet1/1
 mlag_configuration:
   domain_id: SPINES
   local_interface: Vlan4094

diff --git a/...ollections/arista/avd/examples/dual-dc-l3ls/documentation/devices/dc1-leaf1a.md b/...ollections/arista/avd/examples/dual-dc-l3ls/documentation/devices/dc1-leaf1a.md
@@ -265,22 +265,22 @@ vlan 4094
 
 | Interface | Description | Channel Group | IP Address | VRF |  MTU | Shutdown | ACL In | ACL Out |
 | --------- | ----------- | ------------- | ---------- | ----| ---- | -------- | ------ | ------- |
-| Ethernet1 | P2P_LINK_TO_DC1-SPINE1_Ethernet1 | - | 10.255.255.1/31 | default | 1500 | False | - | - |
-| Ethernet2 | P2P_LINK_TO_DC1-SPINE2_Ethernet1 | - | 10.255.255.3/31 | default | 1500 | False | - | - |
+| Ethernet1 | P2P_dc1-spine1_Ethernet1 | - | 10.255.255.1/31 | default | 1500 | False | - | - |
+| Ethernet2 | P2P_dc1-spine2_Ethernet1 | - | 10.255.255.3/31 | default | 1500 | False | - | - |
 
 #### Ethernet Interfaces Device Configuration
 
 ```eos
 !
 interface Ethernet1
-   description P2P_LINK_TO_DC1-SPINE1_Ethernet1
+   description P2P_dc1-spine1_Ethernet1
    no shutdown
    mtu 1500
    no switchport
    ip address 10.255.255.1/31
 !
 interface Ethernet2
-   description P2P_LINK_TO_DC1-SPINE2_Ethernet1
+   description P2P_dc1-spine2_Ethernet1
    no shutdown
    mtu 1500
    no switchport

diff --git a/...ollections/arista/avd/examples/dual-dc-l3ls/documentation/devices/dc1-leaf1b.md b/...ollections/arista/avd/examples/dual-dc-l3ls/documentation/devices/dc1-leaf1b.md
@@ -265,22 +265,22 @@ vlan 4094
 
 | Interface | Description | Channel Group | IP Address | VRF |  MTU | Shutdown | ACL In | ACL Out |
 | --------- | ----------- | ------------- | ---------- | ----| ---- | -------- | ------ | ------- |
-| Ethernet1 | P2P_LINK_TO_DC1-SPINE1_Ethernet2 | - | 10.255.255.5/31 | default | 1500 | False | - | - |
-| Ethernet2 | P2P_LINK_TO_DC1-SPINE2_Ethernet2 | - | 10.255.255.7/31 | default | 1500 | False | - | - |
+| Ethernet1 | P2P_dc1-spine1_Ethernet2 | - | 10.255.255.5/31 | default | 1500 | False | - | - |
+| Ethernet2 | P2P_dc1-spine2_Ethernet2 | - | 10.255.255.7/31 | default | 1500 | False | - | - |
 
 #### Ethernet Interfaces Device Configuration
 
 ```eos
 !
 interface Ethernet1
-   description P2P_LINK_TO_DC1-SPINE1_Ethernet2
+   description P2P_dc1-spine1_Ethernet2
    no shutdown
    mtu 1500
    no switchport
    ip address 10.255.255.5/31
 !
 interface Ethernet2
-   description P2P_LINK_TO_DC1-SPINE2_Ethernet2
+   description P2P_dc1-spine2_Ethernet2
    no shutdown
    mtu 1500
    no switchport

diff --git a/...ollections/arista/avd/examples/dual-dc-l3ls/documentation/devices/dc1-leaf2a.md b/...ollections/arista/avd/examples/dual-dc-l3ls/documentation/devices/dc1-leaf2a.md
@@ -265,23 +265,23 @@ vlan 4094
 
 | Interface | Description | Channel Group | IP Address | VRF |  MTU | Shutdown | ACL In | ACL Out |
 | --------- | ----------- | ------------- | ---------- | ----| ---- | -------- | ------ | ------- |
-| Ethernet1 | P2P_LINK_TO_DC1-SPINE1_Ethernet3 | - | 10.255.255.9/31 | default | 1500 | False | - | - |
-| Ethernet2 | P2P_LINK_TO_DC1-SPINE2_Ethernet3 | - | 10.255.255.11/31 | default | 1500 | False | - | - |
-| Ethernet6 | P2P_LINK_TO_dc2-leaf2a_Ethernet6 | - | 172.16.100.0/31 | default | 1500 | False | - | - |
+| Ethernet1 | P2P_dc1-spine1_Ethernet3 | - | 10.255.255.9/31 | default | 1500 | False | - | - |
+| Ethernet2 | P2P_dc1-spine2_Ethernet3 | - | 10.255.255.11/31 | default | 1500 | False | - | - |
+| Ethernet6 | P2P_dc2-leaf2a_Ethernet6 | - | 172.16.100.0/31 | default | 1500 | False | - | - |
 
 #### Ethernet Interfaces Device Configuration
 
 ```eos
 !
 interface Ethernet1
-   description P2P_LINK_TO_DC1-SPINE1_Ethernet3
+   description P2P_dc1-spine1_Ethernet3
    no shutdown
    mtu 1500
    no switchport
    ip address 10.255.255.9/31
 !
 interface Ethernet2
-   description P2P_LINK_TO_DC1-SPINE2_Ethernet3
+   description P2P_dc1-spine2_Ethernet3
    no shutdown
    mtu 1500
    no switchport
@@ -303,7 +303,7 @@ interface Ethernet5
    channel-group 5 mode active
 !
 interface Ethernet6
-   description P2P_LINK_TO_dc2-leaf2a_Ethernet6
+   description P2P_dc2-leaf2a_Ethernet6
    no shutdown
    mtu 1500
    no switchport

diff --git a/...ollections/arista/avd/examples/dual-dc-l3ls/documentation/devices/dc1-leaf2b.md b/...ollections/arista/avd/examples/dual-dc-l3ls/documentation/devices/dc1-leaf2b.md
@@ -265,23 +265,23 @@ vlan 4094
 
 | Interface | Description | Channel Group | IP Address | VRF |  MTU | Shutdown | ACL In | ACL Out |
 | --------- | ----------- | ------------- | ---------- | ----| ---- | -------- | ------ | ------- |
-| Ethernet1 | P2P_LINK_TO_DC1-SPINE1_Ethernet4 | - | 10.255.255.13/31 | default | 1500 | False | - | - |
-| Ethernet2 | P2P_LINK_TO_DC1-SPINE2_Ethernet4 | - | 10.255.255.15/31 | default | 1500 | False | - | - |
-| Ethernet6 | P2P_LINK_TO_dc2-leaf2b_Ethernet6 | - | 172.16.100.2/31 | default | 1500 | False | - | - |
+| Ethernet1 | P2P_dc1-spine1_Ethernet4 | - | 10.255.255.13/31 | default | 1500 | False | - | - |
+| Ethernet2 | P2P_dc1-spine2_Ethernet4 | - | 10.255.255.15/31 | default | 1500 | False | - | - |
+| Ethernet6 | P2P_dc2-leaf2b_Ethernet6 | - | 172.16.100.2/31 | default | 1500 | False | - | - |
 
 #### Ethernet Interfaces Device Configuration
 
 ```eos
 !
 interface Ethernet1
-   description P2P_LINK_TO_DC1-SPINE1_Ethernet4
+   description P2P_dc1-spine1_Ethernet4
    no shutdown
    mtu 1500
    no switchport
    ip address 10.255.255.13/31
 !
 interface Ethernet2
-   description P2P_LINK_TO_DC1-SPINE2_Ethernet4
+   description P2P_dc1-spine2_Ethernet4
    no shutdown
    mtu 1500
    no switchport
@@ -303,7 +303,7 @@ interface Ethernet5
    channel-group 5 mode active
 !
 interface Ethernet6
-   description P2P_LINK_TO_dc2-leaf2b_Ethernet6
+   description P2P_dc2-leaf2b_Ethernet6
    no shutdown
    mtu 1500
    no switchport

diff --git a/...ollections/arista/avd/examples/dual-dc-l3ls/documentation/devices/dc1-spine1.md b/...ollections/arista/avd/examples/dual-dc-l3ls/documentation/devices/dc1-spine1.md
@@ -155,38 +155,38 @@ vlan internal order ascending range 1006 1199
 
 | Interface | Description | Channel Group | IP Address | VRF |  MTU | Shutdown | ACL In | ACL Out |
 | --------- | ----------- | ------------- | ---------- | ----| ---- | -------- | ------ | ------- |
-| Ethernet1 | P2P_LINK_TO_DC1-LEAF1A_Ethernet1 | - | 10.255.255.0/31 | default | 1500 | False | - | - |
-| Ethernet2 | P2P_LINK_TO_DC1-LEAF1B_Ethernet1 | - | 10.255.255.4/31 | default | 1500 | False | - | - |
-| Ethernet3 | P2P_LINK_TO_DC1-LEAF2A_Ethernet1 | - | 10.255.255.8/31 | default | 1500 | False | - | - |
-| Ethernet4 | P2P_LINK_TO_DC1-LEAF2B_Ethernet1 | - | 10.255.255.12/31 | default | 1500 | False | - | - |
+| Ethernet1 | P2P_dc1-leaf1a_Ethernet1 | - | 10.255.255.0/31 | default | 1500 | False | - | - |
+| Ethernet2 | P2P_dc1-leaf1b_Ethernet1 | - | 10.255.255.4/31 | default | 1500 | False | - | - |
+| Ethernet3 | P2P_dc1-leaf2a_Ethernet1 | - | 10.255.255.8/31 | default | 1500 | False | - | - |
+| Ethernet4 | P2P_dc1-leaf2b_Ethernet1 | - | 10.255.255.12/31 | default | 1500 | False | - | - |
 
 #### Ethernet Interfaces Device Configuration
 
 ```eos
 !
 interface Ethernet1
-   description P2P_LINK_TO_DC1-LEAF1A_Ethernet1
+   description P2P_dc1-leaf1a_Ethernet1
    no shutdown
    mtu 1500
    no switchport
    ip address 10.255.255.0/31
 !
 interface Ethernet2
-   description P2P_LINK_TO_DC1-LEAF1B_Ethernet1
+   description P2P_dc1-leaf1b_Ethernet1
    no shutdown
    mtu 1500
    no switchport
    ip address 10.255.255.4/31
 !
 interface Ethernet3
-   description P2P_LINK_TO_DC1-LEAF2A_Ethernet1
+   description P2P_dc1-leaf2a_Ethernet1
    no shutdown
    mtu 1500
    no switchport
    ip address 10.255.255.8/31
 !
 interface Ethernet4
-   description P2P_LINK_TO_DC1-LEAF2B_Ethernet1
+   description P2P_dc1-leaf2b_Ethernet1
    no shutdown
    mtu 1500
    no switchport

diff --git a/...ollections/arista/avd/examples/dual-dc-l3ls/documentation/devices/dc1-spine2.md b/...ollections/arista/avd/examples/dual-dc-l3ls/documentation/devices/dc1-spine2.md
@@ -155,38 +155,38 @@ vlan internal order ascending range 1006 1199
 
 | Interface | Description | Channel Group | IP Address | VRF |  MTU | Shutdown | ACL In | ACL Out |
 | --------- | ----------- | ------------- | ---------- | ----| ---- | -------- | ------ | ------- |
-| Ethernet1 | P2P_LINK_TO_DC1-LEAF1A_Ethernet2 | - | 10.255.255.2/31 | default | 1500 | False | - | - |
-| Ethernet2 | P2P_LINK_TO_DC1-LEAF1B_Ethernet2 | - | 10.255.255.6/31 | default | 1500 | False | - | - |
-| Ethernet3 | P2P_LINK_TO_DC1-LEAF2A_Ethernet2 | - | 10.255.255.10/31 | default | 1500 | False | - | - |
-| Ethernet4 | P2P_LINK_TO_DC1-LEAF2B_Ethernet2 | - | 10.255.255.14/31 | default | 1500 | False | - | - |
+| Ethernet1 | P2P_dc1-leaf1a_Ethernet2 | - | 10.255.255.2/31 | default | 1500 | False | - | - |
+| Ethernet2 | P2P_dc1-leaf1b_Ethernet2 | - | 10.255.255.6/31 | default | 1500 | False | - | - |
+| Ethernet3 | P2P_dc1-leaf2a_Ethernet2 | - | 10.255.255.10/31 | default | 1500 | False | - | - |
+| Ethernet4 | P2P_dc1-leaf2b_Ethernet2 | - | 10.255.255.14/31 | default | 1500 | False | - | - |
 
 #### Ethernet Interfaces Device Configuration
 
 ```eos
 !
 interface Ethernet1
-   description P2P_LINK_TO_DC1-LEAF1A_Ethernet2
+   description P2P_dc1-leaf1a_Ethernet2
    no shutdown
    mtu 1500
    no switchport
    ip address 10.255.255.2/31
 !
 interface Ethernet2
-   description P2P_LINK_TO_DC1-LEAF1B_Ethernet2
+   description P2P_dc1-leaf1b_Ethernet2
    no shutdown
    mtu 1500
    no switchport
    ip address 10.255.255.6/31
 !
 interface Ethernet3
-   description P2P_LINK_TO_DC1-LEAF2A_Ethernet2
+   description P2P_dc1-leaf2a_Ethernet2
    no shutdown
    mtu 1500
    no switchport
    ip address 10.255.255.10/31
 !
 interface Ethernet4
-   description P2P_LINK_TO_DC1-LEAF2B_Ethernet2
+   description P2P_dc1-leaf2b_Ethernet2
    no shutdown
    mtu 1500
    no switchport

diff --git a/...ollections/arista/avd/examples/dual-dc-l3ls/documentation/devices/dc2-leaf1a.md b/...ollections/arista/avd/examples/dual-dc-l3ls/documentation/devices/dc2-leaf1a.md
@@ -265,22 +265,22 @@ vlan 4094
 
 | Interface | Description | Channel Group | IP Address | VRF |  MTU | Shutdown | ACL In | ACL Out |
 | --------- | ----------- | ------------- | ---------- | ----| ---- | -------- | ------ | ------- |
-| Ethernet1 | P2P_LINK_TO_DC2-SPINE1_Ethernet1 | - | 10.255.255.105/31 | default | 1500 | False | - | - |
-| Ethernet2 | P2P_LINK_TO_DC2-SPINE2_Ethernet1 | - | 10.255.255.107/31 | default | 1500 | False | - | - |
+| Ethernet1 | P2P_dc2-spine1_Ethernet1 | - | 10.255.255.105/31 | default | 1500 | False | - | - |
+| Ethernet2 | P2P_dc2-spine2_Ethernet1 | - | 10.255.255.107/31 | default | 1500 | False | - | - |
 
 #### Ethernet Interfaces Device Configuration
 
 ```eos
 !
 interface Ethernet1
-   description P2P_LINK_TO_DC2-SPINE1_Ethernet1
+   description P2P_dc2-spine1_Ethernet1
    no shutdown
    mtu 1500
    no switchport
    ip address 10.255.255.105/31
 !
 interface Ethernet2
-   description P2P_LINK_TO_DC2-SPINE2_Ethernet1
+   description P2P_dc2-spine2_Ethernet1
    no shutdown
    mtu 1500
    no switchport