[Feature]: add NSISTP product and workflows to example orchestrator (#53)

* Created product type, blocks, workflows and migration files

* Initial working version of NSI

* Restructered with working create_form

* Selecting of vlans works

* Using CustomRanges

* Nsistp products types and workflow now works

* Removed unused / unnecessary code

* Added single dispatch for subscription description and some minor adjustments

* Added documentation

* Remove forms volume from docker-compose

Removed forms volume from orchestrator service.

* Netbox Docker image back to v4.4.1

Updated the Netbox base image to version 4.4.1.

* Removed unused exceptions

* reformat with line lengt 120 again

* Revert "Removed unused exceptions"

This reverts commit 0a9c1cc.

At least PortsValueError is needed ...

* move flake8 options from pyproject.toml to .flake8 where they are recognized

* make nsistp description uniform with other descriptions + add node name

* refactor input form field used to get port

* add form input field validation to modify nsistp + fix subscription description

* remove unneeded AllowedNumberOfNsistpPorts

* reformat with line length set to 120

* improve resource type descriptions + fix nsistp generator yaml

* address review done by @Mark90

* Processed comment Mark

---------

Co-authored-by: Thomas van der Ven <thomas.vanderven@surf.nl>
Co-authored-by: Hans Trompert <hans.trompert@surf.nl>

Author: 3 people

.flake8

@@ -0,0 +1,2 @@
+[flake8]
+max-line-length = 120

README.md

@@ -6,12 +6,11 @@
 
 """
 
-import sqlalchemy as sa
 from alembic import op
 
 # revision identifiers, used by Alembic.
 revision = "0e8d17ce0f06"
-down_revision = "d946c20663d3"
+down_revision = "bc54616fefcf"
 branch_labels = None
 depends_on = None
 

migrations/versions/schema/2025-08-28_0e8d17ce0f06_reconcile_workflows_l2vpn.py

@@ -0,0 +1,101 @@
+"""Add nsistp product.
+
+Revision ID: a87d11eb8dd1
+Revises: 0e8d17ce0f06
+Create Date: 2025-09-30 15:50:36.882313
+
+"""
+
+from uuid import uuid4
+
+from alembic import op
+from orchestrator.migrations.helpers import create, create_workflow, delete, delete_workflow, ensure_default_workflows
+from orchestrator.targets import Target
+
+# revision identifiers, used by Alembic.
+revision = "a87d11eb8dd1"
+down_revision = "0e8d17ce0f06"
+branch_labels = None
+depends_on = None
+
+new_products = {
+    "products": {
+        "nsistp": {
+            "product_id": uuid4(),
+            "product_type": "Nsistp",
+            "description": "NSISTP",
+            "tag": "NSISTP",
+            "status": "active",
+            "root_product_block": "Nsistp",
+            "fixed_inputs": {},
+        },
+    },
+    "product_blocks": {
+        "Nsistp": {
+            "product_block_id": uuid4(),
+            "description": "nsistp product block",
+            "tag": "NSISTP",
+            "status": "active",
+            "resources": {
+                "topology": "Name of the topology this Service Termination Point is exposed in",
+                "stp_id": "Unique identifier for the Service Termination Point",
+                "stp_description": "Description of the Service Termination Point",
+                "is_alias_in": "Inbound port from the other topology in case this STP is part of a SDP",
+                "is_alias_out": "Outbound port from the other topology in case this STP is part of a SDP",
+                "expose_in_topology": "Whether to actively expose this STP in the topology",
+                "bandwidth": "Maximum bandwidth for the combined set of STP (in Mbps)",
+            },
+            "depends_on_block_relations": [
+                "SAP",
+            ],
+        },
+    },
+    "workflows": {},
+}
+
+new_workflows = [
+    {
+        "name": "create_nsistp",
+        "target": Target.CREATE,
+        "is_task": False,
+        "description": "Create nsistp",
+        "product_type": "Nsistp",
+    },
+    {
+        "name": "modify_nsistp",
+        "target": Target.MODIFY,
+        "is_task": False,
+        "description": "Modify nsistp",
+        "product_type": "Nsistp",
+    },
+    {
+        "name": "terminate_nsistp",
+        "target": Target.TERMINATE,
+        "is_task": False,
+        "description": "Terminate nsistp",
+        "product_type": "Nsistp",
+    },
+    {
+        "name": "validate_nsistp",
+        "target": Target.VALIDATE,
+        "is_task": True,
+        "description": "Validate nsistp",
+        "product_type": "Nsistp",
+    },
+]
+
+
+def upgrade() -> None:
+    conn = op.get_bind()
+    create(conn, new_products)
+    for workflow in new_workflows:
+        create_workflow(conn, workflow)
+    ensure_default_workflows(conn)
+
+
+def downgrade() -> None:
+    conn = op.get_bind()
+    for workflow in new_workflows:
+        delete_workflow(conn, workflow["name"])
+
+    delete(conn, new_products)

migrations/versions/schema/2025-09-30_a87d11eb8dd1_add_nsistp.py

@@ -17,6 +17,7 @@
 from products.product_types.core_link import CoreLink
 from products.product_types.l2vpn import L2vpn
 from products.product_types.node import Node
+from products.product_types.nsistp import Nsistp
 from products.product_types.port import Port
 
 SUBSCRIPTION_MODEL_REGISTRY.update(
@@ -30,5 +31,6 @@
         "core link 10G": CoreLink,
         "core link 100G": CoreLink,
         "l2vpn": L2vpn,
+        "nsistp": Nsistp,
     }
 )

products/__init__.py

@@ -0,0 +1,57 @@
+# Copyright 2019-2023 SURF.
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+from orchestrator.domain.base import ProductBlockModel
+from orchestrator.types import SubscriptionLifecycle
+from pydantic import computed_field
+
+from products.product_blocks.sap import SAPBlock, SAPBlockInactive, SAPBlockProvisioning
+
+
+class NsistpBlockInactive(ProductBlockModel, product_block_name="Nsistp"):
+    sap: SAPBlockInactive
+    topology: str | None = None
+    stp_id: str | None = None
+    stp_description: str | None = None
+    is_alias_in: str | None = None
+    is_alias_out: str | None = None
+    expose_in_topology: bool | None = None
+    bandwidth: int | None = None
+
+
+class NsistpBlockProvisioning(NsistpBlockInactive, lifecycle=[SubscriptionLifecycle.PROVISIONING]):
+    sap: SAPBlockProvisioning
+    topology: str
+    stp_id: str
+    stp_description: str | None = None
+    is_alias_in: str | None = None
+    is_alias_out: str | None = None
+    expose_in_topology: bool | None = None
+    bandwidth: int | None = None
+
+    @computed_field
+    @property
+    def title(self) -> str:
+        return f"NSISTP {self.stp_id} on {self.sap.title}"
+
+
+class NsistpBlock(NsistpBlockProvisioning, lifecycle=[SubscriptionLifecycle.ACTIVE]):
+    sap: SAPBlock
+    topology: str
+    stp_id: str
+    stp_description: str | None = None
+    is_alias_in: str | None = None
+    is_alias_out: str | None = None
+    expose_in_topology: bool | None = None
+    bandwidth: int | None = None

products/product_blocks/nsistp.py

@@ -12,12 +12,12 @@
 # limitations under the License.
 
 
-from pydantic_forms.types import strEnum
 from typing import List
 
 from orchestrator.domain.base import ProductBlockModel
 from orchestrator.types import SubscriptionLifecycle
 from pydantic import computed_field
+from pydantic_forms.types import strEnum
 
 from products.product_blocks.node import NodeBlock, NodeBlockInactive, NodeBlockProvisioning
 

products/product_blocks/port.py

@@ -27,7 +27,7 @@ class SAPBlockInactive(ProductBlockModel, product_block_name="SAP"):
 
 class SAPBlockProvisioning(SAPBlockInactive, lifecycle=[SubscriptionLifecycle.PROVISIONING]):
     port: PortBlockProvisioning
-    vlan: int
+    vlan: int  # TODO: refactor to CustomVlanRanges together with L2VPN product and workflow
     ims_id: int | None = None
 
     @computed_field  # type: ignore[misc]
@@ -38,5 +38,5 @@ def title(self) -> str:
 
 class SAPBlock(SAPBlockProvisioning, lifecycle=[SubscriptionLifecycle.ACTIVE]):
     port: PortBlock
-    vlan: int
+    vlan: int  # TODO: refactor to CustomVlanRanges together with L2VPN product and workflow
     ims_id: int

products/product_blocks/sap.py

@@ -0,0 +1,35 @@
+# Copyright 2019-2023 SURF.
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+from orchestrator.domain.base import SubscriptionModel
+from orchestrator.types import SubscriptionLifecycle
+
+from products.product_blocks.nsistp import NsistpBlock, NsistpBlockInactive, NsistpBlockProvisioning
+from workflows.nsistp.shared.shared import CustomVlanRanges
+
+
+class NsistpInactive(SubscriptionModel, is_base=True):
+    nsistp: NsistpBlockInactive
+
+
+class NsistpProvisioning(NsistpInactive, lifecycle=[SubscriptionLifecycle.PROVISIONING]):
+    nsistp: NsistpBlockProvisioning
+
+
+class Nsistp(NsistpProvisioning, lifecycle=[SubscriptionLifecycle.ACTIVE]):
+    nsistp: NsistpBlock
+
+    @property
+    def vlan_range(self) -> CustomVlanRanges:
+        return self.nsistp.sap.vlan

products/product_types/nsistp.py

@@ -21,6 +21,7 @@
 from products.product_types.core_link import CoreLinkProvisioning
 from products.product_types.l2vpn import L2vpnProvisioning
 from products.product_types.node import NodeProvisioning
+from products.product_types.nsistp import NsistpProvisioning
 from products.product_types.port import PortProvisioning
 from utils.singledispatch import single_dispatch_base
 
@@ -79,3 +80,14 @@ def _(l2vpn: L2vpnProvisioning) -> str:
         f"{l2vpn.virtual_circuit.speed} Mbit/s "
         f"({'-'.join(sorted(list(set([sap.port.node.node_name for sap in l2vpn.virtual_circuit.saps]))))})"
     )
+
+
+@description.register
+def _(nsistp: NsistpProvisioning) -> str:
+    return (
+        f"{nsistp.product.tag} "
+        f"{nsistp.nsistp.stp_id} "
+        f"topology {nsistp.nsistp.topology} "
+        f"{nsistp.nsistp.sap.port.node.node_name} "
+        f"{nsistp.nsistp.bandwidth} Mbit/s"
+    )