aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/api/offered_consumed_apis.rst1
-rw-r--r--docs/architecture/architecture.rst9
-rw-r--r--docs/images/so-architecture.pngbin0 -> 104101 bytes
-rw-r--r--docs/index.rst31
-rw-r--r--docs/release-notes.rst3
5 files changed, 25 insertions, 19 deletions
diff --git a/docs/api/offered_consumed_apis.rst b/docs/api/offered_consumed_apis.rst
index 1d0a8f005b..0b0ba81b4d 100644
--- a/docs/api/offered_consumed_apis.rst
+++ b/docs/api/offered_consumed_apis.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
.. Copyright 2018 Huawei Technologies Co., Ltd.
+.. _offeredapis:
SO Offered and Consumed APIs
============================
diff --git a/docs/architecture/architecture.rst b/docs/architecture/architecture.rst
index 72b108a271..d59429a366 100644
--- a/docs/architecture/architecture.rst
+++ b/docs/architecture/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
.. Copyright 2018 Huawei Technologies Co., Ltd.
+.. _architecture:
SO - Architecture
=================
@@ -15,6 +16,8 @@ SO Deployment View
.. image:: ../images/SO_Architecture_Internal.png
+.. image:: ../images/so-architecture.png
+
SO Sub-Components
------------------
@@ -25,7 +28,7 @@ SO Sub-Components
* Handle service-level and infrastructure (VNF & network) requests
Service-agnostic APIs
- * “Service Instantiation API”
+ * "Service Instantiation API"
Model-driven recipe selection
* Use SO Catalog to map input requests to BPMN flows
@@ -43,7 +46,7 @@ SO Sub-Components
Expose RESTful interface to API-H (unique path per recipe)
- Make use of common “building block” sub-flows
+ Make use of common "building block" sub-flows
Sequence orchestration steps for each Resource in the recipe
* Request and configure network resources via SDN-C
@@ -120,4 +123,4 @@ Third Party and Open Source
**Other Open Source Components of Note:**
Tomcat
MySQL/MariaDB
- Openstack Java SDK (“woorea”)
+ Openstack Java SDK ("woorea")
diff --git a/docs/images/so-architecture.png b/docs/images/so-architecture.png
new file mode 100644
index 0000000000..3904c46cf3
--- /dev/null
+++ b/docs/images/so-architecture.png
Binary files differ
diff --git a/docs/index.rst b/docs/index.rst
index cae4ff02dc..fbf83063a1 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,15 +1,16 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-.. Copyright 2018 Huawei Technologies Co., Ltd.
-
-ONAP SO
-========================================
-
-.. toctree::
- :maxdepth: 1
-
- installconfigure/Install_Configure_SO.rst
- architecture/architecture.rst
- api/offered_consumed_apis.rst
- developer_info/developer_information.rst
- release-notes.rst
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright 2018 Huawei Technologies Co., Ltd.
+.. _master_index:
+
+ONAP SO
+========================================
+
+.. toctree::
+ :maxdepth: 1
+
+ installconfigure/Install_Configure_SO.rst
+ architecture/architecture.rst
+ api/offered_consumed_apis.rst
+ developer_info/developer_information.rst
+ release-notes.rst
diff --git a/docs/release-notes.rst b/docs/release-notes.rst
index 4ad5f5876f..d052eb72fe 100644
--- a/docs/release-notes.rst
+++ b/docs/release-notes.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
.. Copyright 2018 Huawei Intellectual Property. All rights reserved.
+.. _release_notes:
Service Orchestrator Release Notes
@@ -369,7 +370,7 @@ The main goal of the Dublin release was to:
- [`SO-1206 <https://jira.onap.org/browse/SO-1206>`__\ ] - Added groupInstanceId and groupInstanceName columns
- [`SO-1205 <https://jira.onap.org/browse/SO-1205>`__\ ] - separate error status from progression status in req db
- [`SO-806 <https://jira.onap.org/browse/SO-806>`__\ ] - SO PNF PnP workflow shall not set "in-maint" AAI flag
-- [`SO-798 <https://jira.onap.org/browse/SO-798>`__\ ] - Externalize the PNF PnP workflow 鈥?as a Service Instance Deployment workflow 鈥?adding the Controller
+- [`SO-798 <https://jira.onap.org/browse/SO-798>`__\ ] - Externalize the PNF PnP workflow? as a Service Instance Deployment workflow? adding the Controller
- [`SO-747 <https://jira.onap.org/browse/SO-747>`__\ ] - POC - Enable SO use of Multicloud Generic VNF Instantiation API
- [`SO-700 <https://jira.onap.org/browse/SO-700>`__\ ] - SO should be able to support CCVPN service assurance
- [`SO-588 <https://jira.onap.org/browse/SO-588>`__\ ] - Automate robot heatbridge manual step to add VF Module stack resources in AAI