Screenshot from 2022-06-28 18-10-41Page Status: Updated for Kohn -  
Component Status: Pending PTL Updates and ArchCom Review

Last Reviewed: Arch Team

Certified by:

1. High Level Component Definition and Architectural Relationships 



2. API Definitions

2a. Exposed APIs

Interface NameDefinitionCapabilitiesVersionStatusPayload Model(s)Change in Kohn releaseAPI Spec (Swagger)
SO-E-01Service and Resource order requests

Service Instance management (Service, Volume Group, VF Module, VNF, PNF and CNF)

Health check, global and node.

Infrastructure provider management (Certificates, networks, sub-networks, security groups)

3.1.2ProductionEmbedded in interfaceinterface changed to https changed Swagger,json
SO-E-02SO maintenance requests

Monitoring of the SO BPMN flows.

Upload of new recipe war files.

8.0.0Development and EvaluationEmbedded in interfaceinterface  to https changed Monitoring_Swagger.json

2b. Consumed APIs

ONAP component wise details

Interface NameDescription
SDCE-6Service/Resource model notification
POE-5Delegation of decision to policy logic
OOF-HASDelegation of placement decision
AAIE-1Ingest/update state of services and resources
MCE-2

Assign and configure infrastructure resources

CONE-3Assign and configure network resources
APPCAssign and configure resources
(Using APPC library hosted in BPMN)
[Yang, REST, DMaaP]
VFCE-2 (SOL005)Delegation of Network Service LCM
SOL003Delegation of VNF LCM  to VNFM
SDCE-7Service/Resource model query
etsicatalogAPIE-1

Catalog API

Provides catalog management interface:

  • fetch VNF package from SDC
  • fetch NS package from SDC
  • fetch Service package from SDC
  • search VNF/NS/Service
etsicatalogAPIE-2

NSD Management API

Provides NSD management interface (Align with ETSI SOL-005)

  • Create NSD Info
  • Upload NSD
  • Query NSD Info
  • Fetch NSD
  • Delete NSD
  • Create PNFD Info
  • Upload PNFD
  • Query PNFD Info
  • Fetch PNFD
  • Delete PNFD
  • Subscribe & Notify
etsicatalogAPIE-3

VNF Management API

Provides VNF management interface (Align with ETSI SOL-003)

  • Create VNF Package Info
  • Upload VNF Package
  • QueryVNF Package Info, include obtaining the VNFD
  • Fetch VNF Package
  • Fetch VNF Package Artifacts
  • Delete VNF Package
  • Subscribe & Notify
etsicatalogAPIE-4

Parser API

Provides Parse interface:

  • Parse VNF
  • Parse PNF
  • Parse NS
  • Parse Service


3. Component Description

Orchestration is the execution of various modules capabilities in harmony as a consolidated process to accomplish the desired tasks. The Service Orchestrator (SO) component of ONAP provides orchestration at a very high level, with an end to end view of the infrastructure, network, and applications.

SO's primary function is the automation of end-to-end service instance provisioning activities. SO is responsible for the instantiation and configuration of VNFs in support of overall end-to-end service instantiation, operations and management. SO executes well-defined processes to complete its objectives and is typically triggered by the receipt of service requests generated by other ONAP components or by Order Lifecycle Management in the BSS layer. The orchestration procedure is either created manually or obtained from the Service Design and Creation (SDC) component of ONAP, where all service designs are created and exposed/distributed for consumption

Internally, SO is organized as a set of modules with well defined responsibility. External adapters (SDNC, OpenStack, VFC and SOL003) encapsulate most communication with external systems. Persistence is exposed to other SO modules – not externally, by DB adapters (Catalog and Request). The underlying workflow component resides in the BPMN Execution Engine. The BPMN Execution Engine also interacts with other ONAP systems such as App controllers, AAI and OOF-HAS. Interactions with SNC are hosted by the SDC Controller. Likewise the API Request Handler exposes SOs API for interaction with clients. Finally there is also a monitoring component that allows insight into the execution state of workflows.

4. Known System Limitations

https://docs.onap.org/projects/onap-so/en/latest/release-notes.html#release-notes

5. System Deployment Architecture

https://docs.onap.org/projects/onap-so/en/latest/architecture/architecture.html


6. New Release Capabilities

The new enhancements proposed







7. References

  1. Interfaces: https://docs.onap.org/projects/onap-so/en/latest/index.html#master-index


  • No labels

1 Comment

  1. Alessandro Gerardo D'Alessandro

    Hi, I noticed a discrepancy between the figure in section 1 and the list of consumed APIs in section 2b. More specifically, in the list of consumed APIs there is no description about APIs towards Openstack, CDS/CCSDK, DCAE, NSSMF