Overview

What are Workflows?

Using workflows in NSP, you can create automated procedures and closed loop automation using Nokia NSP or 3rd party APIs.

Some example use cases:

Node software upgrades Service activation tests Service fulfillment invoking pre and post deployment workflows

Customizable policy logic for other applications Mass migration of services from one tunnel type to another One place scheduling for all NSP REST APIs and node CLI Centralized orchestration for Nokia NSP and 3rd party vendor APIs

NSP uses Mistral DSL v2 which is based on YAML. YAML defines expressions in workflow and action definitions. The formatting of the YAML must comply with Mistral DSL v2 specifications. For more information about Mistral DSL v2, the workflow hierarchy and associated attributes, refer to the Mistral DSL v2 specification online.

Certain functions within NSP workflows use Python, such as triggers and the nsp.python system action. NSP uses Python version 3.11. Any custom actions created by a user must be compliant with this version.

Developer information

The Network Automation Guide provides an overview for operators.

For detailed information about the following topics for developers, see the Workflows tutorial on the Network Developer Portal.

Using Workflow APIs Creating workflows, including working with schema forms Working with Jinja2 templates Working with environments

Working with ad-hoc actions Working with Kafka triggers Workflow signatures

API support

NSP Workflow functions are available for OSS using programmable APIs. For general information about developer support, visit the Network Developer Portal

For specific documentation about APIs for Workflows, click on API Reference in the Workflow Manager row.

Developer mode

If developer mode is disabled in the NSP, users cannot create, import, modify, or delete workflows, actions, or Jinja2 templates.

See the NSP Installation and Upgrade Guide for more information.

Access control

User groups are assigned access to menus, network resources, and Analytics resources by assigning roles in the NSP. Action permissions are assigned to roles.

Note: Disabling developer mode overrides access control settings. If developer mode is disabled, restricted functions are restricted for all users.

The following table describes scopes that are specific to workflows.

Scope	Available operations
Import	Import all available file types
Write Workflow Artifacts	Create and Edit workflows
Publish Workflow Artifacts	Publish workflows and related artifacts
Manage Executions	Pause, resume, cancel and delete workflow and action executions
Manage Environments	Perform actions in the Environments view
Manage Triggers	Manage Kafka triggers and workflow schedules
Debug	Debug using Flow views, the YAQL evaluator, or code definition views
Execute Workflow Artifacts	Execute workflows and actions. Pause, resume, or cancel workflow executions created by the same user.

The scopes are combined to create the following roles:

• Developer:

  • Import

  • Write Workflow Artifacts

  • Publish Workflow Artifacts

• Troubleshooter:

  • Execute Workflow Artifacts

  • Manage Executions

  • Debug

• Operator:

  • Manage Executions

  • Manage Environments

  • Manage Triggers

  • Execute Workflow Artifacts

• Network Engineer

  • All scopes

Depending on your access settings, some of these pages or operations may not be available to you. See the NSP System Administrator Guide for more information.