ONAP SO ETSI-Aligned Hierarchical Orchestration

Support SO NFVO function Microservice plugin capabilities, leveraging MSB, SpringBoot and Kubernetes,  for hosting NFVO function components by configuration. So, the SO NFVO can be customized in a future by operators.

• Support for substitution of existing function plugins
  
  • Supports registration of a new substitution Microservice with version control (leverage a mechanism like AAI ESR)
  • supports plug-in mechanism of substitution Microservices
  • Dynamic dispatching/launching plugin instances based on configuration/policy
• Support for extension of existing function plugins
  
  • Default function plugin extension with version control
  • Dynamic dispatching/launching an extended plugin instance based on configuration/policy
• Test Service Discovery
• Test Inter-Service Communication (for Guilin, SOL003 Adapter)

Note: we are not building the Microservice service registration, aggregation, discovery and routing engine itself, but we are leveraging the engine's capability (e.g., MSB, API Fabric, Kong, or Kubernetes & service discovery) to offer configuration of NFVO Microservice components access. 

In Guilin, the following will be supported

• Configure Microservice registration
  • The following default function Microservices will be plugged in: 
    • NS LCM Manager including:
      • SOL005 NBI API Handler
      • NS Workflows and Logic
      • Embedded Camunda Workflow Engine
      • MultiCloud Adapter client
      • ETSI Catalog Manager Adapter
      • AAI Client
    • SOL003 Adapter
    • Shared Camunda Workflow Engine (allow to use ONAP SO Camunda engine) - if ONAP SO Dynamic BPMN is available.
    • ETSI Catalog Manager Adapter (in Guilin, it is part of NS LCM Manager)
    • NS Resource Infra Management (RIM) Manager
    • MultiCloud Adapter (in Guilin, reuse of ONAP SO MultiCloud Adapter)
    • Inventory DB Adapter (In Guilin, reuse of ONAP SO AAI client)
    • Notification Manager (not for Guilin)
    • Policy Adapter (not for Guilin)
    • K8S Client (not for Guilin)
    • Configuration Adapter (not for Guilin)
    • FM/PM Event Adapter (not for Guilin)

SO-2841 - Getting issue details... STATUS

Preconditions:

• ETSI SOL007 NS packages are onboarded into SDC and distributed to ETSI Catalog Manager.
• In Guilin, we are testing SOL005-compliant requests, allowing the CLI-based SOL005 client sends SOL005 requests directly to SO NFVO in case the UUI - SO - E2E Workflows - NS Workflows - SOL005 Adapter sequences are NOT ready for Guilin.

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
• Leverages SOL005 Swagger Files for SO NFVO SOL005 NBI API Handler
  • https://forge.etsi.org/jenkins/view/All+jobs/job/NFV+-+Network+Functions+Virtualisation/job/sol005-master/
    
    • SOL005-NSLifecycleManagement-API.json
    • SOL005-NSLifecycleManagementNotification-API.json
  • This API Handler focuses on the SOL005 APIs, and its business logic is supplied by the NS LCM Microservice
• Make SO-NFVO (so-etsi-nfvo) Pod is deployable in OOM
• Register the SO NFVO NS LCM pod to AAI automatically 

SO-2842 - Getting issue details... STATUS

• Preconditions: 
  • SOL007 NS packages are stored in ETSI Catalog Manager.
  • the Cli-based SO NFVO Client is ready to send the SOL005-compliant Create NS request
  • The SO-NFVO (so-etsi-nfvo) pod is ready

• Support the SOL005-compliant Create NS API 
  • Supports Create NS request API: POST /api/nslcm/v1/ns_instances (CreateNsRequest)
  • Supports Create NS responses with NsInstance with 201 (for success) or an error
    • Returns a dummy 201 until the backend business logic is ready 
    • Only mandatory attributes of NsInstance will be set.
    • Support successful or error conditions
  • Sends NsIdentifierCreationNotification to the NFVO subscriber(s) (e.g., ONAP SO SOL005 Adapter)
    • Note: this will be handled by the separate user story: Sends NsIdentifierCreationNotification to the NFVO subscriber(s) (e.g., ONAP SO SOL005 Adapter)

• Post conditions: the NS Instance is set as NOT_INSTANTIATED state

Note: secure communication is handled by a separate user story, SO-3165.

SO-2858 - Getting issue details... STATUS

• Preconditions:
  • NS instance is NOT_INSTNANTIATED state
  • SOL007 NS packages are stored in ETSI Catalog Manager.
  • the Cli-based SO NFVO Client is ready to send the SOL005-compliant Instantiate NS request
  • The SO-NFVO (so-etsi-nfvo) pod is ready

• Supports the SOL005-compliant Instantiate NS API 
  • Supports Instantiate NS request API: POST /api/nslcm/v1/ns_instances/{nsInstanceId}/instantiate (InstantiateNsRequest)
  • Supports responses 202 Accepted with an empty payload body
    
    • Returns a dummy 202 until the backend business logic is ready 
  • Supports NS Lifecycle Operation Occurrence Notification
    • Use 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}
    • Supports the Sends nsLcmOperationOccurrenceNotifiation (start, result) notification operation until the result status becomes COMPLETED
  • Optionally, Instantiate NS operations uses the GET individual NS LCM operation occurrence request and response
  • Error handling: if the operation is failed, error information is provided in the notification message

• Post conditions: the NS Instance is as the INSTANTIATED state

Note: secure communication is handled by a separate user story, SO-3165.

SO-2859 - Getting issue details... STATUS

• Precondition: NS instance is INSTANTIATED state
• SOL007 NS packages are stored in ETSI Catalog Manager.
• the Cli-based SO NFVO Client is ready to send the SOL005-compliant Terminate NS request
• The SO-NFVO (so-etsi-nfvo) pod is ready

• Supports the SOL005-compliant Terminate NS API
  • Supports Terminate NS request API: POST /api/nslcm/v1/ns_instances/{nsInstanceId}/terminate (TerminateNsRequest)
  • Supports responses 202 Accepted with an empty payload body
    • Returns a dummy 202 until the backend business logic is ready 
    • Use 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}
  • Supports the Sends nsLcmOperationOccurrenceNotifiation with nsLcmOpOccId, notificationStatus (start, result) until the result status becomes COMPLETED 
  • Optionally, Terminate NS operations uses the GET individual NS LCM operation occurrence request and response
• Error handling: if the operation is failed, error information is provided in the notification message

• Post conditions: the NS Instance is set as the TERMINATED state

Note: secure communication is handled by a separate user story, SO-3165.

SO-2860 - Getting issue details... STATUS

• Precondition: NS instance in NOT_INSTANTIATED state
• SOL007 NS packages are stored in ETSI Catalog Manager.
• the Cli-based SO NFVO Client is ready to send the SOL005-compliant Create NS request
• The SO-NFVO (so-etsi-nfvo) pod is ready

• Supports the SOL005-compliant Delete NS API
  • Supports Delete NS request API: DELETE /api/nslcm/v1/ns_instances/{nsInstanceId}
  • Supports the Sends 204 No Content with an empty payload body
    • Returns a dummy 204 until the business logic is ready
  • Sends NsIdentifierDeletionNotification to the NFVO subscriber(s) (e.g., ONAP SO SOL005 Adapter)
    
    • Note: this will be handled by the separate user story: Sends NsIdentifierCreationNotification to the NFVO subscriber(s) (e.g., ONAP SO SOL005 Adapter)
• Error handling: if the individual NS instance is not in NOT_INSTANTIATED state, it rejects the deletion request

• Postconditions: the resource representing the NS instance has been removed from the list of NS instance resources

Note: secure communication is handled by a separate user story, SO-3165.

SO-2861 - Getting issue details... STATUS

SO-3165 - Getting issue details... STATUS

SO-2862 - Getting issue details... STATUS

SO-3141 - Getting issue details... STATUS

SO-2864 - Getting issue details... STATUS

SO-2863 - Getting issue details... STATUS

SO-2865 - Getting issue details... STATUS

SO-2866 - Getting issue details... STATUS

SO-3165 - Getting issue details... STATUS

SO-2843 - Getting issue details... STATUS

Supports the Create NS backend operations and workflows which do the following sequence:

<Create NS: note: the following workflow is a template, and it can be enhanced as needed.>

• Supports SOL005-compliant CreateNSRequest request and parameters
  • For AAI, supports global_customer_id and service_type as part of HTTP header
    • This is not SOL005 standards, but for AAI, these parameters would be necessary.
    • Note: if there is an alternative way, please propose.
• Supports getting NS Package from ETSI Catalog Manager
  • Query ETSI Catalog Manager for an NS package with the given csar_id (nsdId)
• Supports NSD Validation check:
  • check if the NSD package exists in the ETSI Catalog Manager DB; otherwise generates errors
• Supports check of an existing NS Instance
  • If an existing NS instance is found, it is an error condition. Returns a proper error.
  • else 
    • Creates NS Instance in the NS Instance DB:
      • stores the NS instance data into the NS Instance DB with the status= 'NOT_INSTANTIATED'
    • Creates a unique ns instance id (uuid)
    • Stores NS instance attribute data into the NS Instance DB.
      • e.g., ns_instance_id, ns_name, ns_package_id, nsd_id, nsd_invariant_id, description, lastuptime, global_customer_id, service_type
      • Adds additional attributes as needed
• Create an NS instance in AAI:
  • Stores an NS instance to the AAI Service Instance with required attributes as follows.
    • Note: shares the AAI Service Instance with the NetworkService type and role.
    • service-instance-id = ns_inst_id
    • service-instance-name = ns-name
    • service-type = SERVICE_TYPE (NetworkService)
    • service-role = SERVICE_ROLE (NetworkService)
• For the response, gets the nsInstance data from GetNSInfoService
  • Collects only the NS related mandatory information, not VnfInstance, VlInstance, or else
  • Note: CreateVNF and InstantiateVNF happen during the InstantiateNS, not part of Create NS
• Supports return of 201 Created with the NsInstance (with NS related mandatory information)
• Register SO NFVO in MSB (SO-3225)

SO-2867 - Getting issue details... STATUS

Supports the Instantiate NS backend operations and workflows which do the following sequence:

<Instantiate NS: note: the following workflow is a template, and it can be enhanced as needed.>

• Supports SOL005-compliant InstantiateNSRequest request and parameters
  • Creates BPMN workflows and business logic for the following Instantiate NS operations
    • Create a Job Id
      
      • Updates NS_Instance Status to INSTANTIATING to the NFVO NS Instance database table
      • Handles input parameters from the InstantiateNsRequest
        • additionalParamsForNs
          • the VnfProfileId is the vnf descriptor id from the tosca.nodes.nfv.VNF vnf_profile (tosca.datatypes.nfv.VnfProifle) properties in NSD
            • note: the VnfProfile data type properties are: instantiation_Level, min_number_of_instances, max_number_of_instances
            • note: this property is only used in an NSD service template when describing a VNF node template with the corresponding VnfProfile information.
          • pass vim_id with tenant id
        • additionalParamsForVnf
          • If it is provided in the request, use additionalParamsForVnf attributes when invoking SOL003 Adapter.
          • Otherwise, formulate additionalParams for SOL003 Adapter invocation from the NSD plus additional user input
          • use of VNF input for additionalParamsForVnf is under investigation
        • pseudo logic:
          
          • 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
          • get job id and occ id from the NS LCM Mgr
      • Gets VNF VIM from the location_constraints
      • Gets NSD from ETSI Catalog Manager and parses NSD (by using either SDC parser or ETSI Catalog Manager parser)
        • Note: until either SDC parser or ETSI Catalog Manager parser is ready, use the current SO NFVO internal TOSCA parser
      • If ETSI Catalog Manage parser is used, use the following ETSI Catalog Manager API:

curl -X POST /api/parser/v1/parsernsd' \

-H 'Content-Type: application/json' \

--data-raw '{

    "csarId": "csarid",

    "packageType": "ns",

    "inputs": "[]"

}'

• Updates NFVO_INST db to modify nsd model
  • Gets VNFs from the NSD
  • For each VNF, invokes the SOL003 Adapter with SOL003-compliant requests
    • To call the SOL003 Adapter, use the current SOL003 Adapter Rest API (which is internal to SO)
      • Note: exposing ETSI SOL003-compliant SOL003 Adapter REST API will be handled by the separate user story (most likely in the Honolulu release). 
      • The SOL003 Adapter internal REST API will be enhanced to carry additional attribute(s), such as tenant id, VNF package id
      • The Create VNF internal API in SOL003 Adapter will invoke both Create and Instantiate VNFs
      • Send parameters such as vnfd_id, vnfm_type, vimId, s_vimId (with "cloud_owner"_"cloud_regionid") and tenant id to SOL003 Adapter
      • For Granting VNF, support VNF granting based on the existing SOL003 Adapter.
    • Note: 
      • Currently SOL003 adapter uses “ModelVersionId" from generic-vnf to retrieve the VNFD from SDC/etsi catalog. In order to create generic-vnf it also need model invariant id because of the relationship defined between generic-vnf and service-design-and-creation/models.
  • Supports VirtualLink connections between VNFs
    • Supports createVLs (call MultiCloud through MultiCloud Adapter)
      • Follow the Create VLs user story
  • Updates NFVO_NSINST db table: update NFVO_NSINST with the nsd model
  • Sets job status = NS Instantiate ends
  • Updates NsLcmOpOCC to COMPLETED
  • Note: Sends nsLcmOperationOccurrenceNotification
    • Note: this notification will be handled by a separate notification and subscription user story.

SO-2868 - Getting issue details... STATUS

Supports the Terminate NS backend operations and workflows which do the following sequence:

<Terminate NS: note: the following workflow is a template, and it can be enhanced as needed.>

• Supports SOL005-compliant TerminateNSRequest request and parameters
  • Only support for the immediate Terminate request; i.e., terminateTime field is empty.
• Creates BPMN workflows and business logic for the following Terminate NS operations
  • Supports input parameter handling
    • 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
  • Checks if the NS instance already exists
    • if there no matching NS instance from the NFVO_NSINT database table, consider there is nothing to terminate, and return (not an error, but log that there is no matching NS instance)
  • Sets Job Status to Starting: set job status as "Starting terminate..."
  • Updates the NFVO_NSINST database table with the status = TERMINATING
  • Cancels VNF list (through SOL003 Adapter)
    • Gets a VNF instance list from the NFVO_NFINST
      • for each vnf inst
        • delete_vnf (nf_instid)
          • POST /api/nslcm/v1/ns/terminateVnf/{instId} to the SOL003 Adapter
    • For the Terminate VNF internal request, the SOL003 Adapter will invoke both Terminate and Delete VNF operations
  • Cancels VL list (through MultiCloud Adapter)
    • Follow the Delete VLs user story; pass the VL list
  • Modifies the NFVO_NSINST database table, status = NOT_INSTANTIATED
  • Sets job status = NS terminate ends
  • Updates NsLcmOpOCC to COMPLETED
  • Note: Send nsLcmOperationOccurrenceNotification
    • Note: this notification will be handled by a separate notification and subscription user story.

SO-2869 - Getting issue details... STATUS

Supports the Delete NS backend operations and workflows which do the following sequence:

<Delete NS: note: the following workflow is a template, and it can be enhanced as needed.>

• Supports SOL005-compliant DeleteNS operation with nsInstanceId
• Creates BPMN workflows and business logic for the following Delete NS operations
  • Supports input parameter handling
    • Initialize Parameters: get ns_inst_id
  • Deletes ns instance in AAI
    • Gets ns_instances from NFVO_NSINST database table
    • if there are ns_instances, 
      • Queries AAI for global_customer_id, service_type, ns_inst_id
        • set resource_version from ns_info "resource-version"
      • Invokes delete_ns_aai with global_customer_id, service_type, ns_inst_id, resource_version
        • Formulates the resource url with parameters
        • Invoke AAI Rest API: call_aaI (resource, "DELETE")
    • note: if there are discrepancies between VNF and NS status in AAI (e.g., VNF was not deleted yet), it is an error condition
  • Deletes ns_inst_id row from the NFVO_NSINST database table
    • note: if multiple records for the givin ns_inst_id are found, it is an error condition
  • Deletes ns_inst_id row from the t_lcm_inputparam_mapping database table
  • Deletes ns_inst_id row from the t_lcm_defPackage_mapping database table
  • Deletes ns_inst_id row from the t_lcm_servicebaseinfo database table
  • Returns 204 No Content
  • Send NsIdentifierDeletionNotification
    • Note: this notification will be handled by a separate notification and subscription user story.

SO-2870 - Getting issue details... STATUS

Supports the Get NS Operation Status operation and workflows which do the following sequence:

<Get NS Operation Status: note: the following workflow is a template, and it can be enhanced as needed.>

Note: the following workflow is for illustration purpose. Since the operation sequence (sending a query to a database and get the NsLcmOpOcc data, the work flow is not necessary

• Supports SOL005-compliant Get NS Operation Status operation
• Supports input parameters handling:
  • Initialize Parameters: set lcm_op_occ_id, parameter
• if the nsLcmOpOccId exists, 
  • Queries NSLCMOPOCCS DB for the nsLcmOpOccId
  • Returns NsLcmOpOcc
• else
  • Queries NSLCMOPOCCS DB for all
  • Returns NsLcmOpOcc[]
• In Guilin, support only the individual GET nsLCMOPOCCS.

SO-2871 - Getting issue details... STATUS

Supports the Create NS Subscription operation and workflows which do the following sequence:

<Create NS Subscription: note: the following workflow is a template, and it can be enhanced as needed.>

• Supports SOL005-compliant Create NS Subscription operation
• Supports input parameters handling:
  • Initializes 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
  • Creates Subscription ID: create subscription id
  • Checks valid auth info:
  • Checks Filter Type:
    • checks if the notification is NOTIFICATION_TYPE.NSLCM_OPERATION_OCCURRENCE_NOTIFICATION
  • Checks Valid:
    • Checks Callback_URI: check callback Uri
      • checks if the callbackUri exists in the NFVO_SUBSCRIPTION DB
        • if no subscription, return true
        • else 
          • checks additional filter types, notificationTypes, operationTypes, operationStates
            • if the filters are NOT equal, return false
          • checks ns instance filter, If the filter type is not equal, return false
        • return true
  • saves subscription request to database
  • returns response with subscription

SO-2872 - Getting issue details... STATUS

Supports the Get NS Subscription operation and workflows which do the following sequence:

<Get NS Subscription: note: the following workflow is a template, and it can be enhanced as needed.>

• Supports SOL005-compliant Get NS Subscription operation
• Supports input parameters handling:
  • Initializes Parameter: set subscription_id, params
• if there is no param, 
  • Queries NFVO_SUBSCRIPTION DB for all
  • Returns LccSubscription[]
• else if there is param, subscriptionId,
  • Queries NFVO_SUBSCRIPTION DB for the subscriptionId
  • Returns LccSubscription

SO-2874 - Getting issue details... STATUS

Supports the Delete NS Subscription operation and workflows which do the following sequence:

<Delete NS Subscription: note: the following workflow is a template, and it can be enhanced as needed.>

• Supports SOL005-compliant Delete NS Subscription operation
• Supports input parameters handling:
  • Initialize Parameters: set subscriptonId
• Deletes NFVO_SUBSCRIPTION DB for the subscriptionId
• if success, return 204 No Content
• else, return error

SO-2875 - Getting issue details... STATUS

Supports the Send NS Notification operation and workflows which do the following sequence:

<Send NS Notification: note: the following workflow is a template, and it can be enhanced as needed.>

• Supports SOL005-compliant Send NS Notification operation
• Supports input parameters handling:
  • Initialize Parameter:
    • query NFVO_SUBSCRIPTION DB for the given key
    • get the callback URI from the return subscription 
• Formulates notification data (one of the followings)
  • NsLcmOperationOccurrenceNotification,
  • NsIdentifierCreationNotification,
  • NsIdentifierDeletionNotification or
  • NsChangeNotification
• Sends notifications to the subscriber(s) for NS LCM: POST <<callback URI>> (<<Notification>>)
• Gets response: 204 No Content from the subscriber (e.g, SO SOL005 Adapter)

SO-2876 - Getting issue details... STATUS

SO-2886 - Getting issue details... STATUS

SO-2887 - Getting issue details... STATUS

SO-2888 - Getting issue details... STATUS

SO-3142 - Getting issue details... STATUS

SO-2845 - Getting issue details... STATUS

• Queries ETSI Catalog Manager for NS/PNF/VNF packages by using the ETSI Catalog Manager package management swagger
  • Note: for VNF packages, refer to the existing SOL003 Adapter ETSI Catalog Manager access mechanism
  • ETSI Catalog Manager package management swagger (could be updated for v2.7.1):
  • note: for SO NFVO, only NS and VNF package management API will be used, not PNF

SO-2877 - Getting issue details... STATUS

• Provides the notification endpoint for NS/PNF/VNF packages by using the ETSI Catalog Manager package management notification swagger.
  • Note: for VNF package notification, refer the existing SOL003 Adapter ETSI Catalog Manager access mechanism
  • Note: use the notification endpoint as callback uri during subscription
  • ETSI Catalog Manager package management notification swagger (could be updated for v2.7.1):

SO-2878 - Getting issue details... STATUS

SO-2846 - Getting issue details... STATUS

SO-2880 - Getting issue details... STATUS

SO-2881 - Getting issue details... STATUS

SO-2882 - Getting issue details... STATUS

SO-2883 - Getting issue details... STATUS

SO-2889 - Getting issue details... STATUS

SO-2847 - Getting issue details... STATUS

SO-2884 - Getting issue details... STATUS

SO-2885 - Getting issue details... STATUS

SO-2891 - Getting issue details... STATUS

SO-2892 - Getting issue details... STATUS

SO-2893 - Getting issue details... STATUS

SO-3159 - Getting issue details... STATUS

SO-3225 - Getting issue details... STATUS

SO-2844 - Getting issue details... STATUS

SO-2894 - Getting issue details... STATUS

SO-2895 - Getting issue details... STATUS

SO-2857 - Getting issue details... STATUS

remove ETSI Catalog Manager trigger from ONAP SO for package distribution

• In Guilin, ETSI Catalog Manager directly consumes SDC package notification and query for the ETSI packages
• Fix ONAP SO after the Modeling user story code check-in:  MODELING-335 - Getting issue details... STATUS ,  MODELING-336 - Getting issue details... STATUS

SO-3220 - Getting issue details... STATUS

SO-2848 - Getting issue details... STATUS

SO-2849 - Getting issue details... STATUS

SO-2850 - Getting issue details... STATUS