summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorJulienBe <julien.bertozzi@intl.att.com>2020-06-11 12:06:09 +0200
committerOfir Sonsino <ofir.sonsino@intl.att.com>2020-06-16 06:48:52 +0000
commit14cee3ef2e286a9031a8fa35619f1a5d60616556 (patch)
tree364abc84936f46c1fb53e7de42b54a2491559e65 /docs
parent8b53d639026267aef71659fe292a75e47555265f (diff)
add information on the containers based on what is available in the wiki
Issue-ID: SDC-2449 Change-Id: I740a14623161e051399f03d1788ae8a2605c1076 Signed-off-by: JulienBe <julien.bertozzi@intl.att.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/delivery.rst82
1 files changed, 80 insertions, 2 deletions
diff --git a/docs/delivery.rst b/docs/delivery.rst
index 8f9a197790..21c860c0a0 100644
--- a/docs/delivery.rst
+++ b/docs/delivery.rst
@@ -4,9 +4,87 @@
========
Delivery
========
+
-SDC Dockers Containers Structure
-================================
+SDC Dockers Containers
+======================
+
+Overview
+--------
+
++---------------------+----------------------------------------------------------------------------+------------------------------------------------+
+| Name | Content of the container | On Startup |
++---------------------+----------------------------------------------------------------------------+------------------------------------------------+
+| sdc-cs-init | Logic for creating the **schemas for SDC catalog** server | Create the **schemas** |
++---------------------+----------------------------------------------------------------------------+------------------------------------------------+
+| sdc-cs-onboard init | Logic for creating the **schemas for SDC onboarding** server | Create the **schemas** |
++---------------------+----------------------------------------------------------------------------+------------------------------------------------+
+| sdc-cs | **Cassandra** server | Starts **Cassandra** |
++---------------------+----------------------------------------------------------------------------+------------------------------------------------+
+| sdc-onboard-BE | Onboarding **Backend** Jetty server | Starts Jetty with the application. |
++---------------------+----------------------------------------------------------------------------+------------------------------------------------+
+| sdc-BE | **Backend** Jetty server | Starts Jetty with the application. |
++---------------------+----------------------------------------------------------------------------+------------------------------------------------+
+| sdc-BE-init | Logic for importing the SDC **Tosca normative types** | Executes the rest calls for the catalog server |
+| | Logic for configuring **external users** for SDC external api's | |
++---------------------+----------------------------------------------------------------------------+------------------------------------------------+
+| sdc-FE | SDC **Frontend** Jetty server | Starts Jetty with our application. |
++---------------------+----------------------------------------------------------------------------+------------------------------------------------+
+
+
+Deployement dependency map
+--------------------------
+
+.. blockdiag::
+
+ orientation = portrait
+ class job [color = "#FFA300", style = dotted, shape = "box"]
+ class app [color = "#29ADFF", shape = "roundedbox"]
+ fe [label = "sdc-frontend", class = "app"];
+ be [label = "sdc-backend", class = "app"];
+ onboarding-be [label = "sdc-onboarding-backend", class = "app"];
+ cassandra [label = "sdc-cassandra", class = "app"];
+ be-config [label = "sdc-backend-config", class = "job"];
+ cassandra-config [label = "sdc-cassandra-config", class = "job"];
+ onboarding-init [label = "sdc-onboarding-init", class = "job"];
+ job [class = "job"];
+ app [class = "app"];
+
+ fe -> be-config -> be -> onboarding-be -> onboarding-init -> cassandra-config -> cassandra;
+
+Connectivity Matrix
+-------------------
+
++---------------------+--------------------------------------------------------------+-------------+---------------------+-----------+
+| Name | API purpose | protocol | port number / range | TCP / UDP |
++---------------------+--------------------------------------------------------------+-------------+---------------------+-----------+
+| sdc-cassandra | SDC backend uses the two protocols to access Cassandra | trift/async | 9042 / 9160 | TCP |
++---------------------+--------------------------------------------------------------+-------------+---------------------+-----------+
+| sdc-onboard-backend | Access the onboarding functionality | http(s) | 8081 / 8445 | TCP |
++---------------------+--------------------------------------------------------------+-------------+---------------------+-----------+
+| sdc-backend | Access the catalog functionality | http(s) | 8080 / 8443 | TCP |
++---------------------+--------------------------------------------------------------+-------------+---------------------+-----------+
+| sdc-frontend | Access SDC UI and proxy requests to SDC backend | http(s) | 8181 / 9443 | TCP |
++---------------------+--------------------------------------------------------------+-------------+---------------------+-----------+
+
+Offered APIs
+------------
+
++---------------------+-------------------+-----------------------------------------------------------------------------------------+----------+-------------+-----------+
+| container / vm name | address | API purpose | protocol | port number | TCP / UDP |
++---------------------+-------------------+-----------------------------------------------------------------------------------------+----------+-------------+-----------+
+| sdc-fe | /sdc1/feproxy/* | Proxy for all REST calls from SDC UI | HTTP(S) | 8181 / 8443 | TCP |
++---------------------+-------------------+-----------------------------------------------------------------------------------------+----------+-------------+-----------+
+| sdc-be | /sdc2/* | Internal APIs used by the UI. Request is passed through front end proxy | HTTP(S) | 8080 / 8443 | TCP |
++---------------------+-------------------+-----------------------------------------------------------------------------------------+----------+-------------+-----------+
+| | /sdc/* | External APIs offered to the different components for retrieving info from SDC catalog. | HTTP(S) | 8080 / 8443 | TCP |
++---------------------+-------------------+-----------------------------------------------------------------------------------------+----------+-------------+-----------+
+| sdc-onboarding-be | /onboarding/api/* | Internal APIs used by the UI | HTTP(S) | 8080 / 8443 | TCP |
++---------------------+-------------------+-----------------------------------------------------------------------------------------+----------+-------------+-----------+
+
+
+Structure
+---------
Below is a diagram of the SDC project docker containers and the connections between them.