updated the code logic plus documentation_options for router id

aristanetworks · Dec 11, 2024 · 4845c38 · 4845c38
1 parent 25d6200
commit 4845c38
Show file tree

Hide file tree

Showing 9 changed files with 28 additions and 46 deletions.
diff --git a/ansible_collections/arista/avd/roles/eos_designs/docs/tables/fabric-settings.md b/ansible_collections/arista/avd/roles/eos_designs/docs/tables/fabric-settings.md
diff --git a/...arista/avd/roles/eos_designs/docs/tables/network-services-vrfs-ospf-settings.md b/...arista/avd/roles/eos_designs/docs/tables/network-services-vrfs-ospf-settings.md
diff --git a/...ions/arista/avd/roles/eos_designs/docs/tables/network-services-vrfs-settings.md b/...ions/arista/avd/roles/eos_designs/docs/tables/network-services-vrfs-settings.md
diff --git a/...ns/arista/avd/roles/eos_designs/docs/tables/use-router-general-for-router-id.md b/...ns/arista/avd/roles/eos_designs/docs/tables/use-router-general-for-router-id.md
diff --git a/python-avd/pyavd/_eos_designs/schema/__init__.py b/python-avd/pyavd/_eos_designs/schema/__init__.py
diff --git a/python-avd/pyavd/_eos_designs/schema/eos_designs.schema.yml b/python-avd/pyavd/_eos_designs/schema/eos_designs.schema.yml
diff --git a/python-avd/pyavd/_eos_designs/schema/schema_fragments/defs_network_services.schema.yml b/python-avd/pyavd/_eos_designs/schema/schema_fragments/defs_network_services.schema.yml
@@ -490,7 +490,7 @@ $defs:
                     type: str
                     description: |-
                       Router ID to use for OSPF in this VRF.
-                      This can be an IP address, "main_router_id", "none", "vtep_diagnostic"
+                      This can be an IPv4 address, "main_router_id", "none" or "vtep_diagnostic".
                       - "main_router_id" will reuse the main OSPF Router ID which is the IP address of Loopback0.
                       - "none" will not configure a OSPF Router ID for this VRF. EOS will use the main OSPF Router ID.
                       - "vtep_diagnostic" will use the IP address of the VRF Diagnostic Loopback interface.
@@ -1068,7 +1068,7 @@ $defs:
                     type: str
                     description: |-
                       Router ID to use for BGP in this VRF.
-                      This can be an IP address, "main_router_id", "none", "vtep_diagnostic"
+                      This can be an IPv4 address, "main_router_id", "none" or "vtep_diagnostic".
                       - "main_router_id" will reuse the main BGP Router ID which is the IP address of Loopback0.
                       - "none" will not configure a BGP Router ID for this VRF. EOS will use the main BGP Router ID.
                       - "vtep_diagnostic" will use the IP address of the VRF Diagnostic Loopback interface.

diff --git a/...vd/pyavd/_eos_designs/schema/schema_fragments/use_router_general_for_router_id.schema.yml b/...vd/pyavd/_eos_designs/schema/schema_fragments/use_router_general_for_router_id.schema.yml
@@ -7,6 +7,8 @@
 type: dict
 keys:
   use_router_general_for_router_id:
+    documentation_options:
+      table: fabric-settings
     type: bool
     description: Use `router general` to set router ID for all routing protocols and VRFs.
     default: false
diff --git a/python-avd/pyavd/_eos_designs/structured_config/network_services/utils.py b/python-avd/pyavd/_eos_designs/structured_config/network_services/utils.py
@@ -414,7 +414,7 @@ def get_vrf_router_id(
 
         Args:
             vrf (VrfsItem): The VRF object containing OSPF/BGP and vtep_diagnostic details.
-            router_id (str): The router ID type specified for the VRF (e.g., "vtep_diagnostic", "main_router_id", "none", or "IPv4 address").
+            router_id (str): The router ID type specified for the VRF (e.g., "vtep_diagnostic", "main_router_id", "none", or an IPv4 address).
             tenant_name (str): The name of the tenant to which the VRF belongs.
 
         Returns:
@@ -425,28 +425,19 @@ def get_vrf_router_id(
         """
         # Handle "vtep_diagnostic" router ID case
         if router_id == "vtep_diagnostic":
-            interface_data = self._get_vtep_diagnostic_loopback_for_vrf(vrf)
-
             # Validate required configuration
-            if interface_data is None:
+            if (interface_data := self._get_vtep_diagnostic_loopback_for_vrf(vrf)) is None:
                 msg = (
                     f"Invalid configuration on VRF '{vrf.name}' in Tenant '{tenant_name}'. "
                     "'vtep_diagnostic.loopback' along with either 'vtep_diagnostic.loopback_ip_pools' or 'vtep_diagnostic.loopback_ip_range' must be defined "
                     "when 'router_id' is set to 'vtep_diagnostic' on the VRF."
                 )
                 raise AristaAvdInvalidInputsError(msg)
-
             # Resolve router ID from loopback interface
-
             return get_ip_from_ip_prefix(interface_data["ip_address"])
-
-        # Handle "main_router_id" with general router ID enabled/disabled
         if router_id == "main_router_id":
-            if not self.inputs.use_router_general_for_router_id:
-                return self.shared_utils.router_id
-            return None
-
-        # Handle "none" router ID or custom value
+            return self.shared_utils.router_id if not self.inputs.use_router_general_for_router_id else None
+        # Handle "none" router ID
         if router_id == "none":
             return None