Encap type support for edge and isls (#120)

FloSch62 · web-flow · commit 2d17ece3f1f7 · 2025-09-30T16:29:58.000+02:00
* update ignore

* encap type args for edge and isl

* ruff lint
diff --git a/.gitignore b/.gitignore
@@ -166,4 +166,6 @@ example-topologies/*/
 
 .envrc
 CLAUDE.md
-AGENTS.md
+AGENTS.md
+license.txt
+patch.sh
diff --git a/README.md b/README.md
@@ -148,6 +148,8 @@ clab-connector integrate \
 | `--log-file`, `-f`      | No       | None    | Optional log file path                                 |
 | `--verify`              | No       | False   | Enable certificate verification for EDA                |
 | `--skip-edge-intfs`     | No       | False   | Skip creation of edge links and their interfaces       |
+| `--edge-encapsulation`  | No       | None    | Encapsulation for generated edge interfaces (`dot1q`)  |
+| `--isl-encapsulation`   | No       | None    | Encapsulation for inter-switch interfaces (`dot1q`)    |
 
 
 > [!NOTE]
@@ -253,6 +255,8 @@ clab-connector generate-crs \
 | `--log-level`, `-l`     | No       | INFO    | Logging level (DEBUG/INFO/WARNING/ERROR/CRITICAL)      |
 | `--log-file`, `-f`      | No       | None    | Optional log file path                                 |
 | `--skip-edge-intfs`     | No       | False   | Skip creation of edge links and their interfaces       |
+| `--edge-encapsulation`  | No       | None    | Encapsulation for generated edge interfaces (`dot1q`)  |
+| `--isl-encapsulation`   | No       | None    | Encapsulation for inter-switch interfaces (`dot1q`)    |
 | `--namespace`, `-n`     | No       | None    | Namespace to use instead of deriving from the topology |
 
 
diff --git a/clab_connector/cli/main.py b/clab_connector/cli/main.py
@@ -35,6 +35,11 @@ class LogLevel(str, Enum):
     CRITICAL = "CRITICAL"
 
 
+class InterfaceEncapsulation(str, Enum):
+    UNTAGGED = "untagged"
+    DOT1Q = "dot1q"
+
+
 app = typer.Typer(
     name="clab-connector",
     help="Integrate or remove an existing containerlab topology with EDA (Event-Driven Automation)",
@@ -55,6 +60,20 @@ class LogLevel(str, Enum):
     help="Optional log file path",
 )
 
+edge_encapsulation_option = typer.Option(
+    None,
+    "--edge-encapsulation",
+    help="Encapsulation type for generated edge interfaces",
+    case_sensitive=False,
+)
+
+isl_encapsulation_option = typer.Option(
+    None,
+    "--isl-encapsulation",
+    help="Encapsulation type for generated inter-switch link interfaces",
+    case_sensitive=False,
+)
+
 
 def complete_json_files(
     _ctx: typer.Context, _param: typer.Option, incomplete: str
@@ -81,7 +100,7 @@ def complete_eda_url(
 
 
 @app.command(name="integrate", help="Integrate containerlab with EDA")
-def integrate_cmd(
+def integrate_cmd(  # noqa: PLR0913
     topology_data: Annotated[
         Path,
         typer.Option(
@@ -147,6 +166,8 @@ def integrate_cmd(
         "--sync-timeout",
         help="Timeout for node synchronization check in seconds",
     ),
+    edge_encapsulation: InterfaceEncapsulation | None = edge_encapsulation_option,
+    isl_encapsulation: InterfaceEncapsulation | None = isl_encapsulation_option,
 ):
     """CLI command to integrate a containerlab topology with EDA."""
 
@@ -172,6 +193,14 @@ class Args:
     args.skip_edge_intfs = skip_edge_intfs
     args.enable_sync_check = enable_sync_check
     args.sync_timeout = sync_timeout
+    if edge_encapsulation and edge_encapsulation != InterfaceEncapsulation.UNTAGGED:
+        args.edge_encapsulation = edge_encapsulation.value
+    else:
+        args.edge_encapsulation = None
+    if isl_encapsulation and isl_encapsulation != InterfaceEncapsulation.UNTAGGED:
+        args.isl_encapsulation = isl_encapsulation.value
+    else:
+        args.isl_encapsulation = None
 
     def execute_integration(a):
         eda_client = create_eda_client(
@@ -193,6 +222,8 @@ def execute_integration(a):
             topology_file=a.topology_data,
             skip_edge_intfs=a.skip_edge_intfs,
             namespace_override=a.namespace_override,
+            edge_encapsulation=a.edge_encapsulation,
+            isl_encapsulation=a.isl_encapsulation,
         )
 
     try:
@@ -364,6 +395,8 @@ def generate_crs_cmd(
         "--skip-edge-intfs",
         help="Skip creation of edge links and their interfaces",
     ),
+    edge_encapsulation: InterfaceEncapsulation | None = edge_encapsulation_option,
+    isl_encapsulation: InterfaceEncapsulation | None = isl_encapsulation_option,
 ):
     """
     Generate the CR YAML manifests (artifacts, init, node security profile,
@@ -383,6 +416,18 @@ def generate_crs_cmd(
             separate=separate,
             skip_edge_intfs=skip_edge_intfs,
             namespace=namespace_override,
+            edge_encapsulation=(
+                edge_encapsulation.value
+                if edge_encapsulation
+                and edge_encapsulation != InterfaceEncapsulation.UNTAGGED
+                else None
+            ),
+            isl_encapsulation=(
+                isl_encapsulation.value
+                if isl_encapsulation
+                and isl_encapsulation != InterfaceEncapsulation.UNTAGGED
+                else None
+            ),
         )
         generator.generate()
         generator.output_manifests()
diff --git a/clab_connector/models/node/arista_ceos.py b/clab_connector/models/node/arista_ceos.py
@@ -162,23 +162,40 @@ def get_topolink_interface_name(self, topology, ifname):
         # No longer strip out the 'ethernet-' prefix to maintain consistency with SR Linux
         return f"{node_name}-{eda_ifname}"
 
-    def get_topolink_interface(self, topology, ifname, other_node):
+    def get_topolink_interface(
+        self,
+        topology,
+        ifname,
+        other_node,
+        edge_encapsulation: str | None = None,
+        isl_encapsulation: str | None = None,
+    ):
         """
         Render the Interface CR YAML for an cEOS link endpoint.
         """
         logger.debug(f"{SUBSTEP_INDENT}Creating topolink interface for {self.name}")
         role = "interSwitch"
         if other_node is None or not other_node.is_eda_supported():
             role = "edge"
+        peer_name = (
+            other_node.get_node_name(topology)
+            if other_node is not None
+            else "external-endpoint"
+        )
+        if role == "edge":
+            encap_type = "dot1q" if edge_encapsulation == "dot1q" else None
+        else:
+            encap_type = "dot1q" if isl_encapsulation == "dot1q" else None
+
         data = {
             "namespace": topology.namespace,
             "interface_name": self.get_topolink_interface_name(topology, ifname),
             "label_key": "eda.nokia.com/role",
             "label_value": role,
-            "encap_type": "'null'",
+            "encap_type": encap_type,
             "node_name": self.get_node_name(topology),
             "interface": self.get_interface_name_for_kind(ifname),
-            "description": f"{role} link to {other_node.get_node_name(topology)}",
+            "description": f"{role} link to {peer_name}",
         }
         return helpers.render_template("interface.j2", data)
 
diff --git a/clab_connector/models/node/base.py b/clab_connector/models/node/base.py
@@ -214,7 +214,14 @@ def get_topolink_interface_name(self, topology, ifname):
             f"{self.get_node_name(topology)}-{self.get_interface_name_for_kind(ifname)}"
         )
 
-    def get_topolink_interface(self, _topology, _ifname, _other_node):
+    def get_topolink_interface(
+        self,
+        _topology,
+        _ifname,
+        _other_node,
+        _edge_encapsulation: str | None = None,
+        _isl_encapsulation: str | None = None,
+    ):
         """
         Render and return the interface resource YAML (Interface CR) for a link endpoint.
 
diff --git a/clab_connector/models/node/nokia_srl.py b/clab_connector/models/node/nokia_srl.py
@@ -253,7 +253,14 @@ def get_interface_name_for_kind(self, ifname):
             return f"ethernet-{match.group(1)}-{match.group(2)}"
         return ifname
 
-    def get_topolink_interface(self, topology, ifname, other_node):
+    def get_topolink_interface(
+        self,
+        topology,
+        ifname,
+        other_node,
+        edge_encapsulation: str | None = None,
+        isl_encapsulation: str | None = None,
+    ):
         """
         Render the Interface CR YAML for an SR Linux link endpoint.
 
@@ -275,15 +282,25 @@ def get_topolink_interface(self, topology, ifname, other_node):
         role = "interSwitch"
         if other_node is None or not other_node.is_eda_supported():
             role = "edge"
+        peer_name = (
+            other_node.get_node_name(topology)
+            if other_node is not None
+            else "external-endpoint"
+        )
+        if role == "edge":
+            encap_type = "dot1q" if edge_encapsulation == "dot1q" else None
+        else:
+            encap_type = "dot1q" if isl_encapsulation == "dot1q" else None
+
         data = {
             "namespace": topology.namespace,
             "interface_name": self.get_topolink_interface_name(topology, ifname),
             "label_key": "eda.nokia.com/role",
             "label_value": role,
-            "encap_type": "'null'",
+            "encap_type": encap_type,
             "node_name": self.get_node_name(topology),
             "interface": self.get_interface_name_for_kind(ifname),
-            "description": f"{role} link to {other_node.get_node_name(topology)}",
+            "description": f"{role} link to {peer_name}",
         }
         return helpers.render_template("interface.j2", data)
 
diff --git a/clab_connector/models/node/nokia_sros.py b/clab_connector/models/node/nokia_sros.py
@@ -338,23 +338,40 @@ def get_topolink_interface_name(self, topology, ifname):
         # No longer strip out the 'ethernet-' prefix to maintain consistency with SR Linux
         return f"{node_name}-{eda_ifname}"
 
-    def get_topolink_interface(self, topology, ifname, other_node):
+    def get_topolink_interface(
+        self,
+        topology,
+        ifname,
+        other_node,
+        edge_encapsulation: str | None = None,
+        isl_encapsulation: str | None = None,
+    ):
         """
         Render the Interface CR YAML for an SROS link endpoint.
         """
         logger.debug(f"{SUBSTEP_INDENT}Creating topolink interface for {self.name}")
         role = "interSwitch"
         if other_node is None or not other_node.is_eda_supported():
             role = "edge"
+        peer_name = (
+            other_node.get_node_name(topology)
+            if other_node is not None
+            else "external-endpoint"
+        )
+        if role == "edge":
+            encap_type = "dot1q" if edge_encapsulation == "dot1q" else None
+        else:
+            encap_type = "dot1q" if isl_encapsulation == "dot1q" else None
+
         data = {
             "namespace": topology.namespace,
             "interface_name": self.get_topolink_interface_name(topology, ifname),
             "label_key": "eda.nokia.com/role",
             "label_value": role,
-            "encap_type": "'null'",
+            "encap_type": encap_type,
             "node_name": self.get_node_name(topology),
             "interface": self.get_interface_name_for_kind(ifname),
-            "description": f"{role} link to {other_node.get_node_name(topology)}",
+            "description": f"{role} link to {peer_name}",
         }
         return helpers.render_template("interface.j2", data)
 
diff --git a/clab_connector/models/topology.py b/clab_connector/models/topology.py
@@ -175,7 +175,12 @@ def get_topolinks(self, skip_edge_links: bool = False):
                     links.append(link_yaml)
         return links
 
-    def get_topolink_interfaces(self, skip_edge_link_interfaces: bool = False):
+    def get_topolink_interfaces(
+        self,
+        skip_edge_link_interfaces: bool = False,
+        edge_encapsulation: str | None = None,
+        isl_encapsulation: str | None = None,
+    ):
         """
         Generate Interface YAML for each link endpoint (if EDA-supported).
 
@@ -205,7 +210,13 @@ def get_topolink_interfaces(self, skip_edge_link_interfaces: bool = False):
                     and (peer is None or not peer.is_eda_supported())
                 ):
                     continue
-                intf_yaml = node.get_topolink_interface(self, ifname, peer)
+                intf_yaml = node.get_topolink_interface(
+                    self,
+                    ifname,
+                    peer,
+                    edge_encapsulation=edge_encapsulation,
+                    isl_encapsulation=isl_encapsulation,
+                )
                 if intf_yaml:
                     interfaces.append(intf_yaml)
         return interfaces
diff --git a/clab_connector/services/integration/topology_integrator.py b/clab_connector/services/integration/topology_integrator.py
@@ -41,12 +41,16 @@ def __init__(
         self.topology = None
         self.enable_sync_checking = enable_sync_checking
         self.sync_timeout = sync_timeout
+        self.edge_encapsulation: str | None = None
+        self.isl_encapsulation: str | None = None
 
     def run(
         self,
         topology_file,
         skip_edge_intfs: bool = False,
         namespace_override: str | None = None,
+        edge_encapsulation: str | None = None,
+        isl_encapsulation: str | None = None,
     ):
         """
         Parse the topology, run connectivity checks, and create EDA resources.
@@ -73,6 +77,8 @@ def run(
             If any resource fails validation.
         """
         logger.info("Parsing topology for integration")
+        self.edge_encapsulation = edge_encapsulation
+        self.isl_encapsulation = isl_encapsulation
         self.topology = parse_topology_file(
             str(topology_file), namespace=namespace_override
         )
@@ -119,7 +125,11 @@ def run(
         # Nodes are committed in batches within create_toponodes method
 
         logger.info("== Adding topolink interfaces ==")
-        self.create_topolink_interfaces(skip_edge_intfs)
+        self.create_topolink_interfaces(
+            skip_edge_intfs,
+            edge_encapsulation=self.edge_encapsulation,
+            isl_encapsulation=self.isl_encapsulation,
+        )
         # Only commit if there are transactions
         if self.eda_client.transactions:
             self.commit_transaction("create topolink interfaces")
@@ -402,12 +412,19 @@ def create_toponodes(self):
                 )
                 time.sleep(batch_delay)
 
-    def create_topolink_interfaces(self, skip_edge_intfs: bool = False):
+    def create_topolink_interfaces(
+        self,
+        skip_edge_intfs: bool = False,
+        edge_encapsulation: str | None = None,
+        isl_encapsulation: str | None = None,
+    ):
         """
         Create Interface resources for each link endpoint in the topology.
         """
         interfaces = self.topology.get_topolink_interfaces(
-            skip_edge_link_interfaces=skip_edge_intfs
+            skip_edge_link_interfaces=skip_edge_intfs,
+            edge_encapsulation=edge_encapsulation,
+            isl_encapsulation=isl_encapsulation,
         )
         for intf_yaml in interfaces:
             item = self.eda_client.add_replace_to_transaction(intf_yaml)
diff --git a/clab_connector/services/manifest/manifest_generator.py b/clab_connector/services/manifest/manifest_generator.py
@@ -35,6 +35,8 @@ def __init__(
         separate: bool = False,
         skip_edge_intfs: bool = False,
         namespace: str | None = None,
+        edge_encapsulation: str | None = None,
+        isl_encapsulation: str | None = None,
     ):
         """
         Parameters
@@ -59,6 +61,8 @@ def __init__(
         self.separate = separate
         self.skip_edge_intfs = skip_edge_intfs
         self.namespace_override = namespace
+        self.edge_encapsulation = edge_encapsulation
+        self.isl_encapsulation = isl_encapsulation
         self.topology = None
         # Dictionary mapping category name to a list of YAML document strings.
         self.cr_groups = {}
@@ -185,7 +189,9 @@ def generate(self):
 
         # --- Topolink Interfaces
         intfs = self.topology.get_topolink_interfaces(
-            skip_edge_link_interfaces=self.skip_edge_intfs
+            skip_edge_link_interfaces=self.skip_edge_intfs,
+            edge_encapsulation=self.edge_encapsulation,
+            isl_encapsulation=self.isl_encapsulation,
         )
         if intfs:
             self.cr_groups["topolink-interfaces"] = list(intfs)
diff --git a/clab_connector/templates/interface.j2 b/clab_connector/templates/interface.j2
diff --git a/pyproject.toml b/pyproject.toml
diff --git a/uv.lock b/uv.lock
