diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/architecture.rst | 38 | ||||
| -rw-r--r-- | docs/humaninterfaces.rst | 10 | ||||
| -rw-r--r-- | docs/images/High_Level_Architecture_SDC.png | bin | 0 -> 30120 bytes | |||
| -rw-r--r-- | docs/images/SDC_In_ONAP.png | bin | 0 -> 66297 bytes | |||
| -rw-r--r-- | docs/installation.rst | 14 |
5 files changed, 57 insertions, 5 deletions
diff --git a/docs/architecture.rst b/docs/architecture.rst index 8daa0d3bc5..232bbf0bd4 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/humaninterfaces.rst b/docs/humaninterfaces.rst index 4292846085..44641e20f8 100644 --- a/docs/humaninterfaces.rst +++ b/docs/humaninterfaces.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 +================ Human Interfaces ================ @@ -13,5 +14,14 @@ Human Interfaces * This note must be removed after content has been added. +User Guides In ONAP Confluence +============================== + +Those are links to the SDC user guides found in ONAP Confluence: + +- `Resource Onboarding <https://wiki.onap.org/display/DW/Resource+Onboarding>`_ +- `Service Design <https://wiki.onap.org/display/DW/Service+Design>`_ +- `VF Creation and Testing <https://wiki.onap.org/display/DW/VF+Creation+and+Testing>`_ +- `Governance Approval and Service Distribution <https://wiki.onap.org/display/DW/Governance+Approval+and+Service+Distribution>`_ diff --git a/docs/images/High_Level_Architecture_SDC.png b/docs/images/High_Level_Architecture_SDC.png Binary files differnew file mode 100644 index 0000000000..57a564b8d0 --- /dev/null +++ b/docs/images/High_Level_Architecture_SDC.png diff --git a/docs/images/SDC_In_ONAP.png b/docs/images/SDC_In_ONAP.png Binary files differnew file mode 100644 index 0000000000..ddca06490d --- /dev/null +++ b/docs/images/SDC_In_ONAP.png diff --git a/docs/installation.rst b/docs/installation.rst index be64a63bb9..ab5d0469be 100644 --- a/docs/installation.rst +++ b/docs/installation.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 +============ Installation ============ @@ -12,9 +13,18 @@ Installation * This note must be removed after content has been added. +Instalation Guides +================== + +Those are links to the SDC installation guides found in ONAP Confluence: + +- `Deploying SDC on a Linux VM for Development <https://wiki.onap.org/display/DW/Deploying+SDC+on+a+Linux+VM+for+Development>`_ +- `Using Vagrant-Onap for local deployment of SDC project <https://wiki.onap.org/pages/viewpage.action?pageId=15999821>`_ + + Environment ------------ +=========== Steps ------ +===== |
