aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorLukasz Rajewski <lukasz.rajewski@t-mobile.pl>2023-03-28 16:03:10 +0000
committerLukasz Rajewski <lukasz.rajewski@t-mobile.pl>2023-03-28 16:03:10 +0000
commitee57f20a6c25725d965259f05d7fa86ca6ac7ef8 (patch)
tree7314a905e13713b7f7b73b0de6e34b827fdec180 /docs
parentd0493f954a48021662b5b6d3ba45b262750690c9 (diff)
Fix docs issues
Issue-ID: DOC-811 Signed-off-by: Lukasz Rajewski <lukasz.rajewski@t-mobile.pl> Change-Id: Ied42ffc4035e51fe1382bd64da44107dfca4cde6
Diffstat (limited to 'docs')
-rw-r--r--docs/api/offered_consumed_apis.rst1
-rw-r--r--docs/bak/Developer_Info.rst14
-rw-r--r--docs/bak/installation.rst112
-rw-r--r--docs/conf.py6
-rw-r--r--docs/developer_info/BBUnderstanding.rst2
-rw-r--r--docs/developer_info/BPMN-INFRA_Workflow_Understanding.rst11
-rw-r--r--docs/developer_info/BPMN_Subprocess_Process_Flows.rst2
-rw-r--r--docs/developer_info/CSIT_Macroflow_developer_info.rst7
-rw-r--r--docs/developer_info/Camunda_Modeler.rst4
-rw-r--r--docs/developer_info/SO_Admin_Cockpit_User_Guide.rst2
-rw-r--r--docs/developer_info/Working_with_so_monitoring.rst9
-rw-r--r--docs/developer_info/developer_information.rst6
-rw-r--r--docs/developer_info/instantiate/instantiation/nbi/index.rst8
-rw-r--r--docs/developer_info/instantiate/instantiation/so2/index.rst8
-rw-r--r--docs/developer_info/instantiate/instantiation/uui/index.rst7
-rw-r--r--docs/developer_info/instantiate/instantiation/vid/index.rst6
-rw-r--r--docs/release-notes.rst651
-rw-r--r--docs/tox.ini8
18 files changed, 290 insertions, 574 deletions
diff --git a/docs/api/offered_consumed_apis.rst b/docs/api/offered_consumed_apis.rst
index 0b0ba81b4d..11e52e82ae 100644
--- a/docs/api/offered_consumed_apis.rst
+++ b/docs/api/offered_consumed_apis.rst
@@ -44,4 +44,5 @@ Detailed documentation can be found here:
apis/serviceInstances-api.rst
apis/e2eServiceInstances-api.rst
+ apis/onap3gppServiceInstances-api.rst
apis/consumed-apis.rst
diff --git a/docs/bak/Developer_Info.rst b/docs/bak/Developer_Info.rst
deleted file mode 100644
index 9d9c46c4c2..0000000000
--- a/docs/bak/Developer_Info.rst
+++ /dev/null
@@ -1,14 +0,0 @@
-\installconfigure.. 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.
-
-Developer Information
-======================
-
-.. toctree::
- :maxdepth: 1
-
- ../installconfigure/Install_Configure_SO.rst
- ../architecture/architecture.rst
-
- \ No newline at end of file
diff --git a/docs/bak/installation.rst b/docs/bak/installation.rst
deleted file mode 100644
index cde26e021a..0000000000
--- a/docs/bak/installation.rst
+++ /dev/null
@@ -1,112 +0,0 @@
-.. _onap_so_schema_version_2_0:
-.. 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.
-
-Install and Configure Service Orchestrator
-==========================================
-
-Get Ubuntu
-----------
-Get the Ubuntu ISO image from ubuntu.com. The recommended version is 16.04.3 LTS (Long Term Support), desktop edition.
-
-Get VirtualBox and VirtualBox Guest Additions
----------------------------------------------
-Make sure you have the VirtualBox Guest Additions ISO for your version of
-VirtualBox. I'm using VirtualBox 5.1.28. Save the Guest Additions ISO on your
-host computer along with the Ubuntu ISO. Get the Guest Additions ISO from
-here: http://download.virtualbox.org/virtualbox
-
-*NOTE*: Guest Additions versions prior to 5.1 will not work with Ubuntu 16.04.3. If you have an earlier version of VirtualBox, you should upgrade to the latest 5.1 version.
-
-Create a new VM in VirtualBox for Ubuntu
-----------------------------------------
-Type: Linux
-Version: Ubuntu (64-bit)
-At least 2048 MB memory
-At least 40 GB VDI
-Network: Attached to: NAT
-
-Create a port-forwarding rule for SSH
--------------------------------------
-Create a port-forwarding rule so that you can use PuTTY (or other SSH client) to connect to the VM.
-Go to "Network" settings in VirtualBox, add a port forwarding rule:
-Name: SSH
-Protocol: TCP
-Host IP: 127.0.0.1
-Host Port: 1022
-Guest IP: <leave blank>
-Guest Port: 22
-
-Create Shared Folder
---------------------
-This is oriented to Windows users. If you're using a MAC or a Linux host computer, the details may be different. You can share any folder on the host computer with the Ubuntu VM. On Windows, a practical choice is to share the C:\Users folder, so that your Windows home directory will be accessible from the Ubuntu VM.
-Go to "Shared Folders" settings in VirtualBox, add a share:
-Folder Path: C:\Users
-Folder Name: Users
-Auto-mount: <checked>
-Read-only: <unchecked>
-
-Install Ubuntu in the VM
-------------------------
-On the "Storage" panel in VirtualBox, click on "[ optical drive ]" and then "Choose Disk Image". Select your Ubuntu ISO image.
-
-After selecting the ISO image, start the VM.
-Follow the prompts to install Ubuntu.
-
-Proxy Configuration (optional)
-------------------------------
-If you're behind a corporate firewall, configure some proxy settings. NOTE: your proxy configuration may require username and password credentials, not shown here.
-**Ubuntu system proxy setting**:
-
-- System Settings → Network → Network proxy
- (Replace "proxyhost" and port with your actual proxy information)
-
-**apt proxy setting**:
-
-- Edit /etc/apt/apt.conf and add one line at the top (replace "proxyhost:port" with your actual proxy information):
- Acquire::http::Proxy "http://proxyhost:port";
-- Reboot the VM.
-
-Install SSH Server
-------------------
-sudo apt update
-sudo apt install openssh-server
-
-Connect to the VM from your host computer
------------------------------------------
-The PuTTY SSH client is popular. A connection to localhost:1022 (or whatever port you have forwarded) will go to the VM.
-
-Install VirtualBox Guest Additions
-----------------------------------
-On the "Storage" panel in VirtualBox, click on "[ optical drive ]" and then "Choose Disk Image". Select your VirtualBox Guest Additions ISO image.
-
-In a VM terminal window, mount the cdrom::
-
- sudo mkdir -p /media/cdrom
- sudo mount /dev/cdrom /media/cdrom
-
-Install necessary dependencies::
-
- sudo apt update
- sudo apt install gcc g++ dkms
-
-Install the guest additions. NOTE: look for errors in the command output!
-If you see an error that says you are missing kernel headers, the most likely
-cause is that you are using a VirtualBox version that is too old.
-The error message is misleading.::
-
- cd /media/cdrom
- sudo ./VBoxLinuxAdditions.run
-
-Add yourself to the vboxsf user group (replace "userid" with your user ID)::
-
- sudo usermod -a -G vboxsf userid
-
-Reboot the VM.
-In a VM terminal window, verify that you can access your home directory on the
-host computer, which should be mounted under /media/sf_Users
-
-Further Reading
-----------------------------------------
-https://wiki.onap.org/display/DW/Development+Environment
diff --git a/docs/conf.py b/docs/conf.py
index 70937d745f..62a012aa0a 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -2,6 +2,8 @@ project = "onap"
release = "master"
version = "master"
+doc_url = 'https://docs.onap.org/projects'
+
author = "Open Network Automation Platform"
# yamllint disable-line rule:line-length
copyright = "ONAP. Licensed under Creative Commons Attribution 4.0 International License"
@@ -33,6 +35,8 @@ extensions = [
branch = 'latest'
intersphinx_mapping = {}
+intersphinx_mapping['onap-usecase-ui'] = ('{}/onap-usecase-ui/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-vid'] = ('{}/onap-vid/en/%s'.format(doc_url) % branch, None)
doc_url = 'https://docs.onap.org/projects'
master_doc = 'index'
@@ -53,4 +57,4 @@ def setup(app):
linkcheck_ignore = [
r'http://localhost:\d+/'
-] \ No newline at end of file
+]
diff --git a/docs/developer_info/BBUnderstanding.rst b/docs/developer_info/BBUnderstanding.rst
index a4984d3b03..99f2cd92b7 100644
--- a/docs/developer_info/BBUnderstanding.rst
+++ b/docs/developer_info/BBUnderstanding.rst
@@ -669,7 +669,7 @@ will directly return abort without querying policy in table
**rainy_day_handler_macro**
-.. code-block:: bash
+.. code-block::
curl --location --request POST 'http://master2:30277/onap/so/infra/serviceInstantiation/v7/serviceInstances' \
--header 'Accept: application/json' \
diff --git a/docs/developer_info/BPMN-INFRA_Workflow_Understanding.rst b/docs/developer_info/BPMN-INFRA_Workflow_Understanding.rst
index 3af3dc8dc9..4f83c9b885 100644
--- a/docs/developer_info/BPMN-INFRA_Workflow_Understanding.rst
+++ b/docs/developer_info/BPMN-INFRA_Workflow_Understanding.rst
@@ -603,12 +603,13 @@ Response: Response is returned with an empty entity
b. Response Body:
- {
- "service":
- {
- "serviceId":"8a95e3ac-32cd-4ffb-b9e3-5366b393a7a2",
- "operationId":"a970a804-7ac5-4de9-b6db-17352afbc6fa"
+.. code-block:: json
+ {
+ "service": {
+ "serviceId":"8a95e3ac-32cd-4ffb-b9e3-5366b393a7a2",
+ "operationId":"a970a804-7ac5-4de9-b6db-17352afbc6fa"
+ }
}
9. CreateCommunicationService--> generateE2EServiceProfile()
diff --git a/docs/developer_info/BPMN_Subprocess_Process_Flows.rst b/docs/developer_info/BPMN_Subprocess_Process_Flows.rst
index 098f38ff02..a0de34e9a6 100644
--- a/docs/developer_info/BPMN_Subprocess_Process_Flows.rst
+++ b/docs/developer_info/BPMN_Subprocess_Process_Flows.rst
@@ -29,4 +29,4 @@ Characteristics
Example: VnfAdapterRestV1.bpmn
-------------------------------
-.. image:: images/BPMN_Subprocess_process_flows_1.png
+.. image:: ../images/BPMN_Subprocess_process_flows_1.png
diff --git a/docs/developer_info/CSIT_Macroflow_developer_info.rst b/docs/developer_info/CSIT_Macroflow_developer_info.rst
index d8c52a4a71..fe5a8f2707 100644
--- a/docs/developer_info/CSIT_Macroflow_developer_info.rst
+++ b/docs/developer_info/CSIT_Macroflow_developer_info.rst
@@ -15,7 +15,7 @@ Ensure you have a healthy ONAP Deployment running. The following components will
- MultiCloud
What is Macroflow?
------------------
+------------------
The SO building blocks are a set of database-driven, configurable and generic process steps to be leveraged through several actions defined as 'Macro' flows. For each of the macro flows, there are a set of actions to be performed which are implemented as building blocks - which then implement generic logic to handle the orchestration of services and various type of resources orchestrated by ONAP, as well as their corresponding actions.
@@ -37,6 +37,7 @@ First pull the CSIT repo from Gerrit, either with or without the hooks
… code-block::
git clone "https://gerrit.onap.org/r/integration/csit"
+
or
.. code-block::
@@ -79,7 +80,7 @@ If you look at the contents of the plans/so/macroflow you will see the following
**docker-compose.yml:** This lists all the requrired docker.
How to run tests against specific SO versions
---------------------------------------------
+---------------------------------------------
It is possible to run the CSIT Macroflow suite against local docker images although it is not the default. Through this method specific versions of SO can be tested.
There are two changes required to make this work.
@@ -91,7 +92,7 @@ There are two changes required to make this work.
This should be enough to run the CSIT Macroflow test suite locally.
CSIT Macroflow Tests High Level Scenarios
----------------------------------------------------
+-----------------------------------------
**Step 1:**
diff --git a/docs/developer_info/Camunda_Modeler.rst b/docs/developer_info/Camunda_Modeler.rst
index 54f3534210..fcc530df9c 100644
--- a/docs/developer_info/Camunda_Modeler.rst
+++ b/docs/developer_info/Camunda_Modeler.rst
@@ -9,11 +9,11 @@ The Camunda_Modeler_ is the editor for BPMN 2.0 process flows. It is a standalo
.. _Camunda_Modeler: https://docs.camunda.org/manual/latest/modeler/camunda-modeler/
-.. image:: images/camunda_modeler_1.png
+.. image:: ../images/camunda_modeler_1.png
Modeler Templates
------------------
Some work has already been done in MSO to develop templates_ for "building block" subprocess flows. When a template is provided for a BPMN element, the modeler displays a custom form for inputting parameters. This significantly simplifies flow construction and reduces the chance of making mistakes.
-.. _templates: https://docs.camunda.org/manual/7.7/modeler/camunda-modeler/element-templates/ \ No newline at end of file
+.. _templates: https://docs.camunda.org/manual/7.7/modeler/camunda-modeler/element-templates/
diff --git a/docs/developer_info/SO_Admin_Cockpit_User_Guide.rst b/docs/developer_info/SO_Admin_Cockpit_User_Guide.rst
index ed729664a8..81c459f4c7 100644
--- a/docs/developer_info/SO_Admin_Cockpit_User_Guide.rst
+++ b/docs/developer_info/SO_Admin_Cockpit_User_Guide.rst
@@ -99,7 +99,7 @@ The log files for SO-Admin-Cockpit can be found within the SO-Admin-Cockpit pod.
Replacing <namespace> with your environments namespace and <soAdminCockpitPodName> with the full name of your SO-Admin-Cockpit pod. This command will give you some detailed information from the execution of the pod.
CORS (Cross-Origin Resource Sharing) Error
-----------
+------------------------------------------
Pre-Dublin SO-Monitoring Components may experience CORS issues.
diff --git a/docs/developer_info/Working_with_so_monitoring.rst b/docs/developer_info/Working_with_so_monitoring.rst
index 246c61deac..3a9b700797 100644
--- a/docs/developer_info/Working_with_so_monitoring.rst
+++ b/docs/developer_info/Working_with_so_monitoring.rst
@@ -45,7 +45,8 @@ container through configmap.
to be restarted.
.. code-block:: bash
- kubectl -n onap edit configmap dev-so-monitoring-app-configmap
+
+ kubectl -n onap edit configmap dev-so-monitoring-app-configmap
.. image:: ../images/configmap.png
@@ -53,8 +54,8 @@ Special care needs to be given to the indentation. Spring needs to be inline wit
added accordingly.
.. warning::
-Attention! The default setup of the OOM makes SO Monitoring password is being automatically generated during ONAP
-deployment and injected through k8s secret
+ Attention! The default setup of the OOM makes SO Monitoring password is being automatically generated during ONAP
+ deployment and injected through k8s secret
2. Setup, retrieve and edit default SO Monitoring password
----------------------------------------------------------
@@ -132,7 +133,7 @@ Then access the UI of SO Monitoring, by default https://<k8s-worker-ip>:30224/
.. image:: ../images/ui.png
4. Hiding the SO Monitoring service (ClusterIP)
----------------------------------------
+-----------------------------------------------
The SO Monitoring service is set to the NodePort type. It is used to expose the service at a static port.
Hence there is possibility to contact the NodePort Service, from outside cluster, by requesting <NodeIP>:<NodePort>.
diff --git a/docs/developer_info/developer_information.rst b/docs/developer_info/developer_information.rst
index 11b515248a..3f72b4bcf6 100644
--- a/docs/developer_info/developer_information.rst
+++ b/docs/developer_info/developer_information.rst
@@ -12,6 +12,7 @@ SO Developer Information
Building_SO.rst
Working_with_SO_Docker.rst
Working_with_so_monitoring.rst
+ SO_Admin_Cockpit_User_Guide.rst
Camunda_Cockpit_Community_Edition.rst
Camunda_Cockpit_Enterprise_Edition.rst
Camunda_Modeler.rst
@@ -23,7 +24,12 @@ SO Developer Information
BPMN-INFRA_Workflow_Understanding.rst
pnf_pnp_workflow_migration_to_BB/pnf_pnp_support_in_service_orchestration.rst
Docker-Config_Understanding.rst
+ mso_adapter_restinterface.rst
Mso_Openstack_Adapter.rst
Cxf_Logging.rst
instantiate/index.rst
+ E2E_Network_Slicing_Understanding.rst
+ ETSI_CSIT_NFVO_VNFM.rst
+ ETSI_NFVO_Network_Service_LCM_Setup_Guide.rst
+ ETSI_VNF_LCM_Setup_Guide.rst
FAQs.rst
diff --git a/docs/developer_info/instantiate/instantiation/nbi/index.rst b/docs/developer_info/instantiate/instantiation/nbi/index.rst
index 96bbc3a8dd..279797e147 100644
--- a/docs/developer_info/instantiate/instantiation/nbi/index.rst
+++ b/docs/developer_info/instantiate/instantiation/nbi/index.rst
@@ -10,13 +10,7 @@ Service Instantiation via ONAP NBI API (TM Forum)
ONAP NBI allow you to use a TM Forum standardized API (serviceOrder API)
-Additional info in:
-
-.. toctree::
- :maxdepth: 1
- :titlesonly:
-
- NBI Guide <../../../../../submodules/externalapi/nbi.git/docs/offeredapis/offeredapis.rst>
+Additional info NBI Guide
ONAP NBI will convert that request to ONAP SO request.
diff --git a/docs/developer_info/instantiate/instantiation/so2/index.rst b/docs/developer_info/instantiate/instantiation/so2/index.rst
index 02a5f70d3c..85e18a2a02 100644
--- a/docs/developer_info/instantiate/instantiation/so2/index.rst
+++ b/docs/developer_info/instantiate/instantiation/so2/index.rst
@@ -22,12 +22,8 @@ for an Operator to provide "SDNC preload").
Additional info in:
-.. toctree::
- :maxdepth: 1
- :titlesonly:
-
- CDS Documentation <../../../../../submodules/ccsdk/cds.git/docs/index.rst>
- CDS vDNS E2E Automation <https://wiki.onap.org/display/DW/vDNS+CDS+Dublin>
+- CDS Documentation
+- CDS vDNS E2E Automation <https://wiki.onap.org/display/DW/vDNS+CDS+Dublin>
Request Example :
diff --git a/docs/developer_info/instantiate/instantiation/uui/index.rst b/docs/developer_info/instantiate/instantiation/uui/index.rst
index fa57be2717..e1f2b5fd18 100644
--- a/docs/developer_info/instantiate/instantiation/uui/index.rst
+++ b/docs/developer_info/instantiate/instantiation/uui/index.rst
@@ -6,9 +6,4 @@
e2eServiceInstance mode via ONAP UUI Portal
===========================================
-
-.. toctree::
- :maxdepth: 1
- :titlesonly:
-
- ../../../../../submodules/usecase-ui.git/docs/platform/installation/user-guide/index.rst
+UUI documentation, see :ref:`UUI <onap-usecase-ui:uui_index>` for details.
diff --git a/docs/developer_info/instantiate/instantiation/vid/index.rst b/docs/developer_info/instantiate/instantiation/vid/index.rst
index 307ceb9819..8c7657db83 100644
--- a/docs/developer_info/instantiate/instantiation/vid/index.rst
+++ b/docs/developer_info/instantiate/instantiation/vid/index.rst
@@ -6,8 +6,4 @@
A La Carte mode Service Instantiation via ONAP VID Portal
=========================================================
-.. toctree::
- :maxdepth: 1
- :titlesonly:
-
- ../../../../../submodules/vid.git/docs/humaninterfaces.rst
+VID documentation, see :ref:`VID <onap-vid:instantiate>` for details.
diff --git a/docs/release-notes.rst b/docs/release-notes.rst
index 715870967d..ccfd4e2dfa 100644
--- a/docs/release-notes.rst
+++ b/docs/release-notes.rst
@@ -9,72 +9,42 @@ Service Orchestrator Release Notes
The SO provides the highest level of service orchestration in the ONAP architecture.
-
-=============
-Release Notes
-=============
-
Version: 1.11.0
-==============
+---------------
- :Release Date: 2022-09-08
+:Release Date: 2022-09-08
SO Release Image Versions
---------------------------
- - so-bpmn-infra
-
- :Version: 1.11.0
-
- - so-catalog-db-adapter
-
- :Version: 1.11.0
-
- - so-admin-cockpit
-
- :Version: 1.8.3
-
- - so-nssmf-adapter
+~~~~~~~~~~~~~~~~~~~~~~~~~
- :Version: 1.9.1
+ - so-bpmn-infra **1.11.0**
- - so-openstack-adapter
+ - so-catalog-db-adapter **1.11.0**
- :Version: 1.11.0
+ - so-admin-cockpit **1.8.3**
- - so-request-db-adapter
+ - so-nssmf-adapter **1.9.1**
- :Version: 1.11.0
+ - so-openstack-adapter **1.11.0**
- - so-sdc-controller
+ - so-request-db-adapter **1.11.0**
- :Version: 1.11.0
+ - so-sdc-controller **1.11.0**
- - so-sdnc-adapter
+ - so-sdnc-adapter **1.11.0**
- :Version: 1.11.0
+ - so-sol003-adapter **1.8.2**
- - so-sol003-adapter
+ - so-api-handler **1.11.0**
- :Version: 1.8.2
+ - so-etsi-nfvo-ns-lcm **1.8.2**
- - so-api-handler
+ - so-oof-adapter **1.8.3**
- :Version: 1.11.0
-
- - so-etsi-nfvo-ns-lcm
-
- :Version: 1.8.2
-
- - so-oof-adapter
-
- :Version: 1.8.3
-
- - so-cnf-adapter
-
- :Version: 1.11.0
+ - so-cnf-adapter **1.11.0**
Release Purpose
-----------------
+~~~~~~~~~~~~~~~
SO Kohn Release.
The key deliverable for this release is refactoring SO for better internal architecture.
@@ -101,7 +71,7 @@ The full list of fixed bugs is available on `JIRA Kohn BUGS
<https://jira.onap.org/browse/SO-3908?jql=project%20%3D%20%22Service%20Orchestrator%22%20%20AND%20issuetype%20%3D%20Bug%20AND%20fixVersion%20%3D%20%22Kohn%20Release%22>`_
Security Notes
---------------
+~~~~~~~~~~~~~~
*Fixed Security Issues*
@@ -112,12 +82,12 @@ Security Notes
Quick Links:
-- `SO project page <https://wiki.onap.org/display/DW/Service+Orchestrator+Project>`__
-- `Passing Badge information for SDC <https://bestpractices.coreinfrastructure.org/en/projects/1702>`__
+- `SO project page`_
+- `Passing Badge information for SO`_
**Known Issues**
-* `SO-3237 <https://jira.onap.org/browse/SO-3237>`_ - Exposed HTTP port.
+* `SO-3237`_ - Exposed HTTP port.
* `SO-3745 <https://jira.onap.org/browse/SO-3745>`_ - SO images contain 1 GPLv3 lib
**Upgrade Notes**
@@ -131,70 +101,46 @@ Quick Links:
**Other**
N/A
+
***************************************************************************************
Version: 1.10.0
-==============
+---------------
- :Release Date: 2022-04-08
+:Release Date: 2022-04-08
SO Release Image Versions
---------------------------
- - so-bpmn-infra
-
- :Version: 1.10.0
-
- - so-catalog-db-adapter
-
- :Version: 1.10.0
-
- - so-admin-cockpit
-
- :Version: 1.8.3
-
- - so-nssmf-adapter
+~~~~~~~~~~~~~~~~~~~~~~~~~
- :Version: 1.9.1
+ - so-bpmn-infra **1.10.0**
- - so-openstack-adapter
+ - so-catalog-db-adapter **1.10.0**
- :Version: 1.10.0
+ - so-admin-cockpit **1.8.3**
- - so-request-db-adapter
+ - so-nssmf-adapter **1.9.1**
- :Version: 1.10.0
+ - so-openstack-adapter **1.10.0**
- - so-sdc-controller
+ - so-request-db-adapter **1.10.0**
- :Version: 1.10.0
+ - so-sdc-controller **1.10.0**
- - so-sdnc-adapter
+ - so-sdnc-adapter **1.10.0**
- :Version: 1.10.0
+ - so-sol003-adapter **1.8.2**
- - so-sol003-adapter
+ - so-api-handler **1.10.0**
- :Version: 1.8.2
+ - so-etsi-nfvo-ns-lcm **1.8.2**
- - so-api-handler
+ - so-oof-adapter **1.8.3**
- :Version: 1.10.0
-
- - so-etsi-nfvo-ns-lcm
-
- :Version: 1.8.2
-
- - so-oof-adapter
-
- :Version: 1.8.3
-
- - so-cnf-adapter
-
- :Version: 1.10.0
+ - so-cnf-adapter **1.10.0**
Release Purpose
-----------------
+~~~~~~~~~~~~~~~
SO Jakarta Release.
The key deliverable for this release is refactoring SO for better internal architecture.
@@ -221,7 +167,7 @@ The full list of fixed bugs is available on `JIRA Jakarta BUGS
<https://jira.onap.org/browse/SO-3908?jql=project%20%3D%20%22Service%20Orchestrator%22%20%20AND%20issuetype%20%3D%20Bug%20AND%20fixVersion%20%3D%20%22jakarta%20Release%22>`_
Security Notes
---------------
+~~~~~~~~~~~~~~
*Fixed Security Issues*
@@ -232,12 +178,12 @@ Security Notes
Quick Links:
-- `SO project page <https://wiki.onap.org/display/DW/Service+Orchestrator+Project>`__
-- `Passing Badge information for SDC <https://bestpractices.coreinfrastructure.org/en/projects/1702>`__
+- `SO project page`_
+- `Passing Badge information for SO`_
**Known Issues**
-* `SO-3237 <https://jira.onap.org/browse/SO-3237>`_ - Exposed HTTP port.
+* `SO-3237`_ - Exposed HTTP port.
* `SO-3745 <https://jira.onap.org/browse/SO-3745>`_ - SO images contain 1 GPLv3 lib
**Upgrade Notes**
@@ -251,71 +197,47 @@ Quick Links:
**Other**
N/A
+
***************************************************************************************
Version: 1.9.2
-==============
+--------------
- :Release Date: 2021-10-14
+:Release Date: 2021-10-14
SO Release Image Versions
---------------------------
- - so-bpmn-infra
-
- :Version: 1.9.2
-
- - so-catalog-db-adapter
-
- :Version: 1.9.2
-
- - so-admin-cockpit
-
- :Version: 1.8.3
-
- - so-nssmf-adapter
-
- :Version: 1.9.1
-
- - so-openstack-adapter
-
- :Version: 1.9.2
-
- - so-request-db-adapter
-
- :Version: 1.9.2
-
- - so-sdc-controller
+~~~~~~~~~~~~~~~~~~~~~~~~~
- :Version: 1.9.2
+ - so-bpmn-infra **1.9.2**
- - so-sdnc-adapter
+ - so-catalog-db-adapter **1.9.2**
- :Version: 1.9.2
+ - so-admin-cockpit **1.8.3**
- - so-sol003-adapter
+ - so-nssmf-adapter **1.9.1**
- :Version: 1.8.2
+ - so-openstack-adapter **1.9.2**
- - so-api-handler-infra
+ - so-request-db-adapter **1.9.2**
- :Version: 1.9.2
+ - so-sdc-controller **1.9.2**
- - so-etsi-nfvo-ns-lcm
+ - so-sdnc-adapter **1.9.2**
- :Version: 1.8.2
+ - so-sol003-adapter **1.8.2**
- - so-oof-adapter
+ - so-api-handler-infra **1.9.2**
- :Version: 1.8.3
+ - so-etsi-nfvo-ns-lcm **1.8.2**
- - so-cnf-adapter
+ - so-oof-adapter **1.8.3**
- :Version: 1.9.1
+ - so-cnf-adapter **1.9.1**
Release Purpose
-----------------
+~~~~~~~~~~~~~~~
SO Istanbul Release.
The key deliverable for this release is refactoring SO for better internal architecture.
@@ -343,7 +265,7 @@ The full list of fixed bugs is available on `JIRA Istanbul BUGS
<https://jira.onap.org/issues/?jql=project%20%3D%20%22Service%20Orchestrator%22%20%20AND%20issuetype%20%3D%20Bug%20AND%20fixVersion%20%3D%20%22istanbul%20Release%22>`_
Security Notes
---------------
+~~~~~~~~~~~~~~
*Fixed Security Issues*
@@ -353,12 +275,12 @@ Security Notes
Quick Links:
-- `SO project page <https://wiki.onap.org/display/DW/Service+Orchestrator+Project>`__
-- `Passing Badge information for SDC <https://bestpractices.coreinfrastructure.org/en/projects/1702>`__
+- `SO project page`_
+- `Passing Badge information for SO`_
**Known Issues**
-* `SO-3237 <https://jira.onap.org/browse/SO-3237>`_ - Exposed HTTP port.
+* `SO-3237`_ - Exposed HTTP port.
**Upgrade Notes**
@@ -372,53 +294,35 @@ Quick Links:
**Other**
N/A
-***************************************************************************************
-=============
-Release Notes
-=============
+***************************************************************************************
Version: 1.8.3
-==============
+--------------
:Release Date: 2021-09-15
SO Release Image Versions
---------------------------
- - so-bpmn-infra
-
- :Version: 1.8.3
-
- - so-catalog-db-adapter
-
- :Version: 1.8.3
+~~~~~~~~~~~~~~~~~~~~~~~~~
- - so-nssmf-adapter
+ - so-bpmn-infra **1.8.3**
- :Version: 1.8.3
+ - so-catalog-db-adapter **1.8.3**
- - so-openstack-adapter
+ - so-nssmf-adapter **1.8.3**
- :Version: 1.8.3
+ - so-openstack-adapter **1.8.3**
- - so-request-db-adapter
+ - so-request-db-adapter **1.8.3**
- :Version: 1.8.3
+ - so-sdc-controller **1.8.3**
- - so-sdc-controller
+ - so-sdnc-adapter **1.8.3**
- :Version: 1.8.3
-
- - so-sdnc-adapter
-
- :Version: 1.8.3
-
- - so-api-handler-infra
-
- :Version: 1.8.3
+ - so-api-handler-infra **1.8.3**
Release Purpose
-----------------
+~~~~~~~~~~~~~~~
SO Honolulu Maintence Release.
The key delivereable for this release is fixing the known issues of H release of SO and sync up with the latest CDS client version.
@@ -445,7 +349,7 @@ The key delivereable for this release is fixing the known issues of H release of
Security Notes
---------------
+~~~~~~~~~~~~~~
*Fixed Security Issues*
@@ -455,12 +359,12 @@ Security Notes
Quick Links:
-- `SO project page <https://wiki.onap.org/display/DW/Service+Orchestrator+Project>`__
-- `Passing Badge information for SDC <https://bestpractices.coreinfrastructure.org/en/projects/1702>`__
+- `SO project page`_
+- `Passing Badge information for SO`_
**Known Issues**
-* `SO-3237 <https://jira.onap.org/browse/SO-3237>`_ - Exposed HTTP port.
+* `SO-3237`_ - Exposed HTTP port.
**Upgrade Notes**
@@ -474,70 +378,46 @@ Quick Links:
**Other**
N/A
+
***************************************************************************************
-Version: 8.0
-==============
+Version: 8.0.0
+--------------
:Release Date: 2021-04-19
SO Release Image Versions
---------------------------
- - so-bpmn-infra
+~~~~~~~~~~~~~~~~~~~~~~~~~
- :Version: 1.8.2
+ - so-bpmn-infra **1.8.2**
- - so-catalog-db-adapter
+ - so-catalog-db-adapter **1.8.2**
- :Version: 1.8.2
+ - so-admin-cockpit **1.8.2**
- - so-admin-cockpit
+ - so-nssmf-adapter **1.8.3**
- :Version: 1.8.2
+ - so-openstack-adapter **1.8.2**
- - so-nssmf-adapter
+ - so-request-db-adapter **1.8.2**
- :Version: 1.8.3
+ - so-sdc-controller **1.8.2**
- - so-openstack-adapter
+ - so-sdnc-adapter **1.8.2**
- :Version: 1.8.2
+ - so-sol003-adapter **1.8.2**
- - so-request-db-adapter
+ - so-api-handler-infra **1.8.2**
- :Version: 1.8.2
+ - so-etsi-nfvo-ns-lcm **1.8.2**
- - so-sdc-controller
+ - so-oof-adapter **1.8.3**
- :Version: 1.8.2
-
- - so-sdnc-adapter
-
- :Version: 1.8.2
-
- - so-sol003-adapter
-
- :Version: 1.8.2
-
- - so-api-handler-infra
-
- :Version: 1.8.2
-
- - so-etsi-nfvo-ns-lcm
-
- :Version: 1.8.2
-
- - so-oof-adapter
-
- :Version: 1.8.3
-
- - so-cnf-adapter
-
- :Version: 1.9.1
+ - so-cnf-adapter **1.9.1**
Release Purpose
-----------------
+~~~~~~~~~~~~~~~
SO Honolulu Release.
The key delivereable for this release is refactoring SO for better internal architecture.
@@ -567,7 +447,7 @@ The full list of fixed bugs is available on `JIRA Honolulu BUGS
Security Notes
---------------
+~~~~~~~~~~~~~~
*Fixed Security Issues*
@@ -577,13 +457,13 @@ Security Notes
Quick Links:
-- `SO project page <https://wiki.onap.org/display/DW/Service+Orchestrator+Project>`__
-- `Passing Badge information for SDC <https://bestpractices.coreinfrastructure.org/en/projects/1702>`__
+- `SO project page`_
+- `Passing Badge information for SO`_
**Known Issues**
* `SO-3628 <https://jira.onap.org/browse/SO-3628>`_ - SO cannot send CDS request due to grpc schema problem.
* `SO-3626 <https://jira.onap.org/browse/SO-3626>`_ - SO does not requests CDS for skipPostInstantiation flag set to False.
-* `SO-3237 <https://jira.onap.org/browse/SO-3237>`_ - Exposed HTTP port.
+* `SO-3237`_ - Exposed HTTP port.
**Upgrade Notes**
@@ -597,76 +477,49 @@ Quick Links:
**Other**
N/A
-***************************************************************************************
+***************************************************************************************
Version: 1.7.10
-==============
+---------------
:Release Date: 2020-11-19
SO Release Image Versions
---------------------------
- - so-bpmn-infra
+~~~~~~~~~~~~~~~~~~~~~~~~~
- :Version: 1.7.10
+ - so-bpmn-infra **1.7.10**
- - so-catalog-db-adapter
+ - so-catalog-db-adapter **1.7.10**
- :Version: 1.7.10
+ - so-monitoring **1.7.10**
- - so-monitoring
+ - so-nssmf-adapter **1.7.10**
- :Version: 1.7.10
+ - so-openstack-adapter **1.7.10**
- - so/nssmf-adapter
+ - so-request-db-adapter **1.7.10**
- :Version: 1.7.10
+ - so-sdc-controller **1.7.10**
- - so/openstack-adapter
+ - so-sdnc-adapter **1.7.10**
- :Version: 1.7.10
+ - so-vnfm-adapter **1.7.10**
- - so/request-db-adapter
+ - so-api-handler-infra **1.7.10**
- :Version: 1.7.10
+ - so-api-handler-infra **1.7.10**
- - so/sdc-controller
+ - so-so-etsi-nfvo-ns-lcm **1.7.7**
- :Version: 1.7.10
+ - so-so-oof-adapter **1.7.6**
- - so/sdnc-adapter
-
- :Version: 1.7.10
-
- - so/vnfm-adapter
-
- :Version: 1.7.10
-
- - so/api-handler-infra
-
- :Version: 1.7.10
-
- - so/api-handler-infra
-
- :Version: 1.7.10
-
- - so/so-etsi-nfvo-ns-lcm
-
- :Version: 1.7.7
-
- - so/so-oof-adapter
-
- :Version: 1.7.6
-
- - so/cnf-adapter
-
- :Version: 1.7.10
+ - so-cnf-adapter **1.7.10**
Release Purpose
-----------------
+~~~~~~~~~~~~~~~
SO Guilin Release
**Epics**
@@ -679,7 +532,7 @@ SO Guilin Release
* `SO-2842 <https://jira.onap.org/browse/SO-2842>`_ - Support for SOL005 NBI API Handler
* `SO-2841 <https://jira.onap.org/browse/SO-2841>`_ - Support SO NFVO Microservice Plugin Capabilities
* `SO-2840 <https://jira.onap.org/browse/SO-2840>`_ - Support for ETSI NFV NFVO Orchestrator in ONAP SO (ONAP SO ETSI-Aligned Hierarchical Orchestration)
-* `SO-2841 <https://jira.onap.org/browse/SO-2681>`_ - SO direct Catalog Management Support - Guilin
+* `SO-2681 <https://jira.onap.org/browse/SO-2681>`_ - SO direct Catalog Management Support - Guilin
* `SO-2046 <https://jira.onap.org/browse/SO-2046>`_ - support Java 11 upgrade
@@ -763,7 +616,7 @@ Listed below are highest and high piority jira tasks handled in the Guilin relea
Security Notes
---------------
+~~~~~~~~~~~~~~
*Fixed Security Issues*
@@ -773,8 +626,8 @@ Security Notes
Quick Links:
-- `SO project page <https://wiki.onap.org/display/DW/Service+Orchestrator+Project>`__
-- `Passing Badge information for SDC <https://bestpractices.coreinfrastructure.org/en/projects/1702>`__
+- `SO project page`_
+- `Passing Badge information for SO <https://bestpractices.coreinfrastructure.org/en/projects/1702>`_
**Known Issues**
* `SO-3403 <https://jira.onap.org/browse/SO-3403>`_ - The functionality of the SO cnf-adapter will be tested further and will be delivered by the Guilin Maintenance Release as a 1.7.11 patch.
@@ -793,6 +646,7 @@ Quick Links:
**Other**
N/A
+
***************************************************************************************
@@ -801,23 +655,22 @@ Version: 1.6.4
:Release Date: 13th July 2020
-**Docker Images**
-
-**Dockers released for SO:**
-
- - onap/so/api-handler-infra
- - onap/so/bpmn-infra
- - onap/so/catalog-db-adapter
- - onap/so/openstack-adapter
- - onap/so/request-db-adapter
- - onap/so/sdc-controller
- - onap/so/sdnc-adapter
- - onap/so/so-monitoring
- - onap/so/vfc-adapter
- - onap/so/vnfm-adapter
- - onap/so/ve-vnfm-adapter
- - onap/so/nssmf-adapter
- - onap/so/appc-orchestrator
+SO Release Image Versions
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+ - onap-so-api-handler-infra
+ - onap-so-bpmn-infra
+ - onap-so-catalog-db-adapter
+ - onap-so-openstack-adapter
+ - onap-so-request-db-adapter
+ - onap-so-sdc-controller
+ - onap-so-sdnc-adapter
+ - onap-so-so-monitoring
+ - onap-so-vfc-adapter
+ - onap-so-vnfm-adapter
+ - onap-so-ve-vnfm-adapter
+ - onap-so-nssmf-adapter
+ - onap-so-appc-orchestrator
**Release Purpose**
@@ -845,8 +698,8 @@ The main goal of the Frankfurt maintenance release was to:
Quick Links:
- - `SO project page <https://wiki.onap.org/display/DW/Service+Orchestrator+Project>`_
- - `Passing Badge information for SO <https://bestpractices.coreinfrastructure.org/en/projects/1702>`_
+- `SO project page`_
+- `Passing Badge information for SO`_
**Known Issues**
@@ -867,29 +720,29 @@ OJSI Issues
**Other**
N/A
+
***************************************************************************************
Version: 1.6.3
------------------------
+--------------
:Release Date:
-**Docker Images**
-
-**Dockers released for SO:**
-
- - onap/so/api-handler-infra
- - onap/so/bpmn-infra
- - onap/so/catalog-db-adapter
- - onap/so/openstack-adapter
- - onap/so/request-db-adapter
- - onap/so/sdc-controller
- - onap/so/sdnc-adapter
- - onap/so/so-monitoring
- - onap/so/vfc-adapter
- - onap/so/vnfm-adapter
- - onap/so/ve-vnfm-adapter
- - onap/so/nssmf-adapter
+SO Release Image Versions
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+ - onap-so-api-handler-infra
+ - onap-so-bpmn-infra
+ - onap-so-catalog-db-adapter
+ - onap-so-openstack-adapter
+ - onap-so-request-db-adapter
+ - onap-so-sdc-controller
+ - onap-so-sdnc-adapter
+ - onap-so-so-monitoring
+ - onap-so-vfc-adapter
+ - onap-so-vnfm-adapter
+ - onap-so-ve-vnfm-adapter
+ - onap-so-nssmf-adapter
**Release Purpose**
@@ -915,9 +768,9 @@ The main goal of the Frankfurt release was to:
Features Being considered for F release (As per the resource availability):
+---------------------------------------------------------------------+
-|SOL005 Adapter supports communication security |
+|SOL005 Adapter supports communication security |
+---------------------------------------------------------------------+
-|SOL005 Adapter supports NS LCM |
+|SOL005 Adapter supports NS LCM |
+---------------------------------------------------------------------+
|Multi-domain Optical Network Service Orchestration Support in SO |
+---------------------------------------------------------------------+
@@ -1079,14 +932,13 @@ Features Being considered for F release (As per the resource availability):
Quick Links:
- - `SO project page <https://wiki.onap.org/display/DW/Service+Orchestrator+Project>`_
- - `Passing Badge information for SO <https://bestpractices.coreinfrastructure.org/en/projects/1702>`_
+- `SO project page`_
+- `Passing Badge information for SO`_
**Known Issues**
- [`SO-2903 <https://jira.onap.org/browse/SO-2903>`__\ ] - Include so-appc-orchestrator with SO OOM
-Appc Orchestrator Pod release : Appc - Ochestrator code changes will be delivered as part of the patch on Frankfurt as the OOM changes were delayed. These would be release as part of the post release flows.
OJSI Issues
@@ -1106,25 +958,24 @@ OJSI Issues
N/A
Version: 5.0.1
------------------------
+--------------
:Release Date: 2019-10-11
-**Docker Images**
-
-**Dockers released for SO:**
-
- - onap/so/api-handler-infra,1.5.3
- - onap/so/bpmn-infra,1.5.3
- - onap/so/catalog-db-adapter,1.5.3
- - onap/so/openstack-adapter,1.5.3
- - onap/so/request-db-adapter,1.5.3
- - onap/so/sdc-controller,1.5.3
- - onap/so/sdnc-adapter,1.5.3
- - onap/so/so-monitoring,1.5.3
- - onap/so/vfc-adapter,1.5.3
- - onap/so/vnfm-adapter,1.5.3
- - onap/so/vnfm-simulator,1.5.3
+SO Release Image Versions
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+ - onap-so-api-handler-infra,1.5.3
+ - onap-so-bpmn-infra,1.5.3
+ - onap-so-catalog-db-adapter,1.5.3
+ - onap-so-openstack-adapter,1.5.3
+ - onap-so-request-db-adapter,1.5.3
+ - onap-so-sdc-controller,1.5.3
+ - onap-so-sdnc-adapter,1.5.3
+ - onap-so-so-monitoring,1.5.3
+ - onap-so-vfc-adapter,1.5.3
+ - onap-so-vnfm-adapter,1.5.3
+ - onap-so-vnfm-simulator,1.5.3
**Release Purpose**
@@ -1243,8 +1094,8 @@ The main goal of the El-Alto release was to improve documentation, UT improvemen
Quick Links:
- - `SO project page <https://wiki.onap.org/display/DW/Service+Orchestrator+Project>`_
- - `Passing Badge information for SO <https://bestpractices.coreinfrastructure.org/en/projects/1702>`_
+- `SO project page`_
+- `Passing Badge information for SO`_
**Known Issues**
@@ -1283,20 +1134,19 @@ Version: 1.4.4
:Release Date: 2019-06-13
-**Docker Images**
-
-**Dockers released for SO:**
-
- - onap/so/api-handler-infra,1.4.4
- - onap/so/bpmn-infra,1.4.4
- - onap/so/catalog-db-adapter,1.4.4
- - onap/so/openstack-adapter,1.4.4
- - onap/so/request-db-adapter,1.4.4
- - onap/so/sdc-controller,1.4.4
- - onap/so/sdnc-adapter,1.4.4
- - onap/so/so-monitoring,1.4.4
- - onap/so/vfc-adapter,1.4.4
- - onap/so/vnfm-adapter,1.4.4
+SO Release Image Versions
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+ - onap-so-api-handler-infra,1.4.4
+ - onap-so-bpmn-infra,1.4.4
+ - onap-so-catalog-db-adapter,1.4.4
+ - onap-so-openstack-adapter,1.4.4
+ - onap-so-request-db-adapter,1.4.4
+ - onap-so-sdc-controller,1.4.4
+ - onap-so-sdnc-adapter,1.4.4
+ - onap-so-so-monitoring,1.4.4
+ - onap-so-vfc-adapter,1.4.4
+ - onap-so-vnfm-adapter,1.4.4
**Release Purpose**
@@ -1477,13 +1327,13 @@ The main goal of the Dublin release was to:
**Security Notes**
- SO code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The SO open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=43385708>`_.
+ SO code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The SO open Critical security vulnerabilities and their risk assessment have been documented as part of the `project`_.
Quick Links:
- - `SO project page <https://wiki.onap.org/display/DW/Service+Orchestrator+Project>`_
- - `Passing Badge information for SO <https://bestpractices.coreinfrastructure.org/en/projects/1702>`_
- - `Project Vulnerability Review Table for SO <https://wiki.onap.org/pages/viewpage.action?pageId=43385708>`_
+- `SO project page`_
+- `Passing Badge information for SO`_
+- `Project Vulnerability Review Table for SO`_
**Known Issues**
@@ -1529,19 +1379,18 @@ This release is supporting the features of Casablanca and their defect fixes.
- `SO-1416 <https://jira.onap.org/browse/SO-1416>`_
- `SO-1417 <https://jira.onap.org/browse/SO-1417>`_
-**Docker Images**
-
-Dockers released for SO:
-
- - onap/so/api-handler-infra,1.3.7
- - onap/so/bpmn-infra,1.3.7
- - onap/so/catalog-db-adapter,1.3.7
- - onap/so/openstack-adapter,1.3.7
- - onap/so/request-db-adapter,1.3.7
- - onap/so/sdc-controller,1.3.7
- - onap/so/sdnc-adapter,1.3.7
- - onap/so/so-monitoring,1.3.7
- - onap/so/vfc-adapter,1.3.7
+SO Release Image Versions
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+ - onap-so-api-handler-infra,1.3.7
+ - onap-so-bpmn-infra,1.3.7
+ - onap-so-catalog-db-adapter,1.3.7
+ - onap-so-openstack-adapter,1.3.7
+ - onap-so-request-db-adapter,1.3.7
+ - onap-so-sdc-controller,1.3.7
+ - onap-so-sdnc-adapter,1.3.7
+ - onap-so-so-monitoring,1.3.7
+ - onap-so-vfc-adapter,1.3.7
**Known Issues**
@@ -1551,13 +1400,13 @@ Dockers released for SO:
**Security Notes**
- SO code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The SO open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=43385708>`_.
+ SO code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The SO open Critical security vulnerabilities and their risk assessment have been documented as part of the `project`_.
Quick Links:
- - `SO project page <https://wiki.onap.org/display/DW/Service+Orchestrator+Project>`_
- - `Passing Badge information for SO <https://bestpractices.coreinfrastructure.org/en/projects/1702>`_
- - `Project Vulnerability Review Table for SO <https://wiki.onap.org/pages/viewpage.action?pageId=43385708>`_
+- `SO project page`_
+- `Passing Badge information for SO`_
+- `Project Vulnerability Review Table for SO`_
Version: 1.3.6
@@ -1577,36 +1426,35 @@ This release is supporting the features of Casablanca and their defect fixes.
- `SO-1257 <https://jira.onap.org/browse/SO-1257>`_
- `SO-1258 <https://jira.onap.org/browse/SO-1258>`_
- `SO-1256 <https://jira.onap.org/browse/SO-1256>`_
-- `SO-1194 <https://jira.onap.org/browse/SO-1256>`_
+- `SO-1194`_
- `SO-1248 <https://jira.onap.org/browse/SO-1248>`_
- `SO-1184 <https://jira.onap.org/browse/SO-1184>`_
-**Docker Images**
-
-Dockers released for SO:
-
- - onap/so/api-handler-infra,1.3.6
- - onap/so/bpmn-infra,1.3.6
- - onap/so/catalog-db-adapter,1.3.6
- - onap/so/openstack-adapter,1.3.6
- - onap/so/request-db-adapter,1.3.6
- - onap/so/sdc-controller,1.3.6
- - onap/so/sdnc-adapter,1.3.6
- - onap/so/so-monitoring,1.3.6
- - onap/so/vfc-adapter,1.3.6
+SO Release Image Versions
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+ - onap-so-api-handler-infra,1.3.6
+ - onap-so-bpmn-infra,1.3.6
+ - onap-so-catalog-db-adapter,1.3.6
+ - onap-so-openstack-adapter,1.3.6
+ - onap-so-request-db-adapter,1.3.6
+ - onap-so-sdc-controller,1.3.6
+ - onap-so-sdnc-adapter,1.3.6
+ - onap-so-so-monitoring,1.3.6
+ - onap-so-vfc-adapter,1.3.6
**Known Issues**
**Security Notes**
- SO code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The SO open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=43385708>`_.
+ SO code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The SO open Critical security vulnerabilities and their risk assessment have been documented as part of the `project`_.
Quick Links:
- - `SO project page <https://wiki.onap.org/display/DW/Service+Orchestrator+Project>`_
- - `Passing Badge information for SO <https://bestpractices.coreinfrastructure.org/en/projects/1702>`_
- - `Project Vulnerability Review Table for SO <https://wiki.onap.org/pages/viewpage.action?pageId=43385708>`_
+- `SO project page`_
+- `Passing Badge information for SO`_
+- `Project Vulnerability Review Table for SO`_
New release over master branch for Dublin development
@@ -1631,19 +1479,18 @@ Features delivered in this release:
- Support to the CCVPN Usecase.
- Workflow Designer Integration.
-**Docker Images**
-
-Dockers released for SO:
-
- - onap/so/api-handler-infra,1.3.3
- - onap/so/bpmn-infra,1.3.3
- - onap/so/catalog-db-adapter,1.3.3
- - onap/so/openstack-adapter,1.3.3
- - onap/so/request-db-adapter,1.3.3
- - onap/so/sdc-controller,1.3.3
- - onap/so/sdnc-adapter,1.3.3
- - onap/so/so-monitoring,1.3.3
- - onap/so/vfc-adapter,1.3.3
+SO Release Image Versions
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+ - onap-so-api-handler-infra,1.3.3
+ - onap-so-bpmn-infra,1.3.3
+ - onap-so-catalog-db-adapter,1.3.3
+ - onap-so-openstack-adapter,1.3.3
+ - onap-so-request-db-adapter,1.3.3
+ - onap-so-sdc-controller,1.3.3
+ - onap-so-sdnc-adapter,1.3.3
+ - onap-so-so-monitoring,1.3.3
+ - onap-so-vfc-adapter,1.3.3
**Known Issues**
@@ -1676,13 +1523,13 @@ Below issues will be resolved in the next release:
**Security Notes**
- SO code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The SO open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=43385708>`_.
+ SO code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The SO open Critical security vulnerabilities and their risk assessment have been documented as part of the `project`_.
Quick Links:
- - `SO project page <https://wiki.onap.org/display/DW/Service+Orchestrator+Project>`_
- - `Passing Badge information for SO <https://bestpractices.coreinfrastructure.org/en/projects/1702>`_
- - `Project Vulnerability Review Table for SO <https://wiki.onap.org/pages/viewpage.action?pageId=43385708>`_
+ - `SO project page`_
+ - `Passing Badge information for SO`_
+ - `Project Vulnerability Review Table for SO`_
Version: 1.3.1
--------------
@@ -1743,7 +1590,7 @@ Quick Links:
- `SO project page <https://wiki.onap.org/display/DW/Service+Orchestrator+Project>`_
- `Passing Badge information for SO <https://bestpractices.coreinfrastructure.org/en/projects/1702>`_
-- `Project Vulnerability Review Table for SO <https://wiki.onap.org/pages/viewpage.action?pageId=28377799>`_
+- `Project Vulnerability Review Table for SO <https://wiki.onap.org/pages/viewpage.action?pageId=43385708>`_
**Upgrade Notes**
NA
diff --git a/docs/tox.ini b/docs/tox.ini
index 52accb2cf0..9b45c816d9 100644
--- a/docs/tox.ini
+++ b/docs/tox.ini
@@ -1,6 +1,6 @@
[tox]
minversion = 1.6
-envlist = docs
+envlist = docs,docs-spellcheck
skipsdist = true
[testenv:docs]
@@ -10,7 +10,7 @@ deps =
-chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt
-chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt
commands =
- sphinx-build -b html -n -d {envtmpdir}/doctrees ./ {toxinidir}/_build/html
+ sphinx-build -W -q -b html -n -d {envtmpdir}/doctrees ./ {toxinidir}/_build/html
echo "Generated docs available in {toxinidir}/_build/html"
whitelist_externals =
echo
@@ -24,7 +24,7 @@ deps =
-chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt
-chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt
commands = echo "Link Checking not enforced"
-#commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./ {toxinidir}/_build/linkcheck
+#commands = sphinx-build -W -q -b linkcheck -d {envtmpdir}/doctrees ./ {toxinidir}/_build/linkcheck
whitelist_externals = echo
[testenv:docs-spellcheck]
@@ -34,5 +34,5 @@ deps =
-chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt
-chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master
commands =
- sphinx-build -W -q -b spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/spellcheck
+ sphinx-build -q -b spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/spellcheck