ETSI Standard Conformation

This proposal conforms to the following ETSI v2.7.1 specifications.

ONAP SO Hierarchical Orchestration Architecture

Requirements

Support for ETSI NFV NFVO Orchestrator in ONAP SO (ONAP SO ETSI-Aligned Hierarchical Orchestration)

Executive Summary - Enable E2E workflows by orchestrating ETSI NFV compliant Network Services and VNFs. This NFVO should provide an ETSI NFV SOL005 v2.7.1 NBI which can onboard ETSI NFV SOL004 and ETSI NFV SOL007 v2.7.1 compliant packages which then can be Life Cycle Managed and monitored. This NFVO should use an ETSI SOL003 v2.7.1 SBI to invoke an external VNF Manager.

Business Impact - Enables operators and service providers to use Industry standard Orchestration to deploy, manage and monitor network services. Industry compatibility.

Business Markets - All operators and service providers that are developing ETSI compatible Network Services especially for 5G Slicing where each Slice Subnet is associated with a Network Service

Funding/Financial Impacts - Reduction in operations expense from using industry standard ETSI Orchestration.

Organization Mgmt, Sales Strategies -There is no additional organizational management or sales strategies for this requirement outside of a service providers "normal" ONAP deployment and its attendant organizational resources from a service provider.

Requirements For Guilin

ONAP SO NFVO

ONAP SO NFVO provides ETSI NFV-compliant NFVO functions.

Supports the lifecycle of Network Service (NS)
- Create NS
- Instantiate NS
- Terminate NS
- Delete NS
- Subscription
Exposes NS lifecycle management interfaces (Os-Ma-Nfvo) to its client such as ONAP SO or SOL005-compliant clients
- Create NS
- Instantiate NS
- Terminate NS
- Delete NS
- Subscription
Sends NS lifecycle management notifications (Os-Ma-Nfvo) to its client such as ONAP SO or SOL005-compliant clients
- Notification (as a client)
Manages (as a client) virtualized resources via interfaces (Or-Vi) exposed by the VIM
- Software Image
- Container Image Management (stretch goal)
- Resource Management, validation and authorization of NFVI resource requests
Supports Virtual Links, CPs and VNF-FG
- VLs
- CPs
- VNF-FGs (stretch goal)
Manages (as a client) virtualized resource management interfaces (Or-Vnfm) to the VNFM
- Leverages the SOL003 Adapter and supports
  - Create VNF
  - Instantiate VNF
  - Terminate VNF
  - Delete VNF
  - Subscription
Supports virtualized resource management interfaces (Or-Vnfm) to the VNFM
- Granting VNF with HPA, leveraging OOF
Supports VNF lifecycle management notifications (Or-Vnfm) to the VNFM
- Notification
Manages (as a client) SOL004 VNF/PNF and SOL007 NS package management leveraging ETSI Catalog Manager
- Queries packages (VNF/PNF/NS)
- Queries descriptions (VNFD/PNFD/NSD)
- Subscription
Supports package notification interfaces (Os-Ma-Nfvo and Or-Vnfm) to ETSI Catalog Manager

Supports Communication Security, conforming SOL005 specification
- ONAP SO NFVO NBI supports HTTPS and Authentication/Authorization towards SO/SOL005 Adapter
- ONAP SO NFVO SBI (through SOL003 Adapter) supports HTTPS and Authentication/Authorization towards SVNFMs

Developer Wiki > ONAP SO ETSI-Aligned Hierarchical Orchestration > image2020-3-29_22-12-41.png

Epic and User Story

Epic	Description	In Guilin Plan?
Support for ETSI NFV NFVO Orchestrator in ONAP SO (ONAP SO ETSI-Aligned Hierarchical Orchestration)	Executive Summary - Enable E2E workflows by orchestrating ETSI NFV compliant Network Services and VNFs. This NFVO should provide an ETSI NFV SOL005 v2.7.1 NBI which can onboard ETSI NFV SOL004 and ETSI NFV SOL007 v2.7.1 compliant packages which then can be Life Cycle Managed and monitored. This NFVO should use an ETSI SOL003 v2.7.1 SBI to invoke an external VNF Manager. Business Impact - Enables operators and service providers to use Industry standard Orchestration to deploy, manage and monitor network services. Industry compatibility. Business Markets - All operators and service providers that are developing ETSI compatible Network Services especially for 5G Slicing where each Slice Subnet is associated with a Network Service Funding/Financial Impacts - Reduction in operations expense from using industry standard ETSI Orchestration. Organization Mgmt, Sales Strategies -There is no additional organizational management or sales strategies for this requirement outside of a service providers "normal" ONAP deployment and its attendant organizational resources from a service provider.	Yes

NFVO Architecture & Functions

The following diagram depicts the NFVO component architecture

NFVO Microservice Plugin Framework

Provides the NFVO function Microservice plugin framework for supporting:
- Default function plugins support (following default plugins will be registered to the Framework; routing will be configured)
  - SOL005 NBI (API Handler)
  - NS LCM Manager
  - ETSI Catalog Manager Adapter
  - Camunda Workflow Engine
  - NS Workflows and Logic
  - Resource Manager
  - K8S Client
  - Configuration Manager
  - MultiCloud Adapter
  - Inventory DB Adapter
  - Notification Manager
  - FM/PM Event Manager
- Substitution of existing function plugins
  - Registration of a new substitution Microservice with version control (leverage a mechanism like AAI ESR/MSR/API Fabric/MSB - TBD)
  - Plug-in a substitution Microservice
  - Dynamic dispatching/launching a new plugin instance based on configuration/policy
- Extension of existing function plugins
  - Default function plugin extension with version control
  - Dynamic dispatching/launching an extended plugin instance based on configuration/policy

SOL005 NBI (API Handler)

Provides SOL005-compliant Restful Northbound APIs for SO/SOL005 Adapter
- Supports NS Lifecycle Management (LCM) APIs
  - Create NS (POST “/api/nslcm/v1/ns_instances”)
  - Instantiate NS (POST “/api/nslcm/v1/ns_instances/{nsInstanceId}/instantiate”)
  - Terminate NS (“/api/nslcm/v1/ns_instances/{nsInstanceId}/terminate”)
  - Delete NS (DELETE “/api/nslcm/v1/ns_instances/{nsInstanceId}”)
  - Scale NS (POST “/api/nslcm/v1/ns_instances/{nsInstanceId}/scale”) – stretch goal
  - Heal NS (“POST ”/api/nslcm/v1/ns_instances/{nsInstanceId}/heal”) – stretch goal
  - Query NS (GET “/api/nslcm/v1/ns_instances”, “/api/nslcm/v1/ns_instances/{nsInstanceId}”)
  - Subscription (POST ”/subscriptions”)
  - Notification (SO SOL005 Adapter client-provided; POST notification based on the callbackUrl from the subscription)
- Support NS Fault Management API (stretch goal)
- Support NS Performance Management APIs (stretch goal)
- Leverages SOL005 Swagger Files
  - https://forge.etsi.org/jenkins/view/All%20jobs/job/NFV%20-%20 Network%20Functions%20Virtualisation/job/sol005-master/lastSuccessfulBuild/artifact/build /
  - Provides interfaces with DCAE and Policy for Close Loop Automation
  - This API Handler focuses on the SOL005 APIs, and its business logic is supplied by the NS LCM Microservice

NS Workflows

Provides Workflow engines (stand-along/clustered Camunda engine) for the NS workflow management
- Supports Stand-Alone/clustered Camunda engine(s) deployment
- Allows hot deployment of custom workflow packages while ONAP NFVO is running
Provides NS workflows
- Provides default NS workflows (part of ONAP NFVO deployment)
  - CreateNS bpmn files with business logic
  - InstantiateNS bpmn files with business logic
  - TerminateNS bpmn files with business logic
  - DeleteNS bpmn files with business logic
- Allows custom NS workflows deployment (Hot deployment)

Developer Wiki > ONAP SO ETSI-Aligned Hierarchical Orchestration > image2020-3-25_23-17-17.png

ETSI Package Onboarding for NFVO

ONAP NFVO leverages the ETSI Catalog Manager as the run-time Catalog Database service provider.
- ETSI NS/VNF/PNF Packages are onboarded and distributed from SDC à ETSI Catalog Manager (note: this is NOT part of NFVO; it is a separate effort)
- ONAP NFVO queries ETSI NS/VNF/PNF Packages from the ETSI Catalog Manager

Developer Wiki > ONAP SO ETSI-Aligned Hierarchical Orchestration > image2020-3-25_23-20-2.png

NS LCM Database

TBD

SOL003 Adapter for SVNFMs

Provides SOL003-compliant (Or-Vnfm) Southbound APIs towards SVNFMs
- Supports VNF Lifecycle Management (LCM)
  - Create VNF
  - Instantiate VNF
  - Terminate VNF
  - Delete VNF
  - Scale VNF
  - Heal VNF
  - Query VNF
  - ModifyInfo VNF
  - Subscription
  - Notification
  - Granting with HPA
- It is a Microservice and part of ONAP SO NFVO
- It is launched by NS Workflows for VNF LCM
- It locates the VNFM instance by leveraging AAI ESR

Resource Manager

Provides Resource Granting Information through OOF (Policy, MultiCloud, A&AI)
- Supports interfaces with OOF to collect Granting information
- Collects Homing information from OOF and provides the information to other NFVO components
Supports Or-Vi Interfaces that provided by VIM, Infrastructure Manager, VIM or CaaS manager (note: for Guilin, many of them would be stretch goals)
- Software Image Management
- Container Image Management (stretch goal)
- Virtualized Resources Information Management
- Virtualized Resources Capacity Management
- Virtualized Resources Management
- Virtualized Resources Change Management
- Virtualized Resources Reservation Management
- Virtualized Resource Quota Management
- Virtualized Resource Performance Management
- Virtualized Resource Fault Management
- Network Forwarding Path (NFP) Management

Notification Manager

Supports NS lifecycle management notification to its clients such as ONAP SO or SOL005 compliant clients
TBD

FM/PM Manager

TBD

ONAP SO, SOL005 Adapter and NFVO Interaction

Descriptions

Existing SO E2E Business Logic for VFC/SOL005 Adapter

ONAP SO leverages the existing E2E service instance management logic
SO receives Create E2E Service Instance Request
SO runs E2E Service BPMNs
- Decomposes E2E service requests for network resources
- Checks resource subcategory is “Network Service”
- Invokes Create Network Service Request through SOL005 Adapter
SOL005 Adapter fetches NFVO endpoint details from AAI ESR
- Collects NFVO endpoint details from AAI ESR
- Sends SOL005 Create NS request to NFVO

New ONAP SO NFVO Path

NFVO creates NS LCM
- Returns NS ID
NFVO instantiates NS LCM

ONAP SO Refactoring for NFVO Function Extraction

Note: to analyze the following further (extracting NS-related operations)

ONAP SO	NFVO
Asdc-controller (scope: Service, NS, VNF, VF-Module)	Asdc-controller for NS, leveraging ETSI Catalog Manager
API Handler	SOL005 API Handler
BPMN Infra (scope: Service, NS, VNF, VF-Module) including Workflows with embedded Camunda Workflow engine	NS LCM + Default NS Workflows (with business logic) + Custom NS Workflows (with business logic) Stand-Alone/Clustered Camunda Workflow Engine
VFC / SOL005 Adapter	Not Applicable
SOL003 Adapter in SO	SOL003 Adapter in NFVO (move its home)
Catalog DB Adapter	Leverage ETSI Catalog Manager
Request DB Adapter (scope: service, NS, VNF, VF-Module)	Request DB Adapter for NS scope
APPC Orchestrator	Configuration Manager Client
ve-vnfm-adapter (SOL002 Adapter)	TBD
sdnc-adapter	TBD
nssmf-adapter	TBD
Openstack adapter / MultiCloud adapter	Resource Manager
VNF Adapter	Not Applicable (SOL003 Adapter delegates VNF operations to SVNFM)
K8S Client (PoC)	K8S Client
SO-monitoring	SO-monitoring for NS and VNF
Common (beans and utils common for all the projects)	Leverage Common as needed
Close Loop Handling	FM/PM Event Handler

Communication Security

ONAP SO NFVO NBI supports HTTPs and Authentication/Authorization towards SO/SOL005 Adapter.
ONAP SO NFVO SBI (through SOL003 Adapter) supports HTTPs and Authentication/Authorization towards SVNFMs.
TBD

Standard Interfaces

Create / Instantiate NS

The following diagram depicts the Create/Instantiate NS.

@startuml
participant SO
participant SOL005_Adapter
participant SOL005_NBI
participant NS_LCMGR
participant Resource_Mgr
participant OOF
participant Catalog_DB_Adapter
participant ETSI_Catalog_Mgr
participant Inventory_DB_Adapter
participant AAI
participant SOL003_Adapter
participant VIM
participant VNFM

autonumber 

group Create NS
	SO -> SOL005_Adapter : Create NS
    SOL005_Adapter -> SOL005_NBI : Create NS
    SOL005_NBI -> NS_LCMGR : Create NS
    NS_LCMGR -> Resource_Mgr : Create NS record
    Resource_Mgr -> Inventory_DB_Adapter : Create NS record
    Inventory_DB_Adapter -> AAI : Create NS record
    AAI --> AAI : Create NS record
    AAI -> Inventory_DB_Adapter : Response for Create NS record
    Inventory_DB_Adapter -> Resource_Mgr: Response for Create NS record
    Resource_Mgr -> NS_LCMGR : Response for Create NS record
    NS_LCMGR -> SOL005_NBI : Response for Create NS record	
    SOL005_NBI -> SOL005_Adapter : Response with NS Instance Id
    SOL005_Adapter -> SO : Response with NsInstance\n(including NS Instance Id)
    NS_LCMGR -> SOL005_NBI : Send\nNsIdentifierCreationNotification
    SOL005_NBI -> SOL005_Adapter : Send\nNsIdentifierCreationNotification
    SOL005_Adapter -> SO : Send\nNsIdentifierCreationNotification
end
group Instantiate NS
    NS_LCMGR -> Catalog_DB_Adapter : Read NS descriptor
    Catalog_DB_Adapter -> ETSI_Catalog_Mgr : Read NS descriptor
    ETSI_Catalog_Mgr -> Catalog_DB_Adapter : Return NS descriptor
    Catalog_DB_Adapter -> NS_LCMGR : Return NS descriptor
    NS_LCMGR --> NS_LCMGR : Parse & Decompose NS descriptor
    NS_LCMGR --> NS_LCMGR : Instantiate NS
    NS_LCMGR --> NS_LCMGR : Instantiate VLs between VNFs
    NS_LCMGR -> Resource_Mgr : Create Network
    Resource_Mgr -> VIM : Create Network
    VIM -> Resource_Mgr : Response for Create Network
    Resource_Mgr -> NS_LCMGR : Response for Create Network
    NS_LCMGR -> Resource_Mgr : Create VL record
    Resource_Mgr -> Inventory_DB_Adapter : Create VL record
    Inventory_DB_Adapter -> AAI : Create VL record
    AAI --> AAI : Create VL record
    AAI -> Inventory_DB_Adapter : Response for Create VL record
    Inventory_DB_Adapter -> Resource_Mgr : Response for Create VL record
    Resource_Mgr -> NS_LCMGR : Response for Create VL record
    NS_LCMGR -> Resource_Mgr : Request Homing Information\nfor Network Service
    Resource_Mgr -> OOF : Requests Homing Information\nfor Network Service
    OOF -> Resource_Mgr : Response with Homing Information\nfor Network Service
    Resource_Mgr --> Resource_Mgr : Persist Homing Information\nfor Network Service
loop Go through each VNF    
    NS_LCMGR -> SOL003_Adapter : Request for Instantiate VNF
    SOL003_Adapter -> VNFM : Request for Instantiate VNF
    VNFM -> SOL003_Adapter : Request Grant VNF resource
    SOL003_Adapter -> NS_LCMGR : Request Grant VNF resource
    NS_LCMGR -> Resource_Mgr : Request Homing Information 
    Resource_Mgr -> NS_LCMGR : Return with Homing Information\nfor the VNF
    NS_LCMGR --> NS_LCMGR : Make a Grant decision
    NS_LCMGR -> SOL003_Adapter : Return with a Grant decision
    SOL003_Adapter -> VNFM: Return with a Grant decision
    VNFM --> VNFM : Instantiate VNF
    VNFM -> SOL003_Adapter : Notify the changes\nof VNF/VDUs/CPs
    SOL003_Adapter -> NS_LCMGR : Notify the changes\nof VNF/VUD/CPs
end
    NS_LCMGR -> SOL005_NBI : Send\nnsLcmOperationOccurrenceNotification
    SOL005_NBI -> SOL005_Adapter : Send\nnsLcmOperationOccurrenceNotification
    SOL005_Adapter -> SO : Send\nnsLcmOperationOccurrenceNotification
end    


@enduml

Create NS

Developer Wiki > ONAP SO ETSI-Aligned Hierarchical Orchestration > image2020-3-26_15-29-31.png

Request

CreateNsRequest

nsdId
nsName
nsDescription

Response

NsInstance

see NsInstance from ETSI GS NFV-SOL 005 v2.7.1

NS LCM Manager Design

VFC design

get nsdId, nsName and nsDescription, context (globalCustomerId, serivceType) parameters
get a ns package by the given nsdId from ETSI Catalog Manager
check if ns instance exists from the NFVO_NSINST database table
- if it exists, log it exists
create an ns instance id (uuid) and store it with other nsd info, status (NOT_INSTANTIATED) to NFVO_NSINST database table
create an ns instance record (service-instance-id, service-instance-name, service-type, service-role) in AAI
get nsInstance from GetNSInfoService
return 201 Created with the NsInstance
Send NsIdentifierCreationNotification

Proposal

The following diagram depicts the Create NS procedure.

Developer Wiki > ONAP SO ETSI-Aligned Hierarchical Orchestration > image2020-4-8_23-2-6.png

Instantiate NS

Developer Wiki > ONAP SO ETSI-Aligned Hierarchical Orchestration > image2020-3-26_15-49-23.png

Request

InstantiateRequest

Response

201 Accepted

NsLcmOperationOccurrenceNotification (Start/Processing/Completed)

NS LCM Manager Design

VFC Design

Get an ns instance id from the parameter
create a job for the ns instance id
create an occ id for the ns instance id
Update the ns instance id row of the NFVO_NSINST database table for status (= INSTANTIATING)
get a ns instance data from the NFVO_NSINST for the ns instance id
get and store additional Parameters for NS
get an VIM id from the cloud owner and cloud region parameters
get an VNF VIM from he location constraints
set the job status with 'Start Query NSD'
get and parse a nsd for the ns package id
modify nsd state
get VNF list from the nsd
for each VNF,
- get vnfd_id, vnfm_type, vimId, s_vimId (with "cloud_owner"_"cloud_regionid")
- select VNFM by leveraging AAI ESR
- store VNF pararms in collection, with vnf info including vnfmInstanceId
set vl vim id
- for each VNF
  - if VNF has dependencies, for each dependency
    - add VNF properties and id into vl_vnf array
- for each VLs
  - get vnfdId and vimId
  - add vimId into VL array
update NFVO_NSINST with the nsd model
get PNF parameters
get VNF parameters (from VNF params above)
set up Plan Input with job_id, ns_inst_id, tosca plan, additional NS params, VNF params, PNF params)
start workflows with the job_id, ns_inst, plan_input, occ_id)
- get service template id from ETSI Catalog Manager
- get process id from ETSI Catalog Manager
- workflow run with data (process id, params = plan input)
  - createVL
  - createVNF
  - createSFC (Service Function Chain)

Proposal

The following diagram depicts the Instantiate NS.

Developer Wiki > ONAP SO ETSI-Aligned Hierarchical Orchestration > image2020-4-8_14-35-11.png

Terminate / Delete NS

The following diagram depicts the Terminate / Delete NS.

@startuml
participant SO
participant SOL005_Adapter
participant SOL005_NBI
participant NS_LCMGR
participant Resource_Mgr
participant OOF
participant Catalog_DB_Adapter
participant ETSI_Catalog_Mgr
participant Inventory_DB_Adapter
participant AAI
participant SOL003_Adapter
participant VIM
participant VNFM

autonumber 

group Terminate NS
	SO -> SOL005_Adapter : Terminate NS
    SOL005_Adapter -> SOL005_NBI : Terminate NS
    SOL005_NBI -> NS_LCMGR : Terminate NS
    NS_LCMGR -> Resource_Mgr : Query all instances related to NS
    Resource_Mgr -> Inventory_DB_Adapter : Query all instances related to NS
    Inventory_DB_Adapter -> AAI : Query all instances related to NS
    AAI -> Inventory_DB_Adapter : Return all instances for NS
    Inventory_DB_Adapter -> Resource_Mgr : Return all instances for NS
    Resource_Mgr -> NS_LCMGR : Return all instances for NS
    NS_LCMGR --> NS_LCMGR : Start Delete NS instances
    NS_LCMGR -> Resource_Mgr : Request Homing Information\nfor Network Service
    Resource_Mgr -> OOF : Requests Homing Information\nfor Network Service
    OOF -> Resource_Mgr : Response with Homing Information\nfor Network Service
    Resource_Mgr --> Resource_Mgr : Persist Homing Information\nfor Network Service
loop Go thru each VNF
    NS_LCMGR -> SOL003_Adapter : Delete VNF
    SOL003_Adapter -> VNFM : Delete VNF
    VNFM -> SOL003_Adapter : Request Grant resource for deletion
    SOL003_Adapter -> NS_LCMGR : Request Grant resource for deletion
    VNFM -> SOL003_Adapter : Request Grant VNF resource
    SOL003_Adapter -> NS_LCMGR : Request Grant VNF resource
    NS_LCMGR -> Resource_Mgr : Request Homing Information 
    Resource_Mgr -> NS_LCMGR : Return with Homing Information\nfor the VNF
    NS_LCMGR --> NS_LCMGR : Make a Grant decision
    NS_LCMGR -> SOL003_Adapter : Return with a Grant decision
    SOL003_Adapter -> VNFM: Return with a Grant decision  
	VNFM --> VNFM : Delete Resources
    VNFM -> SOL003_Adapter : Notify changes of VNF/VDUs/CPs
    SOL003_Adapter -> NS_LCMGR : Notify changes of VNF/VDUs/CPs
    NS_LCMGR -> Resource_Mgr : Update records for Delete VNF/VDUs/CPs
    Resource_Mgr -> Inventory_DB_Adapter : Update records for Delete VNF/VDUs/CPs
    Inventory_DB_Adapter -> AAI : Update records for Delete VNF/VDUs/CPs
    AAI --> AAI : Update records for Delete VNF/VDUs/CPs
    AAI -> Inventory_DB_Adapter : Return with Delete VNF/VDUs/CPs
    Inventory_DB_Adapter -> Resource_Mgr : Return with Delete VNF/VDUs/CPs
    Resource_Mgr -> NS_LCMGR : Return with Delete VNF/VDUs/CPs
end
    NS_LCMGR -> Resource_Mgr : Request for Delete VLs (if needed)
    Resource_Mgr -> VIM : Request for Delete VLs
    VIM --> VIM : Delete VLs
    NS_LCMGR -> Resource_Mgr : Update records for Delete VLs
    Resource_Mgr -> Inventory_DB_Adapter : Update records for Delete VLs
    Inventory_DB_Adapter -> AAI : Update records for Delete VLs
    AAI --> AAI : Update records for Delete VLs
    AAI -> Inventory_DB_Adapter : Return with Delete VLs
    Inventory_DB_Adapter -> Resource_Mgr : Return with Delete VLs
    Resource_Mgr -> NS_LCMGR : Return with Delete VLs

    NS_LCMGR -> SOL005_NBI : Send\nnsLcmOperationOccurrenceNotification
    SOL005_NBI -> SOL005_Adapter : Send\nnsLcmOperationOccurrenceNotification
    SOL005_Adapter -> SO : Send\nnsLcmOperationOccurrenceNotification
end    



@enduml

Terminate NS

Developer Wiki > ONAP SO ETSI-Aligned Hierarchical Orchestration > image2020-3-26_15-49-23.png

Request

TerminateNsRequest

terminateTime

Response

201 Accepted

NsLcmOperationOccurrenceNotification (Start/Processing/Completed)

NS LCM Manager Design

VFC Design

Get an ns_inst_d, job_id and request_data from the parameters
if there no matching ns_inst_id from the NFVO_NSINT database table, consider there is nothing to terminate, and return
set job status as "Starting terminate..."
update the ns_inst_id row from the NFVO_NSINST database table with the status = TERMINATING
cancel SFC list
- get sfc inst array
- for each sfc inst
  - DELETE /api/nslcm/v1/ns/sfcs/{instId}
cancel VNF list
- get vnf inst list array from NFVO_NFINST
  - for each vnf inst
    - delete_vnf (nf_instid)
      - POST /api/nslcm/v1/ns/terminateVnf/{instId}
cancel VL list
- get VL Inst array
- for each VL inst
  - DELETE /api/nslcm/v1/ns/vls/{instId}
cancel PNF list
- get pnf inst array
- for each pnf inst
  - DELETE /api/nslcm/v1/pnfs/{instId}
modify the ns_inst_id row state from the NFVO_NSINST database table
modify NFVO_NSINST status = NOT_INSTANTIATED
set job status = NS terminate ends
Update NsLcmOpOCC to COMPLETED
Send nsLcmOperationOccurrenceNotification

Proposal

The following diagram depicts the Terminate NS.

Developer Wiki > ONAP SO ETSI-Aligned Hierarchical Orchestration > image2020-4-8_22-30-30.png

Delete NS

Request

No; just parameter nsInstanceId

Response

204 No Content

Notification

Send NsIdentifierDeletionNotification

NS LCM Manager Design

VFC_Design

get ns_inst_id
delete ns instance in AAI
- get ns_instances from NFVO_NSINST database table
- invoke delete_ns_aai with global_customer_id, service_type, ns_inst_id, resource_version
  - formulate the resource url with parameters
  - call_aaI (resource, "DELETE")
delete ns_inst_id row from the NFVO_NSINST database table
delete ns_inst_id row from the NFVO_INPutParamMapping database table
delete ns_inst_id row from the DefPkgMapping database table
delete ns_inst_id row from the ServiceBaseInfo database table
return 204 No Content
Send NsIdentifierDeletionNotification

Proposal

The following diagram depicts the Delete NS.

Developer Wiki > ONAP SO ETSI-Aligned Hierarchical Orchestration > image2020-4-8_23-3-21.png

Subscription NS

@startuml
participant SO
participant SOL005_Adapter
participant SOL005_NBI
participant NS_LCMGR

autonumber 

group Create Subscription NS
	SO -> SOL005_Adapter : Create Subscription NS
    SOL005_Adapter -> SOL005_NBI : Create Subscription NS
    SOL005_NBI -> NS_LCMGR : Create Subscription NS
    NS_LCMGR --> NS_LCMGR : Check Subscription Filter
	NS_LCMGR -> NS_LCMGR : Test subscription\nnotification (callbackUrl) endpoint
    NS_LCMGR --> NS_LCMGR : Save Subscription to Database
    NS_LCMGR -> SOL005_NBI : Response with LccnSubscription
end

group Delete Subscription NS
	SO -> SOL005_Adapter : Delete Subscription NS
    SOL005_Adapter -> SOL005_NBI : Delete Subscription NS
    SOL005_NBI -> NS_LCMGR : Delete Subscription NS
    NS_LCMGR --> NS_LCMGR : Delete Subscription NS 
    NS_LCMGR -> SOL005_NBI : Response with 204 No Content
    SOL005_NBI -> SOL005_Adapter : Response for Delete Subscription NS
    SOL005_Adapter -> SO : Response for Delete Subscription NS 
	
end

@enduml

Subscription NS

Request

LccnSubscriptionRequest
subscriptionId. for GET and DELETE

Response

204 No Content
201 Created (LccnSubscription)
200 OK (LccnSubscription[])
200 OK (LccnSubscription)

Subscription Filter Request

The following table describes the Subscription filter request.

attribute name	data type	cardinality	description
nsdIds	Identifier	0..N	If present, match NS instances that were created based on an NSD identified by one of the nsdId values listed in this attribute. See note 1.
vnfdIds	Identifier	0..N	If present, match NS instances that contain VNF instances that were created based on a VNFD identified by one of the vnfdId values listed in this attribute. See note 1.
pnfdIds	Identifier	0..N	If present, match NS instances that contain PNFs that are represented by a PNFD identified by one of the pnfdId values listed in this attribute. See note 1.
nsInstanceId	Identifier	0..N	If present, match NS instances with an instance identifier listed in this attribute. See note 2.
nsInstanceNames	String	0..N	If present, match NS instances with an NS Instance Name listed in this attribute. See note 2.
NOTE 1: The attributes "nsdIds", "vnfdIds" and "pnfdIds" are alternatives to reference to NS instances that are created based on certain NSDs, or contain VNF instances that are based on certain VNFDs, or contain PNFs that are based on certain PNFDs in a filter. They should not be used together in the same filter instance, but one alternative should be chosen. NOTE 2: The attributes "nsInstanceIds" and "nsInstanceNames" are alternatives to reference to particular NS Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.

NS LCM Manager Design

VFC Design

create subscription id
check callback Uri
check filter types
save subscription request to database
return response with subscription

Proposal

The following diagram depicts the Subscription NS.

Developer Wiki > ONAP SO ETSI-Aligned Hierarchical Orchestration > image2020-4-8_22-43-52.png