diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/administration.rst | 10 | ||||
| -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/index.rst | 1 | ||||
| -rw-r--r-- | docs/installation.rst | 14 | ||||
| -rw-r--r-- | docs/offeredapis.rst | 4 | ||||
| -rw-r--r-- | docs/sdcsdks.rst | 41 |
9 files changed, 111 insertions, 7 deletions
diff --git a/docs/administration.rst b/docs/administration.rst index 94a7407189..91cfa3dd68 100644 --- a/docs/administration.rst +++ b/docs/administration.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 +============== Administration ============== @@ -16,6 +17,15 @@ Administration * This note must be removed after content has been added. +Administration Links +==================== + +Here are some links to our administration pages found in the ONAP Services websites + +- `SDC Jira <https://jira.onap.org/projects/SDC/issues/>`_ +- `SDC Jenkins <https://jenkins.onap.org/view/sdc/>`_ +- `SDC Confluence Portal <https://wiki.onap.org/display/DW/Service+Design+and+Creation+%28SDC%29+Portal+WORK+IN+PROGRESS>`_ + Processes --------- 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/index.rst b/docs/index.rst index cc71b4572b..193734d26d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -16,3 +16,4 @@ SDC Documentation installation.rst logging.rst release-notes.rst + sdcsdks.rst
\ No newline at end of file diff --git a/docs/installation.rst b/docs/installation.rst index be64a63bb9..0eeb60404e 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. +Installation 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 ------ +===== diff --git a/docs/offeredapis.rst b/docs/offeredapis.rst index e9decd1e5c..268ffa0688 100644 --- a/docs/offeredapis.rst +++ b/docs/offeredapis.rst @@ -2,13 +2,13 @@ .. http://creativecommons.org/licenses/by/4.0 ============= -Offered API’s +Offered APIs ============= :Date: 2017-10-23 .. contents:: - :depth: 4 + :depth: 3 .. Overview diff --git a/docs/sdcsdks.rst b/docs/sdcsdks.rst new file mode 100644 index 0000000000..4cb40e83b7 --- /dev/null +++ b/docs/sdcsdks.rst @@ -0,0 +1,41 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +======== +SDC SDKs +======== + + +SDC SDKs List +============= + +The sdc projects consists of a few additional sub projects listed below: + +- sdc-tosca +- sdc-jtosca +- sdc-distribution-client +- sdc-titan-cassandra + +SDC SDKs guide +============== + +SDC-TOSCA and SDC-DISTRIBUTION-CLIENT +------------------------------------- +| This is a link to a document describing the usage for the sdc-tosca, sdc-jtosca and sdc-distribution-client projects: `SDC Sub Projects <https://wiki.onap.org/display/DW/SDC+Distribution+client+AID?preview=/11929307/11929304/SDC_Distribution_AID_1710_030717.docx>`_ +| +| The link describes the use of distribution client and the sdc-tosca. +| jtosca is used by sdc-tosca as a dependency and is not used separately + +SDC-TITAN-CASSANDRA +------------------- + +| This is a link to the github page of titan project for extra reading regarding Titan DB: `<https://github.com/thinkaurelius/titan>`_ +| +| SDC forked part of the project to overide the default Titan configuration for Cassandra. +| The change allows the use of Titan as an active pasive deployment for geo redudndency. +| +| Titan by default uses QUORUM in Cassandra on write and read operations. +| Using our change allows the use of local QUORUM to read and write only to a spacific data center. +| Since the project is in end of life state the change cannot be merged back to the project. + + |
