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

P1: Phase 1 (for Guilin)

P2: Phase 2 (post Guilin)

P3: Phase 3 (future release)

ONAP SO NFVO Requirements

ONAP SO NFVO provides ETSI NFV-compliant NFVO functions in ONAP, such as ETSI NFVO MANO 1) SOL007, SOL004 and SOL001 Modeling and Package, 2) SOL005-compliant NBI, 3) SOL005-compliant NS LCM and 4) SOL003-compliant SBI.


SOL005 Adapter Requirements 


Out of Scope Features from Guilin

The following features are out of scope from Guilin:


Use Cases

Epic and User Story

Epic

User Story

Task

Description

In Guilin Plan?JIRASize

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 


Support for NFVO Microservice Plugin Framework (P1)
Provides the NFVO function Microservice plugin framework for supporting: (P1)
  • 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
    • SOL003 Adapter
    • 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/Kubernetes - 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
Yes


Support for SOL005 NBI API Handler (P1)
Provides SOL005-compliant Restful Northbound APIs for SO/SOL005 Adapter (P1)
  • 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}”)
    • Get Operation Status ( GET / api/nslcm/v1/ns_lcm_op_occs, 
    • / api/nslcm/v1/ns_lcm_op_occs
    • Scale NS (POST “/api/nslcm/v1/ns_instances/{nsInstanceId}/scale”) – (P2)
    • Heal NS (“POST ”/api/nslcm/v1/ns_instances/{nsInstanceId}/heal”) – (P2)
    • 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
Yes



Create NS NBI
  • Supports Create NS: POST /api/nslcm/v1/ns_instances (CreateNsRequest)
  • Responses with NsInstance with 201 (for success) or an error
  • Sends NsIdentifierCreationNotification to the NFVO subscriber(s) (e.g., ONAP SO SOL005 Adapter)
  • Postcondition: NS Instance is NOT_INSTANTIATED state
Yes



Instantiate NS NBI
  • Precondition: NS instance is NOT_INSTNANTIATED state
  • Supports Instantiate NS: POST /api/nslcm/v1/ns_instances/{nsInstanceId}/instantiate (InstantiateNsRequest)
  • Responses 202 Accepted with an empty payload body
    • a Location HTTP header that points to the new individual NS Lifecycle Operation Occurrence resource; i.e. the URI of that resource (.../ns_lcm_op_occs/{nsLcmOpOccId}
  • Sends nsLcmOperationOccurrenceNotifiation (start, result)
  • Postcondition: NS Instance is INSTANTIATED state
  • Error handling: if the operation is failed, error information is provided in the notification message
Yes



Terminate NS NBI
  • Precondition: NS instance is INSTANTIATED state
  • Support Terminate NS: POST /api/nslcm/v1/ns_instances/{nsInstanceId}/terminate (TerminateNsRequest)
  • Responses 202 Accepted with an empty payload body
    • a Location HTTP header that points to the new individual NS Lifecycle Operation Occurrence resource; i.e. the URI of that resource (.../ns_lcm_op_occs/{nsLcmOpOccId}
  • Sends nsLcmOperationOccurrenceNotifiation with nsLcmOpOccId, notificationStatus (start, result), subscriptionId, etc. 
  • Postcondition: NS Instance is TERMINATED state
  • Error handling: if the operation is failed, error information is provided in the notification message
Yes



Delete NS NBI
  • Precondition: NS instance in NOT_INSTANTIATED state
  • Supports Delete NS: DELETE /api/nslcm/v1/ns_instances/{nsInstanceId}
  • Sends 204 No Content with an empty payload body
  • Sends NsIdentifierDeletionNotification to the NFVO subscriber(s) (e.g., ONAP SO SOL005 Adapter)
  • Postcondition: the resource representing the NS instance has been removed from the list of NS instance resources
  • Error handling: if the individual NS instance is not in NOT_INSTANTIATED state, it rejects the deletion request
Yes



Get NS Operation Status NBI
  • Support multiple NS LCM operation occurrences: GET / api/nslcm/v1/ns_lcm_op_occs
    • Response with 200 OK (NsLcmOpOcc[])
  • Support individual NS LCM operation occurrence: GET /api/nslcm/v1/ns_lcm_op_occs/{nsLcmOpOccId}
    • nsLcmOpOccId is an attribute in the NsLcmOperationOccurrenceNotification
    • Response with 200 OK (NsLcmOpOcc), where its opeationStatus=PROCESSING, COMPLETED)

Note: Instantiate NS and Terminate NS use the individual NS LCM operation occurrence

Yes



Create NS Subscription NBI
  • Supports subscription: POST /api/nslcm/v1/subscriptions (LccnSubscriptionRequest)
  • Tests the callback notification endpoint
    • GET <<callback uri>>
    • expects 204 No Content response from the subscriber (e.g., SO SOL005 Adapter)
  • Responses with 201 Created (LccnSubscription)
Yes



Get NS Subscription NBI
  • Supports Get all subscriptions: GET /api/nslcm/v1/subscriptions/
    • Responses with 200 OK (LccnSubscription[])
  • Supports Get individual subscription: GET /api/nslcm/v1/subscriptions/{subscriptionId}
    • Responses with 200 OK (LccnSubscription)
Yes



Delete NS Subscription NBI
  • Supports Delete subscription: DELETE /api/nslcm/v1/subscriptions/{subscriptionId}
    • Responses with 204 No Content
Yes



Send NS Notifications NBI
  • Sends notifications to the subscriber(s) for NS LCM: POST <<callback URI>> (<<Notification>>)
    • <<Notification>> follows NsLcmOperationOccurrenceNotification, NsIdentifierCreationNotification, NsIdentifierDeletionNotification or NsChangeNotification (see, SOL005 v2.7.1 specification 6.5.2.5 - 6.5.2.8)
  • Gets response: 204 No Content from the subscriber (e.g, SO SOL005 Adapter)
Yes








Supports for NS LCM and Workflows (P1)

Support for NS LCM and Workflows (P1)

  • 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 LCM and 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)
      • The Operators build their own workflows and business logic as war files
      • The Operators drop off custom workflows war files into the Camunda deployment directory
      • UI for the custom workflow war deployment would be supported 
    • Provides business logic for NS LCM
    • Invokes SOL003 Adapter
    • Invokes Resource Adapter
    • Invokes Catalog DB Adapter
    • Invokes NS Inventory Adapter
    • Invokes MultiCloud Adapter 
    • Invokes Configuration Manager (question)
    • Invokes Policy Adapter
    • Invokes OOF Adapter
    • Invokes Notification Manager (TBD)
    • Invokes FM/PM Event Manager (TBD)
    • Invoke K8S Client (TBD)
Yes



Create NS 

SOL005 NBI Handler invokes the Create NS workflows which do the following:

<Create NS>

  • Initialize Parameters: set csar_id, ns_name, description, global_customer_id, service_type from the parameters to the execution variables
  • Get NS Package from ETSI Catalog Manager: query ETSI Catalog Manager for an NS package with the given csar_id 
  • Check NSD Validation: check if the NSD package exists in the ETSI Catalog Manager DB; otherwise generates errors
  • Check if an NS Instance (with the ns_name as the key) exists in the NS Instance DB (NFVO_NSINST DB table)
  • Create NS Instance in NS Instance DB: stores the NS instance data into the NS Instance DB with the status= 'NOT_INSTANTIATED'
    • create an ns instance id (uuid)
    • store ns_instance_id, ns_name, ns_package_id, nsd_id, nsd_invariant_id, description, lastuptime, global_customer_id, service_type
  • Create NS instance in AAI: store an NS instance data to AAI as follows:
    • service-instance-id = ns_inst_id
    • service-instance-name = ns-name
    • service-type = SERVICE_TYPE (NetworkService)
    • service-role = SERVICE_ROLE (NetworkService)
  • get nsInstance from GetNSInfoService
  • return 201 Created with the NsInstance
  • Send NsIdentifierCreationNotification


Yes



Instantiate NS

SOL005 NBI Handler invokes the Instantiate NS workflows which do the following:

<Instantiate NS>

  • Initialize Parameters: set ns_inst_id, plan_input
    • plan_input = job_id, ns_inst_id, dst_plan, additionalParamsForNs, additionalParamsForVnf, additionalParamsForPnf
    • dst_plan = get nsd with the given nspackage_id, input parameters
    • Get an ns instance id from the parameter
  • Create a Job: create a job for the ns instance id and return a job_id
    • create a job object with job_type = NS, job_action= NS_INST, ns_inst_id
    • store it to NFVO_JOB database table
  • create an occ id for the ns instance id
  • Update the status of ns_instance record in DB: update the ns instance id row of the NFVO_NSINST db for status (= INSTANTIATING)
  • get a ns instance data from DB for the given ns_inst_id: get an NS records from the NFVO_NSINST db for the ns instance id
  • collect parameters for NS: get and store additional Parameters for NS
  • Get an VIM id: get an VIM id from the cloud owner and cloud region parameters
  • Get VNF VIM: get an VNF VIM from the location constraints
  • set the job status with 'Start Query NSD'
  • get NSD from ETSI Catalog Manager & Parse NSD: get and parse a nsd for the ns package id
    • get ns model (dst_plan)
  • Update NFVO_INST db to modify nsd model (dst_plan)
  • Prepare each VNF request: 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: 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 db: 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)


Yes



Terminate NS

SOL005 NBI Handler invokes the Terminate NS workflows which do the following:

<Terminate NS>


  • Initialize Parameters: Get an ns_inst_d, job_id and request_data from the parameters
    • set terminate_type, terminate_timeout from request_data 
    • set job_id, ns_inst_id
    • set occ_id by creating a record in NsLcmOpOccModel DB
  • Check if the NS instance in NS_INST DB: if there no matching ns_inst_id from the NFVO_NSINT database table, consider there is nothing to terminate, and return
  • Set Job Status to Starting: 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



Yes



Delete NS

SOL005 NBI Handler invokes the Delete NS workflows which do the following:

<Delete NS>

  • Initialize Parameters: get ns_inst_id
  • delete ns instance in AAI
    • get ns_instances from NFVO_NSINST database table
    • if there are ns_instances, 
      • query AAI for global_customer_id, service_type, ns_inst_id
      • 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


Yes



Get NS Operation Status

SOL005 NBI Handler invokes the Get NS Operation Status workflows which do the following:

  • Initialize Parameters: set lcm_op_occ_id, parameter
  • if the nsLcmOpOccId pareameter is present, 
    • Query NSLCMOPOCCS DB for the nsLcmOpOccId
    • return NsLcmOpOcc
  • else
    • Query NSLCMOPOCCS DB for all
    • return NsLcmOpOcc[]
Yes



Create NS Subscription

SOL005 NBI Handler invokes the Create NS Subscription workflows which do the following:


  • Initialize Parameters: set subscription filters
    • callback_uri
    • authentication
    • notification_types
    • operation_types
    • operation_states
    • ns_component_types
    • lcm_opname_impactin_nscomponent
    • lcm_opoccstatus_impacting_nscomponent
    • nsInstanceSubscriptionFilter
  • Create Subscription ID: create subscription id
  • Check valid auth info:
  • Check Filter Type:
    • check if the notification is NOTIFICATION_TYPE.NSLCM_OPERATION_OCCURRENCE_NOTIFICATION
  • Check Valid:
    • Check Callback_URI: check callback Uri
      • check if the callbackUri exists in the NFVO_SUBSCRIPTION DB
        • if no subscription, return true
        • else 
          • check additional filter types, notificationTypes, operationTypes, operationStates
            • if the filters are NOT equal, return false
          • check ns instance filter, If the filter type is not equal, return false
        • return true
  • save subscription request to database
  • return response with subscription
Yes



Get NS Subscription




Delete NS Subscription




Send NS Notifications



















































Support for NS Resource Manager (P1 partial)
  • Provides Resource Granting Information through OOF (Policy, MultiCloud, A&AI) (P1)
    • 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) (P1 Partial)
    • Software Image Management (P1)

    • 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
Yes


Support for NS Catalog DB Adapter (P1)
  • Provides access for ETSI Catalog Manager
  • Get notifications from ETSI Catalog Manager
Yes


Support for NS Inventory Adapter (P1)
  • Provides access for AAI for NS LCM
  • Refactoring of the current AAI Adapter
Yes


Support for MultiCloud Adapter (P1)
  • Provides MultiCloud Access
  • Refactoring of the current SO MultiCloud Adapter
Yes


Support for Configuration Mgr (P2)
  • Provides APPC and or CDS access
  • Refactoring of the current APPC and CDS connection
Yes


Support for Policy Adapter (P2)
  • Provides Policy access
  • Refactoring of the current Policy access
Yes


Support for OOF Adapter (P1?)
  • Provides OOF access for homing
  • Refactoring of the current OOF access
  • Need to discuss further
Yes


Supports for Notification Manager (P1)
  • Provides notifications to SO E2E
  • depends on the SOL003 notification endpoint
?TBD
Support for FM/PM Event Manager (P3)
  • Provides access to DCAE
?TBD
Support for K8S client (P3)
  • Provides access to K8S
  • When we support CNF, it will be done, not for Guilin
?TBD
Support for SOL005 Adapter to interface to/from ONAP SO NFVO (P1)

SOL005 Adapter supports interfaces to/from ONAP SO NFVO

  • SOL005 Adapter sends SOL005 requests to the ONAP SO NFVO, as one of the choices (SO NFVO, VFC, External NFVO)
  • SOL005 Adapter subscribes (CREATE and DELETE) to ONAP SO NFVO for notifications
  • SOL005 Adapter provides notification endpoint(s) to receive notifications (P1)
  • Swagger will be provided to the SOL005 Adapter development
Yes














NFVO Architecture & Functions

The following diagram depicts the NFVO component architecture



NFVO Microservice Plugin Framework - high priority

SOL005 NBI (API Handler)- high priority

NS Workflows - high priority


ETSI Package Onboarding for NFVO - enhancements of current capabilities



NS LCM Database  - high priority

TBD


SOL003 Adapter for SVNFMs - leveraging existing capabilities


Resource Manager - high priority

Notification Manager (stretch goal)


FM/PM Manager (not for Guilin)

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 SONFVO

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



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

Request

CreateNsRequest

Response

NsInstance

NS LCM Manager Design

VFC design 

Proposal

The following diagram depicts the Create NS procedure.


Instantiate NS

Request

InstantiateRequest

Response

201 Accepted

NsLcmOperationOccurrenceNotification (Start/Processing/Completed)


NS LCM Manager Design

VFC Design

Proposal

The following diagram depicts the Instantiate NS.


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


Request

TerminateNsRequest

Response

201 Accepted

NsLcmOperationOccurrenceNotification (Start/Processing/Completed)


NS LCM Manager Design

VFC Design

Proposal

The following diagram depicts the Terminate NS.

Delete NS



Request


Response

Notification


NS LCM Manager Design

VFC_Design

Proposal

The following diagram depicts the Delete NS.


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

Response


Subscription Filter Request

The following table describes the Subscription filter request.

attribute namedata typecardinalitydescription

nsdIds

Identifier0..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

Identifier0..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.

pnfdIdsIdentifier0..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.

nsInstanceIdIdentifier0..N

If present, match NS instances with an

instance identifier listed in this attribute.

See note 2.

nsInstanceNamesString0..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


Proposal

The following diagram depicts the Subscription NS.