with Crosswork Workflow Manager
Crosswork Workflow Manager (CWM) provides a centralized platform for creating, managing, and executing workflows.
In this repository you can find examples of workflows towards NSO and Netbox using pre-built adapters to:
NSO example that we use for the purposes of this workflow is setting up a Layer3 VPN in a service provider MPLS network for two NSO-simulated devices. Example is available in NSO:
examples.ncs/service-provider/mpls-vpn-new-template
The Layer3 VPN service configures the CE/PE routers for the endpoints
in the VPN with BGP as the CE/PE routing protocol.
Make sure you start clean and no old configuration data is present.
make stop clean all start
This will setup the environment and start the simulated network.
Workflow Adapters are tools that allow a workflow to interact with systems outside the CWM. You can see them as agents between the CWM and any external services (in this example NSO and Netbox). Their role is to cause an action in an outside system that's part of a workflow stream, or to retrieve data required by a workflow to progress.
Open CWM in browser, in Admin tab, go to Adapters, upload adapter file by clicking Add Adapter.
Check Create Worker box to automatically create worker for installed adapter.
We need to define the resources and secrets to be passed in securely to the Cisco NSO adapter to authenticate to desired applications. In Admin tab:
Note
Please find detailed instructions on how to install adapter and configure resouce and secret: CWM Documentation
Workflows are defined using a standardized Domain Specific Language based on the Serverless Workflow specification, enabling workflow designers to express complex business processes, dependencies, and decision logic in a unified and readable format.
The purpose of this example workflow is to automatically create a VPN service instance in NSO and configure devices.
We want to translate NSO commands into actions executed in a workflow.
Workflows can be written either in JSON or YAML, all examples available in this repository are JSON files.
vpn l3vpn volvo
route-distinguisher 999
In our workflow it looks like this:
"name": "CreateVPN",
"retryRef": "Custom",
"functionRef": {
"refName": "NSO.RestconfPost",
"arguments": {
"input": {
"data": "{\"l3vpn\":[{\"name\":\"${ .vpn.name }\",\"route-distinguisher\":\"${ .vpn.rd }\"}]} ",
"path": "restconf/data/l3vpn:vpn"
},
"config": {
"resourceId": "NSOLocal"
}}},
vpn l3vpn volvo
endpoint main-office
ce-device ce6
ce-interface GigabitEthernet0/11
ip-network 10.10.1.0/24
as-number 65101
bandwidth 12000000
!
endpoint branch-office1
ce-device ce1
ce-interface GigabitEthernet0/11
ip-network 10.7.7.0/24
as-number 65102
bandwidth 6000000
!
endpoint branch-office2
ce-device ce4
ce-interface GigabitEthernet0/18
ip-network 10.8.8.0/24
as-number 65103
bandwidth 300000
In workflow we will use foreach action to execute it 3 times, once for each endpoint
"name": "ConfigureEndpoints",
"type": "foreach",
"actions": [
{
"name": "ConfigureEndpoint",
"retryRef": "Custom",
"functionRef": {
"refName": "NSO.RestconfPost",
"arguments": {
"input": {
"data": "{\"endpoint\": {\"id\": \"${ .endpoint.name }\",\"ce-device\": \"${ .endpoint.ce }\",\"ce-interface\": \"${ .endpoint.int }\",\"ip-network\": \"${ .endpoint.ip }\",\"bandwidth\": \"${ .endpoint.bw }\"}}",
"path": "restconf/data/l3vpn:vpn/l3vpn=volvo"
},
"config": {
"resourceId": "NSOLocal"
}}},
Endpoint information, as well as vpn name and RD, comes as an input to the Workflow.
Please find workflow complete JSON file here.
To run Workflow, navigate to Workflows tab in CWM UI
Click Create New Workflow.
Once created click on the newly created workflow.
Go to Code tab and paste workflow JSON file and save changes
Click Run button, provide example input data JSON.
Once wokflow execution job is started, you can go to job tab to see the results.
The results are visible in Cisco NSO.
This workflow task is to allocate subnet in Netbox, that later can be used in L3VPN configuration. The communication with Netbox is going to take advantage of generic REST adapter. It means we have to specify exact path and payload of the resource that we want too use. In this example it will be POST to Netbox /api/ipam/prefixes/ with prefix and description in request body.
Please find workflow complete JSON file here.
Once workflow is completed we can se results in Netbox.
Generic REST API adapter can be used to comunicate with any external service acccessible with REST API. In this example we will write workflow that notifies user on its completion.
Please find workflow complete JSON file here.
We can reuse previously created workflows in newly created workflow by calling them inside new workflow definition. Please find workflow complete JSON file here.
Owner
Contributors
Categories
Products
CrossworkNetwork Services Orchestrator (NSO)WebexProgramming Languages
License
Code Exchange Community
Get help, share code, and collaborate with other developers in the Code Exchange community.View Community