From: Idan Amit Date: Thu, 2 Nov 2017 11:42:29 +0000 (+0200) Subject: Architecture section in Read the Docs X-Git-Tag: 1.0.0-Amsterdam~32 X-Git-Url: https://gerrit.onap.org/r/gitweb?a=commitdiff_plain;h=276eb333e65582d5bb6176744b94bef23a2690db;p=sdc.git Architecture section in Read the Docs Added first draft for architecture section Change-Id: I29679a6625758258bae5c77a8b31a4b1ad418f45 Issue-Id: SDC-508 Signed-off-by: Idan Amit --- diff --git a/docs/architecture.rst b/docs/architecture.rst index 8daa0d3bc5..4e20a3e1d0 100644 --- a/docs/architecture.rst +++ b/docs/architecture.rst @@ -1,6 +1,7 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 +============ Architecture ============ @@ -14,14 +15,45 @@ Architecture * This note must be removed after content has been added. +SDC As Part of ONAP +=================== + +.. image:: images/SDC_In_ONAP.png + + +High Level Architecture +======================= + +The following diagram shows the high-level relationship between the system components: + +.. image:: images/High_Level_Architecture_SDC.png + +The SDC architecture uses the Jetty server as an application server. + +- The *Jetty front end*: + - supplies the static content of web pages, and all resources that required by the GUI + - serves as a proxy for the REST API requests coming from the GUI + + Every request originating from the GUI is passed to the Jetty front-end server before it is executed. + +- The *Jetty back end* containes all the logic for the SDC. + +SDC uses two storage components: Elastic Search(ES) and Cassandra + +- *Elastic Search* is used to index the auditing data received from different operations in the SDC. + + This information can then be analyzed with Kibana. The *Kibana server* enables statistical analysis of the operations done, according to the business logic. + +- *Cassandra* is used to store auditing data, artifacts and data model objects. + Capabilities ------------- +============ Usage Scenarios ---------------- +=============== Interactions ------------- +============ diff --git a/docs/images/High_Level_Architecture_SDC.png b/docs/images/High_Level_Architecture_SDC.png new file mode 100644 index 0000000000..57a564b8d0 Binary files /dev/null and b/docs/images/High_Level_Architecture_SDC.png differ diff --git a/docs/images/SDC_In_ONAP.png b/docs/images/SDC_In_ONAP.png new file mode 100644 index 0000000000..ddca06490d Binary files /dev/null and b/docs/images/SDC_In_ONAP.png differ