Update Documentation
Update local SDC doc with Guilin Content
Issue-ID: SDC-3370
Signed-off-by: ChrisC <christophe.closset@intl.att.com>
Change-Id: I3d94e3dbb8c4a8e2723ec364e6d4c6e9ff03946a
diff --git a/docs/architecture.rst b/docs/architecture.rst
index 3a17ac6..bc001c8 100644
--- a/docs/architecture.rst
+++ b/docs/architecture.rst
@@ -6,27 +6,6 @@
SDC Architecture
================
-SDC As Part of ONAP
-===================
+Please refer to the Guilin Architecture review page for SDC, to get a full picture of SDC and its relationships within 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 the web pages and all the resources that are 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** contains all the logic for the SDC.
-
-- **Cassandra** is used to store audit data, artifacts and data model objects.
-
+- `SDC Guilin Architecture review <https://wiki.onap.org/pages/viewpage.action?pageId=84642290>`_
\ No newline at end of file
diff --git a/docs/configuration.rst b/docs/configuration.rst
index 4b7bea0..807839e 100644
--- a/docs/configuration.rst
+++ b/docs/configuration.rst
@@ -12,6 +12,9 @@
Global Configuration
====================
+SDC configuration is applied by several init containers running Chef recipes
+The files below describe the environment files that are applied on startup
+
environment.json
----------------
diff --git a/docs/dcaedesigner.rst b/docs/dcaedesigner.rst
index f5ae7f1..3f98587 100644
--- a/docs/dcaedesigner.rst
+++ b/docs/dcaedesigner.rst
@@ -6,7 +6,4 @@
DCAE-Designer
==============
-Here are the links to our DCAE-Designer pages found in the ONAP Services websites
-
-- `Introduction <https://wiki.onap.org/display/DW/DCAE-Design+Studio/>`_
-- `Deployment guide <https://wiki.onap.org/display/DW/DCAE-Design+Studio+deployment>`_
+DCAE Designer is deprecated and replaced by DCAE-MOD, it is no longer deployed with SDC.
diff --git a/docs/delivery.rst b/docs/delivery.rst
index 21c860c..97b7dd1 100644
--- a/docs/delivery.rst
+++ b/docs/delivery.rst
@@ -19,7 +19,8 @@
+---------------------+----------------------------------------------------------------------------+------------------------------------------------+
| sdc-cs-onboard init | Logic for creating the **schemas for SDC onboarding** server | Create the **schemas** |
+---------------------+----------------------------------------------------------------------------+------------------------------------------------+
-| sdc-cs | **Cassandra** server | Starts **Cassandra** |
+| sdc-cs | **Cassandra** server, this is optional as SDC uses shared ONAP Cassandra by| Starts **Cassandra** |
+| | default | |
+---------------------+----------------------------------------------------------------------------+------------------------------------------------+
| sdc-onboard-BE | Onboarding **Backend** Jetty server | Starts Jetty with the application. |
+---------------------+----------------------------------------------------------------------------+------------------------------------------------+
@@ -30,6 +31,13 @@
+---------------------+----------------------------------------------------------------------------+------------------------------------------------+
| sdc-FE | SDC **Frontend** Jetty server | Starts Jetty with our application. |
+---------------------+----------------------------------------------------------------------------+------------------------------------------------+
+| sdc-WFD-BE-init | Logic for configuring **Workflow Designer** | Execute configuration tasks of the WFD |
++---------------------+----------------------------------------------------------------------------+------------------------------------------------+
+| sdc-WFD-BE | SDC Workflow **Backtend** Jetty server | Starts Jetty with our application. |
++---------------------+----------------------------------------------------------------------------+------------------------------------------------+
+| sdc-WFD-FE | SDC Workflow **Frontend** Jetty server | Starts Jetty with our application. |
++---------------------+----------------------------------------------------------------------------+------------------------------------------------+
+
Deployement dependency map
@@ -51,6 +59,7 @@
app [class = "app"];
fe -> be-config -> be -> onboarding-be -> onboarding-init -> cassandra-config -> cassandra;
+ sdc-WFD-FE -> sdc-WFD-BE-init -> sdc-WFD-BE;
Connectivity Matrix
-------------------
@@ -92,20 +101,27 @@
blockdiag delivery {
- node_width = 100;
+ node_width = 140;
orientation = portrait;
sdc-cassandra[shape = flowchart.database , color = grey]
sdc-frontend [color = blue, textcolor="white"]
sdc-backend [color = yellow]
sdc-onboarding-backend [color = yellow]
+ sdc-backend [color = yellow]
+ sdc-WFD-frontend [color = brown]
+ sdc-WFD-backend [color = brown]
+ sdc-WFD-BE-init [color = brown]
sdc-cassandra-Config [color = orange]
sdc-backend-config [color = orange]
sdc-onboarding-init [color = orange]
+ sdc-WFD-BE-init -> sdc-WFD-backend;
sdc-onboarding-init -> sdc-onboarding-backend;
sdc-cassandra-Config -> sdc-cassandra;
sdc-backend-config -> sdc-backend;
sdc-wss-simulator -> sdc-frontend;
+ sdc-WFD-frontend -> SDC-WFD-backend;
sdc-frontend -> sdc-backend, sdc-onboarding-backend;
+ SDC-WFD-backend -> sdc-cassandra;
sdc-backend -> sdc-cassandra;
sdc-onboarding-backend -> sdc-cassandra;
sdc-sanity -> sdc-backend;
@@ -113,7 +129,7 @@
group deploy_group {
color = green;
label = "Application Layer"
- sdc-backend; sdc-onboarding-backend; sdc-frontend; sdc-cassandra; sdc-cassandra-Config; sdc-backend-config; sdc-onboarding-init;
+ sdc-backend; sdc-onboarding-backend; sdc-frontend; sdc-cassandra; sdc-cassandra-Config; sdc-backend-config; sdc-onboarding-init; sdc-WFD-frontend; sdc-WFD-backend; sdc-WFD-BE-init;
}
group testing_group {
color = purple;
diff --git a/docs/humaninterfaces.rst b/docs/humaninterfaces.rst
index 86c41a8..9af6385 100644
--- a/docs/humaninterfaces.rst
+++ b/docs/humaninterfaces.rst
@@ -11,8 +11,5 @@
These are links to the SDC user guides found in ONAP User Guides:
* :ref:`sdc_onboarding_package_types`
-* :ref:`doc_guide_user_des_res-onb`
-* :ref:`doc_guide_user_des_vf-cre`
-* :ref:`doc_guide_user_des_ser-des`
-* :ref:`doc_guide_user_des_ser-dis`
+* :ref:`doc_guide_user_des`
diff --git a/docs/installation.rst b/docs/installation.rst
index bfd9191..bb25995 100644
--- a/docs/installation.rst
+++ b/docs/installation.rst
@@ -7,18 +7,14 @@
Installation Guides
===================
-In Beijing SDC supports two deployment method Heat based deployment and OOM based deployment.
+In Guilin SDC is deployed through OOM based deployment.
more information is available in the OOM and in the demo projects.
-For local deployment SDC offers two options:
-
-- `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/display/DW/Deploying+SDC+on+a+Linux+VM+for+Development>`_
+For local deployment SDC offers specific Maven Profiles (START-SDC and STOP-SDC)
Collection of commands used in deploying and monitoring sdc in OOM
- `SDC on OOM <https://wiki.onap.org/display/DW/SDC+on+OOM>`_
-
SDC troubleshooting:
- `troubleshooting guide and logging info <https://wiki.onap.org/display/DW/SDC+Troubleshooting>`_
diff --git a/docs/onboardingpackages.rst b/docs/onboardingpackages.rst
index ee668a3..bdca18b 100644
--- a/docs/onboardingpackages.rst
+++ b/docs/onboardingpackages.rst
@@ -14,6 +14,11 @@
- Heat Package
- ONAP Tosca CSAR Package
- ETSI SOL004 Tosca CSAR Package
+- Basic Helm package support for CNF
+
+For an extensive guide on how to perform onboarding, please refer to the ONAP User guide:
+* :ref:`doc_guide_user_des`
+
Heat Package
^^^^^^^^^^^^
@@ -50,6 +55,12 @@
- The original input CSAR is maintained and stored as the SDC artifact *ETSI_PACKAGE* in the xNF internal model. For existing legacy xNF, it can be stored as *ONBOARDED_PACKAGE* instead.
- The non-mano artifacts are mapped to the corresponding SDC Artifact Type in the xNF internal model.
+Basic Helm package support for CNF
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The helm package support is new since Guilin release, helm chart packaged as tgz file can be onboarded and distributed.
+The support is limited for this first release.
+
Package Types applicable to Resource Types
------------------------------------------
VF
@@ -88,7 +99,11 @@
SDC onboarding processes each of the package types differently. SDC determines which package type is being onboarded, and
hence which logic to use, based on the following
-First SDC checks the extension of the package. If the package extension is *.zip* then the package is treated as a `Heat package`_.
+First SDC checks the extension of the package. If the package extension is *.zip* then the package is treated as a `Heat package`_ or `Basic Helm package support for CNF`_.
+
+To determine whether the package is of type Helm, SDC looks into the package content and tries to find Helm base files if not found it will treat it as Heat.
+
+If it determines that this is a Helm package, SDC will add dummy Heat descriptor files.
If the package extension is *.csar* and the following is true
diff --git a/docs/release-notes.rst b/docs/release-notes.rst
index 3a19edc..cc02384 100644
--- a/docs/release-notes.rst
+++ b/docs/release-notes.rst
@@ -5,7 +5,7 @@
Release Notes
=============
-Version: 1.7.2
+Version: 1.7.3
==============
:Release Date: 2020-11-19
@@ -91,7 +91,7 @@
**Tasks**
-The full list of implemented tasks is available on `JIRA GUILIN BUGS <https://jira.onap.org/issues/?jql=project%20%3D%20SDC%20AND%20issuetype%20%3D%20Task%20AND%20fixVersion%20%3D%20%22Guilin%20Release%22>`_
+The full list of implemented tasks is available on `JIRA GUILIN TASKS <https://jira.onap.org/issues/?jql=project%20%3D%20SDC%20AND%20issuetype%20%3D%20Task%20AND%20fixVersion%20%3D%20%22Guilin%20Release%22>`_
**Bug Fixes**