Feat(cv_deploy): Add CV Pathfinder AVT hop count to metadata studio (#…

…4071) Co-authored-by: gmuloc <gmulocher@arista.com>
aristanetworks · Jul 23, 2024 · d8c0d45 · d8c0d45
1 parent 0187ec9
commit d8c0d45
Show file tree

Hide file tree

Showing 11 changed files with 37 additions and 2 deletions.
diff --git a/...ts/intended/structured_configs/cv-pathfinder-custom-control-plane-policy-pathfinder-1.yml b/...ts/intended/structured_configs/cv-pathfinder-custom-control-plane-policy-pathfinder-1.yml
@@ -534,6 +534,7 @@ metadata:
       avts:
       - constraints:
           jitter: 5
+          hop_count: lowest
         id: 254
         name: CUSTOM-CP-POLICY
         pathgroups:

diff --git a/.../molecule/eos_designs_unit_tests/intended/structured_configs/cv-pathfinder-pathfinder.yml b/.../molecule/eos_designs_unit_tests/intended/structured_configs/cv-pathfinder-pathfinder.yml
@@ -648,6 +648,7 @@ metadata:
       avts:
       - constraints:
           jitter: 42
+          hop_count: lowest
         id: 2
         name: PROD-AVT-POLICY-VOICE
         pathgroups:

diff --git a/...molecule/eos_designs_unit_tests/intended/structured_configs/cv-pathfinder-pathfinder1.yml b/...molecule/eos_designs_unit_tests/intended/structured_configs/cv-pathfinder-pathfinder1.yml
@@ -643,6 +643,7 @@ metadata:
       avts:
       - constraints:
           jitter: 42
+          hop_count: lowest
         id: 2
         name: PROD-AVT-POLICY-VOICE
         pathgroups:

diff --git a/...molecule/eos_designs_unit_tests/intended/structured_configs/cv-pathfinder-pathfinder2.yml b/...molecule/eos_designs_unit_tests/intended/structured_configs/cv-pathfinder-pathfinder2.yml
@@ -671,6 +671,7 @@ metadata:
       avts:
       - constraints:
           jitter: 42
+          hop_count: lowest
         id: 2
         name: PROD-AVT-POLICY-VOICE
         pathgroups:

diff --git a/ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/metadata.md b/ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/metadata.md
@@ -60,6 +60,7 @@
     | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;jitter</samp>](## "metadata.cv_pathfinder.vrfs.[].avts.[].constraints.jitter") | Integer |  |  |  |  |
     | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;latency</samp>](## "metadata.cv_pathfinder.vrfs.[].avts.[].constraints.latency") | Integer |  |  |  |  |
     | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;lossrate</samp>](## "metadata.cv_pathfinder.vrfs.[].avts.[].constraints.lossrate") | String |  |  |  |  |
+    | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;hop_count</samp>](## "metadata.cv_pathfinder.vrfs.[].avts.[].constraints.hop_count") | String |  |  |  |  |
     | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;description</samp>](## "metadata.cv_pathfinder.vrfs.[].avts.[].description") | String |  |  |  |  |
     | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;id</samp>](## "metadata.cv_pathfinder.vrfs.[].avts.[].id") | Integer |  |  |  |  |
     | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;name</samp>](## "metadata.cv_pathfinder.vrfs.[].avts.[].name") | String |  |  |  |  |
@@ -144,6 +145,7 @@
                   jitter: <int>
                   latency: <int>
                   lossrate: <str>
+                  hop_count: <str>
                 description: <str>
                 id: <int>
                 name: <str>

diff --git a/python-avd/pyavd/_cv/workflows/deploy_cv_pathfinder_metadata_to_cv.py b/python-avd/pyavd/_cv/workflows/deploy_cv_pathfinder_metadata_to_cv.py
@@ -34,6 +34,11 @@ def is_pathfinder_location_supported(studio_schema: InputSchema) -> bool:
     return attributes.issubset(pathfinder_group_fields)
 
 
+def is_avt_hop_count_supported(studio_schema: InputSchema) -> bool:
+    """Detect if AVT hop count is supported by the metadata studio"""
+    return bool(get_v2(studio_schema, "fields.values.avtHopCount"))
+
+
 def is_internet_exit_zscaler_supported(studio_schema: InputSchema) -> bool:
     """Detect if zscaler internet exit is supported by the metadata studio"""
     return bool(get_v2(studio_schema, "fields.values.zscaler"))
@@ -58,17 +63,26 @@ async def get_metadata_studio_schema(result: DeployToCvResult, cv_client: CVClie
     return studio_schema
 
 
-def update_general_metadata(metadata: dict, studio_inputs: dict) -> None:
+def update_general_metadata(metadata: dict, studio_inputs: dict, studio_schema: InputSchema) -> list[str]:
     """
     In-place update general metadata in studio_inputs.
     """
+    warnings = []
+
     # Temporary fix for default values in metadata studio
     for vrf in get(metadata, "vrfs", default=[]):
         for avt in get(vrf, "avts", default=[]):
             constraints: dict = avt.setdefault("constraints", {})
             constraints.setdefault("latency", 4294967295)
             constraints.setdefault("jitter", 4294967295)
             constraints.setdefault("lossrate", 99.0)
+            if is_avt_hop_count_supported(studio_schema):
+                constraints["hopCount"] = constraints.pop("hop_count", "")
+            elif constraints.pop("hop_count", ""):
+                # hop count is set but not supported by metadata studio.
+                warning = "deploy_cv_pathfinder_metadata_to_cv: Ignoring AVT hop-count information since it is not supported by metadata studio."
+                LOGGER.info(warning)
+                warnings.append(warning)
 
     studio_inputs.update(
         {
@@ -85,6 +99,8 @@ def update_general_metadata(metadata: dict, studio_inputs: dict) -> None:
         }
     )
 
+    return warnings
+
 
 def upsert_pathfinder(metadata: dict, device: CVDevice, studio_inputs: dict, studio_schema: InputSchema) -> list[str]:
     """
@@ -329,7 +345,7 @@ async def deploy_cv_pathfinder_metadata_to_cv(cv_pathfinder_metadata: list[CVPat
 
     if pathfinders:
         # All pathfinders must have the same be general metadata, so we just set it in the studio based on the first one.
-        update_general_metadata(metadata=pathfinders[0].metadata, studio_inputs=studio_inputs)
+        result.warnings.extend(update_general_metadata(metadata=pathfinders[0].metadata, studio_inputs=studio_inputs, studio_schema=studio_schema))
 
     for pathfinder in pathfinders:
         result.warnings.extend(

diff --git a/python-avd/pyavd/_eos_cli_config_gen/schema/eos_cli_config_gen.jsonschema.json b/python-avd/pyavd/_eos_cli_config_gen/schema/eos_cli_config_gen.jsonschema.json
@@ -12047,6 +12047,10 @@
                             "lossrate": {
                               "type": "string",
                               "title": "Lossrate"
+                            },
+                            "hop_count": {
+                              "type": "string",
+                              "title": "Hop Count"
                             }
                           },
                           "additionalProperties": false,

diff --git a/python-avd/pyavd/_eos_cli_config_gen/schema/eos_cli_config_gen.schema.yml b/python-avd/pyavd/_eos_cli_config_gen/schema/eos_cli_config_gen.schema.yml
@@ -7138,6 +7138,8 @@ keys:
                             type: str
                             convert_types:
                             - float
+                          hop_count:
+                            type: str
                       description:
                         type: str
                       id:

diff --git a/python-avd/pyavd/_eos_cli_config_gen/schema/schema_fragments/metadata.schema.yml b/python-avd/pyavd/_eos_cli_config_gen/schema/schema_fragments/metadata.schema.yml
@@ -170,6 +170,8 @@ keys:
                             type: str
                             convert_types:
                               - float
+                          hop_count:
+                            type: str
                       description:
                         type: str
                       id:

diff --git a/python-avd/pyavd/_eos_designs/schema/eos_designs.jsonschema.json b/python-avd/pyavd/_eos_designs/schema/eos_designs.jsonschema.json
@@ -29955,6 +29955,10 @@
                                       "lossrate": {
                                         "type": "string",
                                         "title": "Lossrate"
+                                      },
+                                      "hop_count": {
+                                        "type": "string",
+                                        "title": "Hop Count"
                                       }
                                     },
                                     "additionalProperties": false,

diff --git a/python-avd/pyavd/_eos_designs/structured_config/metadata/cv_pathfinder.py b/python-avd/pyavd/_eos_designs/structured_config/metadata/cv_pathfinder.py
@@ -166,6 +166,7 @@ def _metadata_vrfs(self: AvdStructuredConfigMetadata) -> list:
                             "jitter": lb_policy.get("jitter"),
                             "latency": lb_policy.get("latency"),
                             "lossrate": float(lb_policy["loss_rate"]) if "loss_rate" in lb_policy else None,
+                            "hop_count": "lowest" if lb_policy.get("lowest_hop_count") else None,
                         },
                         "description": "",  # TODO: Not sure we have this field anywhere
                         "id": profile["id"],