ONAP Dublin Workflow Designer DRAFT

Version v01 ? Proposed

Date/Time Generated:

11/21/2018 2:26:26 PM

Author:

Chris Rapposelli-Manzo

Name

Workflow Designer

Release

ONAP - Dublin

Contributors

AT&T: SO, VID, SDC WF Independent Distribution
Amdocs: Workflow Editor, Activity Specification,

Dependencies

SDC and SO workflow development of Casablanca release

Ansible/Chef/Puppet servers and scriptbooks for E2E operation

Document last updated :

11/19/18

Document Latest Version:

ONAP Wiki Document link:

High level Key deliverables

Develop functionality to support the execution of user designed workflows using the Self Serve SDC Workflow Designer Editor tool.

Conflict avoidance other than pserver.

Ability to provide Workflow Outputs to the user (although Amdocs may be developing this, it will not be implemented in SO or VID).

Workflow functionality is only applicable to vNFs instantiated on an AIC and does not apply to Flexware(vNFs on uCPE).

Development of new workflow activities (building blocks and actions) in the current release other than those specified in this document.

An option at the VID interface during WF initiation for the user input "skip" a manual task (pause) activity.

Prevent a user from closing a maintenance ticket in the ticketing system when it was opened by the scheduler.

APPC vNF onboarding functionality moving to SDC. This is being handled by Configuration Management project.

Versioning and updating of Activities (BBs and Actions) in SDC in production. In the production environment updating is strictly internal to SO and must not change the activity definition or inputs and outputs.

Ability for SO to auto rollback a user created workflow to the start state of the workflow.

Full Rainy Day Handling as designed for SO workflows will only be available at the existing functionality of building block level.

Deprecation and deletion of workflows and activities (BBs).

Full Versioning of workflows. Workflow modifications that change the WF definition must be newly created vs a new version.

Ability to map vNF properties to an ECOMP Data Dictionary

Use of a Task Handler for notification of a workflow in a "Paused for Manual Task State."

Anything other than the creation of workflows with sequential building blocks and single path post decision points (i.e. follows a yes path or no path exclusively) is not supported e.g. execution of parallel paths in a workflow or concurrent Activities as stated in the customer requirement section (marked as deferred) is not supported.

User experience improvements pertaining to previous projects are Out of scope unless otherwise noted.

1

Ansible/Chef Server not available for testing.

2

Failure to fully deliver ONAP Flow Designer from the Casablanca Release

3

Lack of resources to resolve open issues.

Obtain full commitment from contributors.

4

Lack of Funding or resources causing reduction of features developed and therefore E2E capability not delivered.

Communication that E2E capability cannot be delivered.

5

Lack of fully functional vNFs and corresponding Ansible/Chef/Puppet scripts available for testing

vNF owners to provide vNFs with all required scriptbooks and ensure resources are available in the test environments.

Functional Group

Primary Contacts

Secondary Contact

ONAP Change Management Lead

Ajay Mahimkar

Overall Design

Chris Rapposelli-Manzo - AT&T

Steve Katz, Lauren Lewis- AT&T

SO

Steve Smokowski, Elena Kuleshov - AT&T

Michael Zitella, Keith Dorking - AT&T

SDC

Srini Vellanki - Amdocs, Eden Rozin- AT&T

Priyanshu Agarwal - Amdocs, Edith Ronen & Tali Fridman - AT&T

VID

Golan Harel - AT&T

Eden Rozin - AT&T

Actor Name: Operations User

Stereotype:

Complexity:

Easy

Notes:

Last Updated:

11/12/2018 2:17:10 PM

Object Name: AAI

Stereotype:

«existing»

Complexity:

Notes:

Active and Available Inventory

Impacts

• No Impacts
  

Last Updated:

11/12/2018 3:10:52 PM

Object Name: Portal

Stereotype:

«Push to ONAP»

Complexity:

Notes:

Portal

Impacts

Push Scheduler interface capabilities to ONAP.

Last Updated:

11/12/2018 4:27:13 PM

Object Name: SDC

Stereotype:

«enhance»

Complexity:

Notes:

Service Design and Creation

Impacts
Note Activity inputs are virtual to the WF Editor via SO's use of the Trigger/Pull Patter concept.

• Store Workflow as an independent artifact in Camunda BPMN format with a UUID, invariant UUID, WF description.
  
• TBD - May use a different method for testing and storing successful test data to vNFType/Version. This has to be easy and seamless for operations. *** Workflows will be stored in the vNF model as references to the actual BPMN that will be stored as independent artifacts. Enhance TOSCA Parser to allow ECOMP components to extract the certified workflow names from the vNF Model based on the Service Model.
  
• Develop a copy, rename, save workflow operation. (Workaround is to export WF/rename/import).
  SDC to create a new "WF API" for the WF Editor with two operations:
  1. Get the list of available workflows used by the WF designer
  2. Get the WF meta data used by SO
  
• Distribute new workflow artifact notification to SO (over DMaaP).
  
• Alignment of the WF GUI to ECOMP standards (Initially proposed to come from CasaBlanca, but final timeline TBD).
  
• Deprecation and deletion of workflows is out of scope for this release. This is more complex than it seems on the surface as workflows cannot be deleted until all schedules using that workflow have executed.
  
  Notes:
  
• Only standard ECOMP property names as per HEAT guidelines are used in workflows, For non-HEAT vNFs, a user MUST associate a WF with a vNF operation. When Data Dictionary is developed, vNF properties will be mapped to standard ECOMP properties when onboarded.
  
• Workflows will only be versioned at the major version number level. Workflow inputs/outputs may not be changed. If a workflow is edited in a manner that changes the definition, i.e. the inputs or the outcome of the workflow, it must be copied and (copy may be achieved by exporting/renaming/importing) given a new name.
  SO process to get WF BPMN and meta data:
  
• SO to Invoke WF API with get meta data operation to obtain the Workflow meta data which includes a reference to the BPMN.
  
• SO then invokes an enhanced Generic artifact API to obtain the BPMN based on the BPMN reference in the WF API
  
• Workflows to be given a unique ID (UUID and invariant UUID)
  
• Only major versions of Workflows are supported in this release. What this implies is that an updated workflow will not negatively impact an already scheduled WF (e.g. can add an activity, fix a bug but cannot change inputs/outputs).
  
  
  Note: A data dictionary to map vNF property names provided by the vendor to standard ECOMP property names was not deemed necessary for this release (as per S. Vellanki) as vNF property names that are used by CM workflows are standard based on HEAT Guidelines. Configuration properties need to be standardized if workflows use them from the vNF model. Today, configuration properties are not used and a spreadsheet is uploaded to configure or modify a configuration.
  
  
  User Guidelines Required:
  1. WF and parameter names' and descriptions' guidelines are required for WF designers.
  2. A delete and deprecate WF process is needed.
  
  Future out of scope:
  
• Estimated Length of time for workflow execution to be entered at workflow design time based on the vNF type and included in the vNF
  

Last Updated:

11/12/2018 4:23:54 PM

Object Name: SDN-CP

Stereotype:

«existing»

Complexity:

Notes:

SDN Controller Platform

Impacts

• Are there any actions to push to ONAP?
  
• BAU - Update internal GR Database
  
• BAU create vNFCs
  

Last Updated:

11/12/2018 4:27:48 PM

Object Name: SO

Stereotype:

«enhance»

Complexity:

Medium

Notes:

Service Orchestrator
Impacts

• SO to develop a new API for VID to obtain the list of all available and certified Workflows (SO Native and User Designed) for the user selected vNF Type and the Meta Data for the Selected for Workflow.
  
• The workflow artifact will be versioned at major version level only This implies that only the implementation may change and not the definition (no input/output changes permitted). Full versioning is out of scope.
  
• Enhancement to VID-SO Instantiation API to be more flexible to consume workflow parameters.
  -SO to implemented the Trigger-Pull pattern concept to maintain data complexities within SO in the Casablanca release. This is important for Activities requiring complex inputs to support operations such as Delete & Build and Build & Replace.
  SO maintains the input needs of the activities and obtains the needed data from ECOMP resources or from user inputs from VID and stores them in a data store. As the activities are executed they obtain the needed data from the data store and write their outputs to the data store for subsequent activities to retrieve.
  
• Requires recognition of a new Distribution Notification (over DMaaP) for Workflow Distribution.
  
• SO consumption of ASDC WF API "Get MetaData" to obtain the WF definition/Metadata (WF name, WF Description, UUIDs, inputs, input descriptions, reference to the WF BPMN artifact)
  
• All Activities (building blocks) presently using vNF API will be updated to use GR-API.
  
• SO updates inventory (A&AI) and SDN-CPor SDN-R with new service and vNF model IDs for all SW Upgrade operations.
  
• The minimum requirement for Workflow errors is to execute Rainy Day Handling where the default policy is set to terminate the workflow and issue a TM ticket. The target solution would be for Rainy Day Handling to stop the workflow and allow the user to respond to an error and have a choice to skip/continue or abort. This will be done when possible.
  
• The existing Rainy Handling will be utilized at the Activity (building block) level.
  
• Enhance Resume/Abort communication for use as User/VID response to Manual Handling state.
  
• When the workflow is aborted by the user as the response to "Pause for Manual handling" no trouble ticket is issued.
  
• SO to execute the activities (BBs) BAU.
  
• SO to include the NF_Role in status response to VID.
  
• For change operations that include a new Service and vNF Model IDs, SO must instruct the controller to make the appropriate updates in AAI immediately after the change operation is successful.
  
• All Activities presently using vNF-API must be enhanced to use GR-API.
  If SDC implements the workflow as an independent artifact (may be deferred)
  
• Requires enhancement to SDC/SO Generic Artifact API to "Get" Workflow BPMN. Workflow BPMN is stored as an "independent" artifact in ASDC with an identifier.
  
  Future Requirement NOT Dublin
  
• Ability to rollback a workflow by rolling back each building block or action in the workflow (backward chain). Requires SO to build Rollback into each BB and Action. May also require additional checking at the workflow level to ensure that a full rollback is possible.
  
• Proposal is for Controller to obtain Action parameter/value pairs that are specific to a workflow by "getting" them from SO and other sources and not have them included in the Action API. The concept is to make the action APIs more generic and the internal API function code to have the brains on what parameter values are required and where to get the values. This is consistent with what is being designed for control loop-Service Assurance using policy, however, WFs are more consistent than the Policy concept of Service Assurance.
  

Last Updated:

11/12/2018 3:10:28 PM

Object Name: Scheduler

Stereotype:

«Push to ONAP»

Complexity:

Notes:

ECOMP Scheduler

Impacts

Last Updated:

11/12/2018 4:26:11 PM

Object Name: VID

Stereotype:

«enhanced»

Complexity:

Notes:

Virtual Infrastructure Deployment (MOTS ID: 26377) (PRISM ID: 26377)

Impacts

Impacts

• VID to allow user to search for vNF types based on the Service Model.
  
• VID to provide user with tools that allows them to search and filter the list of vNF instances to obtain the list of instances desired (need input from real users on required filters)
  
• VID will extract the list of available workflows by consuming and using a WF Search API provided by SO.
  
• Available workflows will be listed by unique operation name.
  
• Only workflows shall be displayed for the selected vNF type to the user. Tested and SO Native WFs will be marked as such.
  
• Ingest new API that allows VID to obtain workflow meta data (UUID, invariant UUID, WF input/output parameters). Workflow Meta Data from SO. For this release, SO is the acting Workflow Run Time Catalog (RTC).
  
• Prompt user for workflow input parameters required by the "Workflow". Input parameters are found in the WF Definition/MetaData
  
• VID shall handle both simple and complex input data types (nested arrays).
  
• Accept user input for parameters and package in the workflow request.
  
• Schedule and submit workflow request to SO.
  
  Existing:
  
• Selection of a vNF type
  
• Selection of a workflow/operation
  
• Choose vNF instances to execute workflow on
  
• Scheduling of WF
  
• Passing the WF request to SO when the scheduler indicates to VID that the scheduled time has arrived.
  
  
  

Last Updated:

11/12/2018 3:19:45 PM

FunctionalRequirement Name: 44884 SO Enhance InPlace Activity to Update Inventory

Notes:

SO to enhance the InPlaceSWupdate Activity to update inventory (A&AI) with the new vNF model version ID.
Note: The SW version is updated in the .env file contained in the vNF Modle by the designer in ASDC causing the vNF Model version to be changed to the current version + 1.

Keyword:

Status:

Proposed

LOE:

Medium

Created:

11/12/2018 2:18:16 PM

Last Updated:

11/20/2018 3:31:44 PM

Requirement Name: 44884- 21 SDC WF Editor Usability Improvements

Notes:

TBD based on prioritized input from users as they "play" with the WF Editor. Need to set up WF Designer in a stable lab for users.

Budget an Easy.

Keyword:

Status:

Proposed

LOE:

Easy

Created:

11/20/2018 11:16:47 AM

Last Updated:

11/20/2018 11:28:28 AM

Requirement Name: 44884-12 SDC Indicate Expected User WF Inputs

Notes:

The SDC Editor must give the WF (hence SO and VID) a way to indicate what inputs are expected from the initiating user as input to the workflow. Those inputs are expected by the Activities used in the workflow. Any Activity inputs not provided by the user are expected to come from the other Activities used in the workflow by SO.

• Workflow inputs that require values to be entered by the user e.g. length of estimated WF execution time, vNF Instance IDs, are given descriptions by the WF designer/user to assist the VID user's understanding of what they are expected to enter for those input parameters when setting up a WF for execution.
  
  
• Some WF inputs may be vNF properties extracted by other ECOMP components (VID, SO). Those components understand the properties they need to access from the vNF TOSCA model as inputs to the workflow. .
  
  
• The only vNF properties that can be used as workflow inputs where the workflow is not associated with a vNF are HEAT properties.
  
  
• A vNF property outside of HEAT that requires user input to a workflow can only be utilized by associating a workflow to a vNF operation. (Provided by ONAP R2 Project)
  

Keyword:

Status:

Proposed

LOE:

Medium

Created:

11/13/2018 4:52:14 PM

Last Updated:

11/13/2018 5:21:46 PM

Requirement Name: 44884-8 SDC API Add WF Reference to vNF Model

Notes:

Develop an API to add a WF Reference to the vNF model indicating that the workflow was tested for the vNF Type/Version. Also include the users id and date.

Keyword:

Status:

Proposed

LOE:

Medium

Created:

11/13/2018 5:23:24 PM

Last Updated:

11/13/2018 5:25:55 PM

FunctionalRequirement Name: 44884-1 SO: Consume SDC "Get" Workflow APIs

Notes:

SO to add recognition of Distribution Artifact notification over DMaaP when a new Workflow is available.
SO to consume SDC APIs to retrieve new workflow Meta Data and WF BPMN artifact that are stored as an independent entities (vs. in the context of vNF or Service) in SDC using a new Get WF MetaData API and an enhanced Generic Artifact API to be provided by SDC.

Workflow BPMN is stored Camunda BMPN 2.0 format with a unique identifier assigned by SDC.

Keyword:

MSO

Status:

Proposed

LOE:

Easy

Created:

11/12/2018 2:17:26 PM

Last Updated:

11/21/2018 1:37:03 PM

FunctionalRequirement Name: 44884-2 VID: Get Available Workflows

Notes:

VID to obtain and display all available, user created workflows and SO Native workflows to the user for the selected vNF_Type/Version model using the new SO WF Get/Search API.

• VID to mark User created workflows that are noted as tested/certified in the vNF Type/Version model
  
• VID to mark the generic SO native workflows
  
• VID to mark all other workflows as available but not certified.
  
  Remove requirement to associate workflow with vNFType/version in the VID table.
  
  Human readable Workflow Name (unique) and Description are displayed.
  Only the latest workflow version is valid in this release.
  
  Note that certified/tested workflows are stored at the vNF level in the vNF Model and not at the Service Level.
  

Keyword:

VID

Status:

Proposed

LOE:

Easy

Created:

11/12/2018 2:17:23 PM

Last Updated:

11/13/2018 5:46:16 PM

FunctionalRequirement Name: 44884-3 VID: Obtain WF Input Values

Notes:

Consume WF input parameters from the workflow metadata data

• Interpret WF inputs that require user input
  
• Display WF inputs with it's description to the user.
  
• Accept user values for inputs.
  - VID to allow a user to select one or more vFModules for HEATStack Update. VFModule Parameter types to be communicated by SO for VID development.
  - VID already has
  -Package inputs in WF request
  - OoS WF outputs
  
• OoS Interpret WF inputs that are vNF properties that VID needs to extract from the model and display to user (display only),
  
  VID to support the ability to present inputs to the user and apply smart/complex controls or functions for display based on the modeling of workflow data types. Unknown/new workflow input data types require VID development.
  See G. Harel presentation on VID Parameter Design for supporting explanation.
  Workflows and building block Data Types to be supported are listed in 44912-5. Note: all Activities/BBs are at the vNF level except for VFModule HeatStack Update.
  
  Parameter names to be displayed as per UX expert recommendation. The parameters names are defined at design time in ASDC for user designed workflows and MSO for Native workflows (e.g. choice of wording, capitalization, punctuation etc.) with an input parameter description so that the user fully understands what is required. Parameter units are to be displayed to the user.
  
  Target desired solution is for parameters to be consumed by VID and displayed to user in a generic manner that requires one time development for the parameter type versus development whenever a new building block requires user inputs of a known type.
  

Keyword:

VID

Status:

Proposed

LOE:

Moderate

Created:

11/12/2018 2:17:14 PM

Last Updated:

11/12/2018 4:54:36 PM

Requirement Name: 44884-5 SO: Get Workflows & Meta Data API

Notes:

-SO to develop a new API that allows VID to obtain the list of available tested/certified workflows for the vNF Type/Version Selected and the MetaData for the user selected workflow.

• Get Workflows API: Returns workflow Name, WF Reference, WF UUIDs and workflow description.
  -Get Workflow MetaData API: Returns user input parameter names and descriptions.
  
• Output parameters are OoS.
  
  
• SO to provide all executable workflows that are deployed
  
• Indicate which WFs are tested/certified for the vNF type/Version. Tested workflows are stored in the vNF Model.
  
• Non-Tested/certified workflows are provided and VID will ask the user to attest to them being tested.
  
• SO to include the certified Native CM workflows for the vNF type/version (Do we want them marked as such?).
  
• SO to obtain the certified workflows from the vNF-Model.
  
  SO is the temporary WF Run Time Catalog (RTC).
  
  NOTE: There was much discussion with SDC, SO, E2E SE and the Architecture team. A conscious decision was made to have SO act as the temporary RTC for workflows. This capability will be moved when the actual Run Time Catalog (RTC) is available where VID will then obtain Workflow MetaData from the RTC.
  

Keyword:

VID, A&AI

Status:

Proposed

LOE:

Easy

Created:

11/12/2018 2:17:28 PM

Last Updated:

11/13/2018 5:43:47 PM

Requirement Name: 44884-6 VID-SO: Enhance Workflow Req. (Instantiation API)

Notes:

Existing Instantiation API presently utilized for the Workflow Request to be modified to be more flexible to handle complex data types requiring user entry.

Keyword:

Status:

Proposed

LOE:

Easy

Created:

11/12/2018 2:17:25 PM

Last Updated:

11/12/2018 4:48:25 PM

Requirement Name: 44884-7 SDC: Workflow Distribution Notification

Notes:

Distribute the workflow (If workflow is made an independent artifact, otherwise, no change required.)

• Use DMaaP topic similar to service topic for workflow distribution to SO (AID to determine if a new or existing can be used).
  
• SDC to publish the distribution notification to DMaaP for a new user designed WF.
  
  
  Note: When the Run Time Catalog(RTC) becomes available, SDC will publish the user designed Workflow Definition and BPMN to the RTC. Upon receiving the distribution notification, SO will obtain the Workflow Definition and BPMN artifact from the RTC.
  

Keyword:

Status:

Proposed

LOE:

Easy

Created:

11/12/2018 2:17:23 PM

Last Updated:

11/12/2018 4:31:25 PM

Requirement Name: 44884-13 VID Display WF Name and Description

Notes:

-VID to display the Human Readable WF Name and WF description when displaying the list of available workflow names for the selected vNF type/Version model.

• Display tested/certified workflows for the vNF_Type/Version in alpha order:
  
• User is given a list of all available workflows obtained from SO that are marked into categories and listed by category order then in alpha order: Categories are:
  1. Tested/certified for the chosen vNF type/Version,
  2. Native MSO workflow.
  3. Available not certified for vNF type/Version
  
  VID will also support a way for the user to search the drop down list of available workflows. (e.g. as the user types. the drop list is filtered.)
  
  The WF description continues to be displayed once the user selects a workflow to execute.
  

Keyword:

Status:

Proposed

LOE:

Easy

Created:

11/12/2018 2:17:27 PM

Last Updated:

11/13/2018 5:47:14 PM

Requirement Name: 44884-14 SDC: Certify WF-vNF Pair

Notes:

ASDC will follow the existing certification and governance processes used for Service to certify a workflow associate it with a vNF Type/Version.

ASDC to include the WF name and identifiers in the TOSCA model for the vNF_Type/version using the workflow designer capability to create an operation and map the workflow and vNF_Type/version to the operation.

Using the existing Service Model certification process for a workflow and association to a vNF type/version is optional for the user.

Keyword:

Status:

Proposed

LOE:

Easy

Created:

11/12/2018 2:17:22 PM

Last Updated:

11/13/2018 5:17:23 PM

Requirement Name: 44884-15 VID: Get WF Meta Data

Notes:

• VID obtains WF Meta data from SO to obtain required user inputs for the selected WF.
  
• VID to also obtain the reference to the WF BPMN.
  
• VID to support both simple and complex workflow input data types such as nested arrays.
  
• Output parameters are OoS.
  

Keyword:

Status:

Proposed

LOE:

Moderate

Created:

11/12/2018 2:17:20 PM

Last Updated:

11/12/2018 5:06:29 PM

Requirement Name: 44884-16 SDC: Develop WF API Search & Get WFs Operation

Notes:

Develop new WF API to Enable an SDC WF Editor to obtain a list of all user designed workflows with the workflow description. The purpose of this is to allow the user to select and modify a workflow

NOTE: In this release, a user can modify the implementation of a workflow but cannot modify the WF input/outputs. A designer must save the workflow under a different name as a new WF for unrestricted editing. Dependent on Copy/Save WF requirement.

Note: When the Run Time Library (RTL) becomes available, SDC will store and retrieve distributed workflows to/from the RTL.

Keyword:

Status:

Proposed

LOE:

Medium

Created:

11/12/2018 2:17:20 PM

Last Updated:

11/12/2018 4:38:01 PM

Requirement Name: 44884-18 SDC: Copy/Save Workflow

Notes:

Allow a user to copy an existing workflow, save it to a new name and subsequently modify it.

Keyword:

Status:

Proposed

LOE:

Medium

Created:

11/12/2018 2:17:13 PM

Last Updated:

11/12/2018 4:38:25 PM

Requirement Name: 44884-19 SDC Store Workflow as Independent Artifact

Notes:

SDC workflow designer will store the workflow BPMN as independent artifacts and assign a UUID and invariant UUID.
Note: In Casablanca, workflows are stored in TOSCA CSAR.

Keyword:

Status:

Proposed

LOE:

Medium

Created:

11/12/2018 2:17:26 PM

Last Updated:

11/12/2018 4:36:23 PM

Requirement Name: 44884-22 SDC Enhance Generic Artifact API

Notes:

Enhance Generic Artifact API to allow SO to extract the WF BPMN and associated Meta Data based on the workflow UUID. (Required if WF is made an independent artifact).
Intended to be used by SO after receiving a notification that there is a new user created workflow available.

MetaData includes:
1. Human Readable WF Name and Description
3. Reference to WF BPMN (independent artifact)
4. Deferred: Human readable outputs and description

Note: WHen the Run Time Library (RTL) becomes available, SDC will publish the WF BPMN artifact to the RTL and SO will obtain it from the RTL.

Keyword:

Status:

Proposed

LOE:

Easy

Created:

11/12/2018 2:17:19 PM

Last Updated:

11/20/2018 11:27:41 AM

Requirement Name: 44884-24 VID: Enhance Schedule WF API

Notes:

Dependent on Scheduler being pushed to ONAP by AT&T.

• Flexibility enhancements required to the Scheduler API to accommodate User designed workflow input parameters in the workflow execution request.
  
  Sending WF request to Scheduler (via Portal) is BAU as the parameters are in the payload.
  

Keyword:

Status:

Proposed

LOE:

Easy

Created:

11/12/2018 2:17:18 PM

Last Updated:

11/13/2018 5:39:06 PM

Requirement Name: 44884-25 SDC Enhance TOSCA Parser

Notes:

Enhance vNF TOSCA Parser to extract workflow references from the vNF model.

Remove capability to extract WF from CSAR.

Keyword:

Status:

Proposed

LOE:

Medium

Created:

11/12/2018 2:17:13 PM

Last Updated:

11/12/2018 4:32:43 PM

Requirement Name: 44884-27 VID: UX Enhancement Requests

Notes:

Provide search and filtering tools that allow a user to pinpoint the list of vNF instances they want to perform an operation on.

The following list of requirements are "Nice to have's" in this release and implementation is dependent on VID resources. The functional requirements supporting workflow scheduling and execution take precedence as UX improvements are technically out of scope for this project.

• A select "All" choice for vNF instances with ability to deselect unwanted instances. Select one instance type and auto-filter to only show instances of that type
  
• Display the human readable vNF Model Version versus the Model Version UUID. For example, display 2.0 instead of eeeeffaabbe0gghhee.
  
• Removed: Ability to highlight multiple vNF instances e.g. hold down control while making mouse clicks to highlight more than one, with the ability to deselect - Interface to be changed to check boxes.
  
• Removed: When entering workflow data and the user clicks outside the box, the data they already entered will not be lost and will be displayed. Modify to maintain entered data.- UI changing and will not have a pop-up box.
  

Keyword:

Status:

Proposed

LOE:

Easy

Created:

11/12/2018 2:17:25 PM

Last Updated:

11/12/2018 5:01:06 PM

Building Block/Activities Name

DublinPriority

Description

ChangeModelServiceInstanceBB

4?

Call SDN-C ChangeAssign

Remove?? ModelAdminChangeUpdateBB

?

Update service-instance object in A&AI (update model info).
Requested by vProbes. Can they execute InPlaceSWUpdate with aDummy/stub Ansible script?

AAIUpdateServiceModelVersion (New)

1

CONCEPT: Need bulding block(s) to update the model (Service, Module, vNFC) version in A&AI due to an administrative change made to the model in ASDC such as a license renewal. MSO should perform a "diff" of all administrative "properties" of the model and only make the version update if those have changed. The base requirement is that use of the this building block needs to be restricted to non-functional model updates i.e. cannot be used due to a SW update.

AssignVnfBB

4

Update the Service model version ID in A&AI to match the ASDC service version due to an ASDC model administrative or external Service update

UnassignVnfBB

4

Create generic-vnf object in A&AI, orchestration-status = Inventoried

ActivateVnfBB

4

Call SDN-C Assign

DeactivateVnfBB

4

Update generic-vnf object in A&AI, orchestration-status = Assigned

ChangeModelVnfBB

1

Call SDN-C Unassign

AAICheckVnfInMaintBB

1

Delete generic-vnf object in A&AI

SDNOVnfHealthCheckBB

4/5?

Call SDN-C Activate

GenericVnfHealthCheckBB

6

Update generic-vnf object in A&AI, orchestration-status = Active

UpdatevNFModelVersion (New)

1

Call SDN-C Deactivate

AssignVfModuleBB

4

Update generic-vnf object in A&AI, orchestration-status = Assigned

UnassignVfModuleBB

4

Call SDN-C ChangeAssign (change model)

ActivateVfModuleBB

4

Update genric-vnf object in A&AI

DeactivateVfModuleBB

4

Get generic-vnf object in-maintenance attribute

ChangeModelVfModuleBB

1

Send VNF health diagnostic request message to SDN-O

CreateVfModuleBB

4

DeleteVfModuleBB

4

Update the Resource model version ID in A&AI to match the ASDC service version due to an ASDC model administrative or external Resource update

HeatStackUpdateVfModuleBB

3

Create vf-module object in A&AI, orchestration-status = Inventoried

ConfigurationScaleOutBB

6

Call SDN-C Assign

Pause for Manual Task

1

Update volume-group object in A&AI, orchestration-status = Assigned

CreateVolumeGroupBB

4

Call SDN-C Unassign

DeleteVolumeGroupBB

4

Delete vf-module object in A&AI

Actor Name: Operations User

Stereotype:

Complexity:

Easy

Notes:

Last Updated:

11/12/2018 2:17:41 PM

Actor Name: SO Developer

Stereotype:

Complexity:

Easy

Notes:

• Develop "Pause" for Manual Task Activity
  
• Make all Activities required for in scope workflows WF Designer Ready
  
• Enhance all Activities to use GR-API (where required)
  

Last Updated:

11/14/2018 4:30:47 PM

Actor Name: WF Designer

Stereotype:

Complexity:

Easy

Notes:

Last Updated:

11/12/2018 2:17:41 PM

Object Name: SDC

Stereotype:

«enhance»

Complexity:

Notes:

Service Design and Creation

Impacts

• Activity Specification API developed in Beijing/Casablanca to accept the Manual Task Activity.
  
• When the manual task is used in the workflow, the WF Editor forces the user to enter a description of the manual tasks to be performed. That will then be passed to the user.
  

Last Updated:

11/13/2018 5:57:48 PM

Object Name: SO

Stereotype:

«enhance»

Complexity:

Easy

Notes:

Service Orchestrator

Impacts
1) Make all Activities required for in scope workflows WF Designer Ready

• Enhance all Activities to use GR-API (where required)
  
  In Scope Workflows:
  1. In Place SW Update vNF level
  2. HeatStack Update vNF level
  3. HeatStack Upate vFModule level
  4. Config Update vNF level
  5. Delete and Build SW Update vNF level
  
  A list of Activities is included after the requirements section. This list may not be inclusive of activities required as modifications may have occurred after this document was issued. SO developers are expected to ensure that all Activities are made available.
  
  -2) Develop the pause for manual action(s) "Activity"
  
• Push new SO developed Activities to SDC using Activity Spec API
  
• Provide status upon request to VID that the workflow is paused for manual task and instructions to the user on what actions to take.
  
• Allow the user to either resume the workflow or abort the workflow. if the user aborts the workflow, NO Trouble ticket is issued.
  

Last Updated:

11/14/2018 4:19:25 PM

Object Name: VID

Stereotype:

«enhance»

Complexity:

Easy

Notes:

Virtual Infrastructure Deployment

Impacts

– User requests WF status.

• When WF is in Manual Task Status, VID displays the manual actions to be performed as defined by the user who designed the WF.
  
• The manual actions to be performed are passed to VID from SO.
  
  • Allow user to resume or abort workflow after Pause for manual intervention. .
    

Last Updated:

11/13/2018 5:55:36 PM

Process Name: Deferred: CTH/UTH -Common/Universal Task Handler

Stereotype:

«process»

Complexity:

Easy

Notes:

Defer -Locate System where MSO can invoke an API to instruct a "team" to perform a required task.

Does Ops use this system or other system for task handling?

Steve Katz: Obtain contact for worklist system.

Last Updated:

11/12/2018 2:17:43 PM

Actor Name: SO Developer

Stereotype:

Complexity:

Easy

Notes:

Impacts

• Debug Workflow Activities
  
• Compile Activities in MSO
  
  
  
  

Last Updated:

11/14/2018 3:45:14 PM

Object Name: SDC

Stereotype:

«enhance»

Complexity:

Medium

Notes:

Service Design and Creation
Casablanca: Amdocs implemented the Activity Specification API for MSO to "push" Actions/BBs to the AT&T Activity Spec Service.
Impacts

• SDC to allow SO to overwrite an existing Activity in the Test Env. SO restricted to overwriting Activities for bug fixes.
  
• Allow a restricted user to remove Activities. This allows SO to push Activities that underwent a bug fix.
  
  Note: If SO is trusted, SDC can simply allow SO to overwrite existing Activities.
  
  Out of Scope for this release
  1. Allow MSO to overwrite an existing Activity/BB in Production.
  2. Allow SO to change the inputs or outputs of an Activity/BB
  2. Versioning of Activities
  

Last Updated:

11/14/2018 3:30:14 PM

Object Name: SO

Stereotype:

«enhance»

Complexity:

Difficult

Notes:

Service Orchestrator

Impacts

• SO will auto-push new activities to SDC
  
  Note: Activities will not be versioned.
  
  
  

Last Updated:

11/14/2018 3:37:19 PM

Process Name: Correct bugs in Actions & BBs

Stereotype:

«process»

Complexity:

Easy

Notes:

Correct bugs and test Activity.

Last Updated:

11/14/2018 3:41:25 PM

Requirement Name: SO Autopush Activities

Notes:

SO to AutoPush Activities to SDC using Activity Spec API upon SO startup. In the Test Env., SDC to allow for Activity overwrite.

In Production, SO to Autopush all Activities to SDC at SO Startup. SO to ignore SDC warning messages. SO may only update the functionality of the Activity in the production environment to the extent that the update is solely internal to SO. Inputs/Outputs or anything that will impact the Activity for use in the WF Designer may not be updated at this time. (Activity update in SDC is Out of Scope).

Keyword:

Status:

Proposed

LOE:

Medium

Created:

11/14/2018 4:00:44 PM

Last Updated:

11/21/2018 1:47:17 PM

Requirement Name: SDC Activity Spec to allow Activity Replacement (Test Env. Only)

Notes:

SDC Activity Spec API, to allow SO to push modified activities to SDC. in the test environment. This is used solely for bug fixes.

Modified Activities must have the same identifier as the previous one and the previous version should no longer be available to the user.

Keyword:

Status:

Proposed

LOE:

Medium

Created:

11/12/2018 2:18:10 PM

Last Updated:

11/21/2018 1:43:35 PM

Requirement Name: OoS ASDC: ModifyActivity Operation

Notes:

Out of Scope
Automate verwriting and storing a modified activity over it's previous version. Only the newest version of an activity is usable.

If the CreateActivity operation of the Activity Spec API cannot be utilized for this purpose, ASDC is required to develop a ModifyActivity operation.

Discussions regarding the need to version activities is on-going, but out of scope.

Keyword:

Status:

Implemented

LOE:

Medium

Created:

11/12/2018 2:18:13 PM

Last Updated:

11/14/2018 4:05:32 PM

Component 1

Component 2

Parameters

VID

SO

Get list of all workflows with description.
Get Workflow Definition (Meta Data)

VID

User

Display all available workflows. Allow the user to choose a Workflow.
Display the WF input parameters of the chosen workflow and accept the user's inputs. Ability to display and accept input for complex data types.
Display input parameter names with description and units (if applicable) required by the workflow to the user and accept the values entered by the user to be included in the WF payload delivered to SO (Use Instantiation or New API).

Give user instructions on manual activities to perform when the WF provides the "paused for manual task" status.

Provide option to Abort or resume WF when WF is in the paused for a manual task.

VID

SO

VID to pass the workflow input parameter/value pairs to SO.
VID to have ability to handle complex data types.

SO

VID

Manual task status and activities to perform for manual task.
SO to have ability to accept complex data type inputs from VID.

SO

SDC

If independent WF is implemented: Upon receipt of a new workflow artifact notification (over DMaaP), SO extracts the workflow definition (New API) and BPMN artifact from SDC artifact catalog using the Generic Artifact API.

2. Push Activities to SDC Activity Spec Service using the Activity Spec API.
3. Accept complex input data types for Activities.

1

SDC – SDC
TBP by ONAP

WF API(search WF operation)

New

SDC to develop a new API to allow the workflow designer to "search" the workflows for display to the user to choose a workflow to modify or to save as a new workflow to then modify.

2

SDC -SO

WF API (get WF meta data operation)




Generic Artifact API



Activity Spec API (for BB)

New







Enhance



New to MO

SDC to develop new API with an API-operation that allows SO to get the workflow meta data WF name, WF description, input/outputs with descriptions, reference to WF BPMN.

SDC to enhance Generic Artifact API to allow SO to get the Workflow BPMN artifact.

3

SDC -DMaaP

Distribution Notification

Enhance

SDC publishes new WF notification to DMaaP.

1

VID-SDC

Get vNF Model API

Existing

Enhance TOSCA parser and TOSCA model

5

VID-MSO

Instantiationor New API







Get/Search WF API






Get WF Definition API

Enhance or New








New







New

Enhance existing Instantiation API or develop new API (Operation for WF Request) to support the WF parameters. Enhancement or new TBD during development.




Develop New API for VID to obtain the list of all certified/tested available workflows and workflow description. from SO. TBD during develop to or not to include MetaData as it will be slow and impact the user experience negatively.

Develop New API for VID to obtain the WF Definition/MetaData of the user selected WF. MetaData includes user input parameters with descriptions, Includes Workflow Name, Identifiers.
parameters VID must extract from other ECOMP components to display to the user.

Instantiation or New API





Instantiation or New API

Enhance or New





Enhance or New

Enhance response to VID for Status:
1. For manual task, add text for user instructions regarding the manual task to be performed.
2. For all status, include the NF_Role (from A&AI or TOSCA Model)

Enhance or build new API for Rainy Day Handling of workflows to include user designed workflows. New or Enhance TBD during development.

1

SDC-SO via DMaaP

Notification

Enhance

Receive Distribution Artifact notification from DMaaP (published by SDC)

2

SO-SDC

Get WF API

Generic Artifact API

New


Enhance

SO obtains new WF Definition/MetaData from SDC, includes reference to BPMN artifact.

MSO obtains WF BPMN

SO-SDC

Activity Spec API

Exists

3

SO-VID

Instantiation or New API




Instantiation API or New

Enhance or New






Enhance

VID sends to SO the WF request package (WF name UUIDs inputs/values meta data). Enhance or new TBD during development.



Enhance VID-SO Instantiation API for Rainy Day Handling. Enhance or new TBD during development.

4

SO-VID

Instantiation API or New

Enhance

Enhance response to VID for Status:
1. For manual task, add text for user instructions regarding the manual task to be performed.
2. For all status, include the NF_Role (from A&AI or TOSCA Model)
Enhance or new TBD during development.

Application

Development Lab Resource Request

Dev POC

Notes

SO

No special needs

VID

No special needs

APPC

No special needs

SDNC

No info provided yet

SDC

MinimumVM with 2 VCPUs, 4 GB RAM & Storage of 20GB~.

Srini Vellanki