docs/architecture.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3
   4 ============
   5 Architecture
   6 ============
   7
   8 .. note::
   9    * This section is used to describe a software component from a high level
  10      view of capability, common usage scenarios, and interactions with other
  11      components required in the usage scenarios.
  12
  13    * The architecture section is typically: provided in a platform-component
  14      and sdk collections; and referenced from developer and user guides.
  15
  16    * This note must be removed after content has been added.
  17
  18 SDC As Part of ONAP
  19 ===================
  20
  21 .. image:: images/SDC_In_ONAP.png
  22
  23
  24 High Level Architecture
  25 =======================
  26
  27 The following diagram shows the high-level relationship between the system components:
  28
  29 .. image:: images/High_Level_Architecture_SDC.png
  30
  31 The SDC architecture uses the Jetty server as an application server.
  32
  33 - The **Jetty front end**:
  34    - supplies the static content of web pages, and all resources that required by the GUI
  35    - serves as a proxy for the REST API requests coming from the GUI
  36
  37   Every request originating from the GUI is passed to the Jetty front-end server before it is executed.
  38
  39 - The **Jetty back end** containes all the logic for the SDC.
  40
  41 SDC uses two storage components: Elastic Search(ES) and Cassandra
  42
  43 - **Elastic Search** is used to index the auditing data received from different operations in the SDC.
  44
  45   This information can then be analyzed with Kibana. The **Kibana server** enables statistical analysis of the operations done, according to the business logic.
  46
  47 - **Cassandra** is used to store auditing data, artifacts and data model objects.
  48
  49
  50 Capabilities
  51 ============
  52
  53
  54 Usage Scenarios
  55 ===============
  56
  57
  58 Interactions
  59 ============