From 78f91b3fb70bc34336b73035ebcb79703ab019b6 Mon Sep 17 00:00:00 2001
From: Karel van Klink <karel.vanklink@geant.org>
Date: Wed, 27 Dec 2023 14:31:54 +0100
Subject: [PATCH] add TWAMP deployment workflow
---
gso/translations/en-GB.json | 1 +
gso/workflows/__init__.py | 1 +
gso/workflows/iptrunk/deploy_twamp.py | 86 +++++++++++++++++++++++++++
3 files changed, 88 insertions(+)
create mode 100644 gso/workflows/iptrunk/deploy_twamp.py
diff --git a/gso/translations/en-GB.json b/gso/translations/en-GB.json
index 230d50ea..ef849f98 100644
--- a/gso/translations/en-GB.json
+++ b/gso/translations/en-GB.json
@@ -37,6 +37,7 @@
},
"workflow": {
"confirm_info": "Please verify this form looks correct.",
+ "deploy_twamp": "Deploy TWAMP",
"migrate_iptrunk": "Migrate IP Trunk",
"modify_isis_metric": "Modify the ISIS metric",
"modify_trunk_interface": "Modify IP Trunk interface",
diff --git a/gso/workflows/__init__.py b/gso/workflows/__init__.py
index 06be2f18..28ba2b51 100644
--- a/gso/workflows/__init__.py
+++ b/gso/workflows/__init__.py
@@ -3,6 +3,7 @@
from orchestrator.workflows import LazyWorkflowInstance
LazyWorkflowInstance("gso.workflows.iptrunk.create_iptrunk", "create_iptrunk")
+LazyWorkflowInstance("gso.workflows.iptrunk.deploy_twamp", "deploy_twamp")
LazyWorkflowInstance("gso.workflows.iptrunk.modify_isis_metric", "modify_isis_metric")
LazyWorkflowInstance("gso.workflows.iptrunk.modify_trunk_interface", "modify_trunk_interface")
LazyWorkflowInstance("gso.workflows.iptrunk.migrate_iptrunk", "migrate_iptrunk")
diff --git a/gso/workflows/iptrunk/deploy_twamp.py b/gso/workflows/iptrunk/deploy_twamp.py
new file mode 100644
index 00000000..073aa35e
--- /dev/null
+++ b/gso/workflows/iptrunk/deploy_twamp.py
@@ -0,0 +1,86 @@
+""""Workflow for adding TWAMP to an existing IP trunk."""
+
+from orchestrator.forms import FormPage
+from orchestrator.forms.validators import Label
+from orchestrator.targets import Target
+from orchestrator.types import FormGenerator, State, UUIDstr
+from orchestrator.workflow import StepList, done, init, step, workflow
+from orchestrator.workflows.steps import resync, store_process_subscription, unsync
+from orchestrator.workflows.utils import wrap_modify_initial_input_form
+
+from gso.products.product_types.iptrunk import Iptrunk
+from gso.services.provisioning_proxy import execute_playbook, pp_interaction
+
+
+def _initial_input_form_generator(subscription_id: UUIDstr) -> FormGenerator:
+ trunk = Iptrunk.from_subscription(subscription_id)
+
+ class DeployTWAMPForm(FormPage):
+ info_label: Label = (
+ "Please confirm deployment of TWAMP on IP trunk from "
+ f"{trunk.iptrunk.iptrunk_sides[0].iptrunk_side_node.router_fqdn} to "
+ f"{trunk.iptrunk.iptrunk_sides[1].iptrunk_side_node.router_fqdn}" # type: ignore[assignment]
+ )
+
+ yield DeployTWAMPForm
+
+ return {"subscription": trunk}
+
+
+@step("[DRY RUN] Deploy TWAMP on both sides")
+def deploy_twamp_dry(subscription: Iptrunk, process_id: UUIDstr, callback_route: str) -> State:
+ """Perform a dry run of deploying the TWAMP session."""
+ extra_vars = {
+ "subscription": subscription,
+ "process_id": process_id,
+ "dry_run": True,
+ }
+
+ inventory = (
+ f"{subscription.iptrunk.iptrunk_sides[0].iptrunk_side_node.router_fqdn}"
+ f"\n{subscription.iptrunk.iptrunk_sides[1].iptrunk_side_node.router_fqdn}"
+ )
+
+ execute_playbook("deploy_twamp.yaml", callback_route, inventory, extra_vars)
+
+ return {"subscription": subscription}
+
+
+@step("[FOR REAL] Deploy TWAMP on both sides")
+def deploy_twamp_real(subscription: Iptrunk, process_id: UUIDstr, callback_route: str) -> State:
+ """Deploy the TWAMP session."""
+ extra_vars = {
+ "subscription": subscription,
+ "process_id": process_id,
+ "dry_run": False,
+ }
+
+ inventory = (
+ f"{subscription.iptrunk.iptrunk_sides[0].iptrunk_side_node.router_fqdn}"
+ f"\n{subscription.iptrunk.iptrunk_sides[1].iptrunk_side_node.router_fqdn}"
+ )
+
+ execute_playbook("deploy_twamp.yaml", callback_route, inventory, extra_vars)
+
+ return {"subscription": subscription}
+
+
+@workflow(
+ "Deploy TWAMP",
+ initial_input_form=wrap_modify_initial_input_form(_initial_input_form_generator),
+ target=Target.MODIFY,
+)
+def deploy_twamp() -> StepList:
+ """Deploy a TWAMP session on an IP trunk.
+
+ * Run the TWAMP playbook, including an initial dry run
+ """
+ return (
+ init
+ >> store_process_subscription(Target.MODIFY)
+ >> unsync
+ >> pp_interaction(deploy_twamp_dry)
+ >> pp_interaction(deploy_twamp_real)
+ >> resync
+ >> done
+ )
--
GitLab