From e51eccb6433d9dfeb2b57de399578c6bd6b70b75 Mon Sep 17 00:00:00 2001 From: seshukm Date: Thu, 9 Nov 2017 11:14:47 +0530 Subject: updating the architecture.rst file for SO IssueId: SO-300 Change-Id: I484f3fe19cb0d9b8718af4e7af9ef61ee4b5a75a Signed-off-by: seshukm --- docs/architecture.rst | 103 ++++++++++++++++++++++++++++++++++++-- docs/images/SO_Architecture_1.png | Bin 0 -> 108239 bytes docs/index.rst | 3 +- 3 files changed, 100 insertions(+), 6 deletions(-) create mode 100644 docs/images/SO_Architecture_1.png diff --git a/docs/architecture.rst b/docs/architecture.rst index ac7740080b..7c01077dcc 100644 --- a/docs/architecture.rst +++ b/docs/architecture.rst @@ -7,10 +7,103 @@ SO - Service Orchestration SO Architecture ---------------- -SO architecture and internal details could be found in the below wiki link -https://wiki.onap.org/pages/viewpage.action?pageId=9830754 +.. image:: images/SO_Architecture_1.png + +SO Sub-Components +------------------ + +**API Handler** + + RESTful interface to northbound clients + + * Handle service-level and infrastructure (VNF & network) requests + + Service-agnostic APIs + * “Service Instantiation API” + + Model-driven recipe selection + * Use SO Catalog to map input requests to BPMN flows + * Dynamic lookup based on service-model + action + * Input data forwarded to BPMN flow + + Track open and completed requests via SO Request DB + + Multiple API-H modules may support different APIs + +**BPMN Execution Engine** + + Open-source Camunda platform + * Support BPMN 2.0 service recipes + + Expose RESTful interface to API-H (unique path per recipe) + + Make use of common “building block” sub-flows + + Sequence orchestration steps for each Resource in the recipe + * Request and configure network resources via SDN-C + * Manage cloud resources via PO (OpenStack) + * Update inventory via A&AI + + Perform error handling/rollback + +**Resource Adapters** + + Interfaces to lower level controllers and other ONAP components + * Platform Orchestrator, SDN-Controller, APP-Controller, VFC-Controllers + * Hides the details of complex interfaces (e.g. OpenStack APIs) + * Expose interfaces to BPMN flows as SOAP or REST APIs + * Support synchronous and asynchronous operations + + Provided as part of SO platform for use by all BPMN flows + + Use SO Catalog to map resource requests to a recipe/template + + Data-driven design + * Catalog templates may be updated via self-service (outside of release cycles) + * Merge input parameters with templates at run-time + +**Data Stores** + + Request DB + * Tracks open and completed requests + + SO Catalog + * SO view of the SDC Catalog + * service and resource models, recipes, and templates + * Populated via SDC distribution service from TOSCA models + + Camunda DB + * Maintain state for BPMN flows + * Supports multiple active engines + +**SDC Distribution Client** + + Receive updated service models from SDC + * Event-bus notifications when new models available + * HTTP retrieval of models (TOSCA) and artifacts (Heat) + + Receive distributions as TOSCA models + + Populate SO Catalog + + Support self-service updates to models and artifacts + +Third Party and Open Source +--------------------------- + +**BPMN Engine** + Camunda (open source) + +**Other Open Source Components of Note:** + JBOSS EAP/Wildfly + MySQL/MariaDB + Openstack Java SDK (“woorea”) + + + + + + + -.. toctree:: - :maxdepth: 1 - \ No newline at end of file diff --git a/docs/images/SO_Architecture_1.png b/docs/images/SO_Architecture_1.png new file mode 100644 index 0000000000..a50c01bdd9 Binary files /dev/null and b/docs/images/SO_Architecture_1.png differ diff --git a/docs/index.rst b/docs/index.rst index 4aa515b4d5..9fd4cc3f97 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -11,4 +11,5 @@ ONAP SO Install_Configure_SO.rst architecture.rst offered_consumed_apis.rst - developer_information.rst \ No newline at end of file + developer_information.rst + release-notes.rst \ No newline at end of file -- cgit 1.2.3-korg