Refactor: Address PR comments

aristanetworks · Jan 4, 2024 · 703afd1 · 703afd1
1 parent 50a9560
commit 703afd1
Show file tree

Hide file tree

Showing 14 changed files with 39 additions and 36 deletions.
diff --git a/..._collections/arista/avd/molecule/eos_designs_unit_tests/intended/configs/autovpn-edge.cfg b/..._collections/arista/avd/molecule/eos_designs_unit_tests/intended/configs/autovpn-edge.cfg
@@ -126,8 +126,8 @@ management api http-commands
 stun
    client
       server-profile INET-autovpn-rr1-Ethernet1
-         ip address 10.7.7.7/31
+         ip address 10.7.7.7
       server-profile INET-autovpn-rr2-Ethernet1
-         ip address 10.8.8.8/31
+         ip address 10.8.8.8
 !
 end
diff --git a/...ctions/arista/avd/molecule/eos_designs_unit_tests/intended/configs/cv-pathfinder-edge.cfg b/...ctions/arista/avd/molecule/eos_designs_unit_tests/intended/configs/cv-pathfinder-edge.cfg
@@ -168,8 +168,8 @@ management api http-commands
 stun
    client
       server-profile INET-cv-pathfinder-pathfinder-Ethernet1
-         ip address 10.7.7.7/31
+         ip address 10.7.7.7
       server-profile INET-cv-pathfinder-pathfinder-Ethernet3
-         ip address 10.9.9.9/31
+         ip address 10.9.9.9
 !
 end
diff --git a/...ons/arista/avd/molecule/eos_designs_unit_tests/intended/configs/cv-pathfinder-transit.cfg b/...ons/arista/avd/molecule/eos_designs_unit_tests/intended/configs/cv-pathfinder-transit.cfg
@@ -173,10 +173,10 @@ management api http-commands
 stun
    client
       server-profile INET-cv-pathfinder-pathfinder-Ethernet1
-         ip address 10.7.7.7/31
+         ip address 10.7.7.7
       server-profile INET-cv-pathfinder-pathfinder-Ethernet3
-         ip address 10.9.9.9/31
+         ip address 10.9.9.9
       server-profile MPLS-cv-pathfinder-pathfinder-Ethernet2
-         ip address 172.16.0.1/31
+         ip address 172.16.0.1
 !
 end
diff --git a/...s/arista/avd/molecule/eos_designs_unit_tests/intended/structured_configs/autovpn-edge.yml b/...s/arista/avd/molecule/eos_designs_unit_tests/intended/structured_configs/autovpn-edge.yml
@@ -128,9 +128,9 @@ stun:
   client:
     server_profiles:
     - name: INET-autovpn-rr1-Ethernet1
-      ip_address: 10.7.7.7/31
+      ip_address: 10.7.7.7
     - name: INET-autovpn-rr2-Ethernet1
-      ip_address: 10.8.8.8/31
+      ip_address: 10.8.8.8
 ethernet_interfaces:
 - name: Ethernet1
   peer_type: l3_interface

diff --git a/...ta/avd/molecule/eos_designs_unit_tests/intended/structured_configs/cv-pathfinder-edge.yml b/...ta/avd/molecule/eos_designs_unit_tests/intended/structured_configs/cv-pathfinder-edge.yml
@@ -175,9 +175,9 @@ stun:
   client:
     server_profiles:
     - name: INET-cv-pathfinder-pathfinder-Ethernet1
-      ip_address: 10.7.7.7/31
+      ip_address: 10.7.7.7
     - name: INET-cv-pathfinder-pathfinder-Ethernet3
-      ip_address: 10.9.9.9/31
+      ip_address: 10.9.9.9
 ethernet_interfaces:
 - name: Ethernet1
   peer_type: l3_interface

diff --git a/...avd/molecule/eos_designs_unit_tests/intended/structured_configs/cv-pathfinder-transit.yml b/...avd/molecule/eos_designs_unit_tests/intended/structured_configs/cv-pathfinder-transit.yml
@@ -183,11 +183,11 @@ stun:
   client:
     server_profiles:
     - name: INET-cv-pathfinder-pathfinder-Ethernet1
-      ip_address: 10.7.7.7/31
+      ip_address: 10.7.7.7
     - name: INET-cv-pathfinder-pathfinder-Ethernet3
-      ip_address: 10.9.9.9/31
+      ip_address: 10.9.9.9
     - name: MPLS-cv-pathfinder-pathfinder-Ethernet2
-      ip_address: 172.16.0.1/31
+      ip_address: 172.16.0.1
 ethernet_interfaces:
 - name: Ethernet1
   peer_type: l3_interface

diff --git a/ansible_collections/arista/avd/roles/eos_designs/docs/tables/core-interfaces.md b/ansible_collections/arista/avd/roles/eos_designs/docs/tables/core-interfaces.md
@@ -102,7 +102,7 @@
     | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;speed</samp>](## "core_interfaces.l3_interfaces_profiles.[].speed") | String |  |  |  | Speed should be set in the format `<interface_speed>` or `forced <interface_speed>` or `auto <interface_speed>`. |
     | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;peer</samp>](## "core_interfaces.l3_interfaces_profiles.[].peer") | String |  |  |  | The peer device name. Used for description and documentation |
     | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;peer_interface</samp>](## "core_interfaces.l3_interfaces_profiles.[].peer_interface") | String |  |  |  | The peer device interface. Used for description and documentation |
-    | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;peer_ip</samp>](## "core_interfaces.l3_interfaces_profiles.[].peer_ip") | String |  |  |  | The peer device IP/Mask. Used as default route gateway is `set_default_route` is true and `ip` is an IP address. |
+    | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;peer_ip</samp>](## "core_interfaces.l3_interfaces_profiles.[].peer_ip") | String |  |  |  | The peer device IPv4 address/Mask. Used as default route gateway if `set_default_route` is true and `ip` is an IP address. |
     | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;qos_profile</samp>](## "core_interfaces.l3_interfaces_profiles.[].qos_profile") | String |  |  |  | QOS service profile. |
     | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;raw_eos_cli</samp>](## "core_interfaces.l3_interfaces_profiles.[].raw_eos_cli") | String |  |  |  | EOS CLI rendered directly on the interface in the final EOS configuration. |
     | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;structured_config</samp>](## "core_interfaces.l3_interfaces_profiles.[].structured_config") | Dictionary |  |  |  | Custom structured config for the Ethernet interface. |
@@ -117,7 +117,7 @@
     | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;speed</samp>](## "core_interfaces.l3_interfaces.[].speed") | String |  |  |  | Speed should be set in the format `<interface_speed>` or `forced <interface_speed>` or `auto <interface_speed>`. |
     | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;peer</samp>](## "core_interfaces.l3_interfaces.[].peer") | String |  |  |  | The peer device name. Used for description and documentation |
     | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;peer_interface</samp>](## "core_interfaces.l3_interfaces.[].peer_interface") | String |  |  |  | The peer device interface. Used for description and documentation |
-    | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;peer_ip</samp>](## "core_interfaces.l3_interfaces.[].peer_ip") | String |  |  |  | The peer device IP/Mask. Used as default route gateway is `set_default_route` is true and `ip` is an IP address. |
+    | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;peer_ip</samp>](## "core_interfaces.l3_interfaces.[].peer_ip") | String |  |  |  | The peer device IPv4 address/Mask. Used as default route gateway if `set_default_route` is true and `ip` is an IP address. |
     | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;qos_profile</samp>](## "core_interfaces.l3_interfaces.[].qos_profile") | String |  |  |  | QOS service profile. |
     | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;raw_eos_cli</samp>](## "core_interfaces.l3_interfaces.[].raw_eos_cli") | String |  |  |  | EOS CLI rendered directly on the interface in the final EOS configuration. |
     | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;structured_config</samp>](## "core_interfaces.l3_interfaces.[].structured_config") | Dictionary |  |  |  | Custom structured config for the Ethernet interface. |
@@ -379,7 +379,7 @@
           # The peer device interface. Used for description and documentation
           peer_interface: <str>
 
-          # The peer device IP/Mask. Used as default route gateway is `set_default_route` is true and `ip` is an IP address.
+          # The peer device IPv4 address/Mask. Used as default route gateway if `set_default_route` is true and `ip` is an IP address.
           peer_ip: <str>
 
           # QOS service profile.
@@ -426,7 +426,7 @@
           # The peer device interface. Used for description and documentation
           peer_interface: <str>
 
-          # The peer device IP/Mask. Used as default route gateway is `set_default_route` is true and `ip` is an IP address.
+          # The peer device IPv4 address/Mask. Used as default route gateway if `set_default_route` is true and `ip` is an IP address.
           peer_ip: <str>
 
           # QOS service profile.

diff --git a/ansible_collections/arista/avd/roles/eos_designs/docs/tables/l3-edge.md b/ansible_collections/arista/avd/roles/eos_designs/docs/tables/l3-edge.md
@@ -102,7 +102,7 @@
     | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;speed</samp>](## "l3_edge.l3_interfaces_profiles.[].speed") | String |  |  |  | Speed should be set in the format `<interface_speed>` or `forced <interface_speed>` or `auto <interface_speed>`. |
     | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;peer</samp>](## "l3_edge.l3_interfaces_profiles.[].peer") | String |  |  |  | The peer device name. Used for description and documentation |
     | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;peer_interface</samp>](## "l3_edge.l3_interfaces_profiles.[].peer_interface") | String |  |  |  | The peer device interface. Used for description and documentation |
-    | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;peer_ip</samp>](## "l3_edge.l3_interfaces_profiles.[].peer_ip") | String |  |  |  | The peer device IP/Mask. Used as default route gateway is `set_default_route` is true and `ip` is an IP address. |
+    | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;peer_ip</samp>](## "l3_edge.l3_interfaces_profiles.[].peer_ip") | String |  |  |  | The peer device IPv4 address/Mask. Used as default route gateway if `set_default_route` is true and `ip` is an IP address. |
     | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;qos_profile</samp>](## "l3_edge.l3_interfaces_profiles.[].qos_profile") | String |  |  |  | QOS service profile. |
     | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;raw_eos_cli</samp>](## "l3_edge.l3_interfaces_profiles.[].raw_eos_cli") | String |  |  |  | EOS CLI rendered directly on the interface in the final EOS configuration. |
     | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;structured_config</samp>](## "l3_edge.l3_interfaces_profiles.[].structured_config") | Dictionary |  |  |  | Custom structured config for the Ethernet interface. |
@@ -117,7 +117,7 @@
     | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;speed</samp>](## "l3_edge.l3_interfaces.[].speed") | String |  |  |  | Speed should be set in the format `<interface_speed>` or `forced <interface_speed>` or `auto <interface_speed>`. |
     | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;peer</samp>](## "l3_edge.l3_interfaces.[].peer") | String |  |  |  | The peer device name. Used for description and documentation |
     | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;peer_interface</samp>](## "l3_edge.l3_interfaces.[].peer_interface") | String |  |  |  | The peer device interface. Used for description and documentation |
-    | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;peer_ip</samp>](## "l3_edge.l3_interfaces.[].peer_ip") | String |  |  |  | The peer device IP/Mask. Used as default route gateway is `set_default_route` is true and `ip` is an IP address. |
+    | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;peer_ip</samp>](## "l3_edge.l3_interfaces.[].peer_ip") | String |  |  |  | The peer device IPv4 address/Mask. Used as default route gateway if `set_default_route` is true and `ip` is an IP address. |
     | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;qos_profile</samp>](## "l3_edge.l3_interfaces.[].qos_profile") | String |  |  |  | QOS service profile. |
     | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;raw_eos_cli</samp>](## "l3_edge.l3_interfaces.[].raw_eos_cli") | String |  |  |  | EOS CLI rendered directly on the interface in the final EOS configuration. |
     | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;structured_config</samp>](## "l3_edge.l3_interfaces.[].structured_config") | Dictionary |  |  |  | Custom structured config for the Ethernet interface. |
@@ -379,7 +379,7 @@
           # The peer device interface. Used for description and documentation
           peer_interface: <str>
 
-          # The peer device IP/Mask. Used as default route gateway is `set_default_route` is true and `ip` is an IP address.
+          # The peer device IPv4 address/Mask. Used as default route gateway if `set_default_route` is true and `ip` is an IP address.
           peer_ip: <str>
 
           # QOS service profile.
@@ -426,7 +426,7 @@
           # The peer device interface. Used for description and documentation
           peer_interface: <str>
 
-          # The peer device IP/Mask. Used as default route gateway is `set_default_route` is true and `ip` is an IP address.
+          # The peer device IPv4 address/Mask. Used as default route gateway if `set_default_route` is true and `ip` is an IP address.
           peer_ip: <str>
 
           # QOS service profile.

diff --git a/ansible_collections/arista/avd/roles/eos_designs/docs/tables/wan-path-groups.md b/ansible_collections/arista/avd/roles/eos_designs/docs/tables/wan-path-groups.md
@@ -11,7 +11,7 @@
     | [<samp>&nbsp;&nbsp;-&nbsp;name</samp>](## "wan_path_groups.[].name") | String | Required, Unique |  |  | Path-group name. |
     | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;id</samp>](## "wan_path_groups.[].id") | Integer | Required |  |  | Path-group id.<br><br>TODO: Required until an auto ID algorithm is implemented. |
     | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;description</samp>](## "wan_path_groups.[].description") | String |  |  |  | Additional information about the path-group for documentation purposes. |
-    | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;ipsec</samp>](## "wan_path_groups.[].ipsec") | Boolean |  |  |  | Flag to configure IPsec on the path_group (default is True). |
+    | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;ipsec</samp>](## "wan_path_groups.[].ipsec") | Boolean |  | `True` |  | Flag to configure IPsec on the path-group. |
     | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;import_path_groups</samp>](## "wan_path_groups.[].import_path_groups") | List, items: Dictionary |  |  |  | List of [ath-groups to import in this path-group. |
     | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;-&nbsp;remote</samp>](## "wan_path_groups.[].import_path_groups.[].remote") | String |  |  |  | Remote path-group to import. |
     | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;local</samp>](## "wan_path_groups.[].import_path_groups.[].local") | String |  |  |  | Optional, if not set, the path-group `name` is used as local. |
@@ -34,8 +34,8 @@
         # Additional information about the path-group for documentation purposes.
         description: <str>
 
-        # Flag to configure IPsec on the path_group (default is True).
-        ipsec: <bool>
+        # Flag to configure IPsec on the path-group.
+        ipsec: <bool; default=True>
 
         # List of [ath-groups to import in this path-group.
         import_path_groups:

diff --git a/ansible_collections/arista/avd/roles/eos_designs/python_modules/overlay/utils.py b/ansible_collections/arista/avd/roles/eos_designs/python_modules/overlay/utils.py
@@ -465,7 +465,7 @@ def _stun_server_profiles(self) -> list:
                 stun_server_profiles.setdefault(path_group["name"], []).extend(
                     {
                         "name": self._stun_server_profile_name(wan_route_server, path_group["name"], get(interface_dict, "name", required=True)),
-                        "ip_address": get(interface_dict, "ip_address", required=True),
+                        "ip_address": get(interface_dict, "ip_address", required=True).split("/")[0],
                     }
                     for interface_dict in get(path_group, "interfaces", required=True)
                 )

diff --git a/ansible_collections/arista/avd/roles/eos_designs/schemas/eos_designs.jsonschema.json b/ansible_collections/arista/avd/roles/eos_designs/schemas/eos_designs.jsonschema.json
diff --git a/ansible_collections/arista/avd/roles/eos_designs/schemas/eos_designs.schema.yml b/ansible_collections/arista/avd/roles/eos_designs/schemas/eos_designs.schema.yml
diff --git a/...ista/avd/roles/eos_designs/schemas/schema_fragments/defs_l3_edge_l3_interfaces.schema.yml b/...ista/avd/roles/eos_designs/schemas/schema_fragments/defs_l3_edge_l3_interfaces.schema.yml
@@ -50,7 +50,7 @@ $defs:
         peer_ip:
           type: str
           description: |-
-            The peer device IP/Mask. Used as default route gateway is `set_default_route` is true and `ip` is an IP address.
+            The peer device IPv4 address/Mask. Used as default route gateway if `set_default_route` is true and `ip` is an IP address.
         qos_profile:
           type: str
           description: QOS service profile.

diff --git a/...lections/arista/avd/roles/eos_designs/schemas/schema_fragments/wan_path_groups.schema.yml b/...lections/arista/avd/roles/eos_designs/schemas/schema_fragments/wan_path_groups.schema.yml
@@ -32,7 +32,8 @@ keys:
           description: Additional information about the path-group for documentation purposes.
         ipsec:
           type: bool
-          description: Flag to configure IPsec on the path_group (default is True).
+          description: Flag to configure IPsec on the path-group.
+          default: true
         import_path_groups:
           type: list
           description: List of [ath-groups to import in this path-group.