Merge "Correction to documentation guide for API"
authorRich Bennett <rb2745@att.com>
Wed, 15 May 2019 03:36:05 +0000 (03:36 +0000)
committerGerrit Code Review <gerrit@onap.org>
Wed, 15 May 2019 03:36:05 +0000 (03:36 +0000)
33 files changed:
docs/guides/onap-provider/index.rst
docs/index.rst
docs/release/index.rst
docs/submodules/aaf/authz.git
docs/submodules/appc.git
docs/submodules/ccsdk/cds.git
docs/submodules/ccsdk/dashboard.git
docs/submodules/ccsdk/features.git
docs/submodules/ccsdk/platform/plugins.git
docs/submodules/clamp.git
docs/submodules/cli.git
docs/submodules/dcaegen2.git
docs/submodules/dmaap/buscontroller.git
docs/submodules/dmaap/datarouter.git
docs/submodules/dmaap/dbcapi.git
docs/submodules/dmaap/messagerouter/messageservice.git
docs/submodules/integration.git
docs/submodules/modeling/modelspec.git
docs/submodules/multicloud/azure.git
docs/submodules/multicloud/k8s.git
docs/submodules/music.git
docs/submodules/oom.git
docs/submodules/oom/offline-installer.git
docs/submodules/optf/cmso.git
docs/submodules/optf/osdf.git
docs/submodules/policy/apex-pdp.git
docs/submodules/policy/distribution.git
docs/submodules/policy/engine.git
docs/submodules/sdc.git
docs/submodules/sdnc/oam.git
docs/submodules/so.git
docs/submodules/usecase-ui.git
docs/submodules/vfc/nfvo/lcm.git

index 187d9dd..9476174 100644 (file)
@@ -2,10 +2,10 @@
 .. International License.  http://creativecommons.org/licenses/by/4.0
 .. Copyright 2017 AT&T Intellectual Property.  All rights reserved.
 
-.. _vnf_reqs:
+.. _vnf_pnf_reqs:
 
-VNF Requirements and Guidelines
-===============================
+VNF and PNF Requirements and Guidelines
+=======================================
 
 The following includes guides and requirements are provided to
 describe tasks that an VNF or PNF provider of ONAP may need to properly
index 895355d..5ff62a7 100644 (file)
@@ -18,40 +18,41 @@ the acceleration of the development of a vibrant ecosystem around a globally
 shared architecture and the implementation of network automation faster than
 any product could on its own.
 
-Please find some guidance here on the content of the Casablanca Release documentation for ONAP:
+Please find some guidance here on the content of the Dublin Release documentation for ONAP:
 
- +-------------------------------------------------------+-----------------------------------------------------------------------------------------------+
- | Main documentation areas                             |   Description                                                                                 |
- +=======================================================+===============================================================================================+
- | :ref:`ONAP Overview <getting-started>`                | ONAP Overview provides generic and high-level guidance on the mission and main                |
- |                                                       | functionalities of ONAP. Basic guidelines on license details, limitations and                 |
- |                                                       | security references support understanding the solution.                                       |
- +-------------------------------------------------------+-----------------------------------------------------------------------------------------------+
- | :ref:`ONAP Architecture <ONAP-architecture>`          | The ONAP architecture and its functional elements are described in details                    |
- |                                                       | here. We can learn how the two main frameworks, namely the Design-time                        |
- |                                                       | framework and the Run-time framework cooperate and how the Microservices,                     |
- |                                                       | Common services and the ONAP Portal support the certain functions.                            |
- +-------------------------------------------------------+-----------------------------------------------------------------------------------------------+
- | :ref:`Setting Up ONAP <installing-onap>`              | Installation guidelines and requirements help the very first set up of an                     |
- |                                                       | ONAP environment. The ONAP Operations Manager Cloud setup Guide and the                       |
- |                                                       | ONAP Operations Manager Quick Start Guide support the deployment and installation activities. |
- +-------------------------------------------------------+-----------------------------------------------------------------------------------------------+
- | :ref:`Developer Guides <ONAP_developer_guides>`       | Developers contributing to the ONAP development can find crucial information                  |
- |                                                       | in the Developer Guides. The reader can search among the developers’ topics                   |
- |                                                       | in alphabetical order.                                                                        |
- +-------------------------------------------------------+-----------------------------------------------------------------------------------------------+
- | :ref:`User Guides <user-guides>`                      | The User Guides provide details on the ONAP portal, which portal integrates                   |
- |                                                       | numerous different ONAP applications at one place. Platform operations are                    |
- |                                                       | supported with ONAP Operations Quick Start Guide and with an ONAP Operations                  |
- |                                                       | User Guide. The instantiation and the management of resources and the services                |
- |                                                       | are supported with a Service Design Guide and with guidelines on Service Deployment.          |
- +-------------------------------------------------------+-----------------------------------------------------------------------------------------------+
- | :ref:`VNF/PNF Requirements and Guidelines <vnf_reqs>` | Harmonized VNF and PNF requirements and reduced customization of onboarding VNFs              |
- |                                                       | and PNFs can accelerate the optimal usage of this ONAP environment. The guidelines            |
- |                                                       | on VNF/PNF requirements facilitates synchronized and aligned activities for all participants. |
- +-------------------------------------------------------+-----------------------------------------------------------------------------------------------+
+ +---------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
+ | Main documentation areas                                     |   Description                                                                                 |
+ +===============================================================+===============================================================================================+
+ | :ref:`ONAP Overview <getting-started>`                        | ONAP Overview provides generic and high-level guidance on the mission and main                |
+ |                                                               | functionalities of ONAP. Basic guidelines on license details, limitations and                 |
+ |                                                               | security references support understanding the solution.                                       |
+ +---------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
+ | :ref:`ONAP Architecture <ONAP-architecture>`                  | The ONAP architecture and its functional elements are described in details                    |
+ |                                                               | here. We can learn how the two main frameworks, namely the Design-time                        |
+ |                                                               | framework and the Run-time framework cooperate and how the Microservices,                     |
+ |                                                               | Common services and the ONAP Portal support the certain functions.                            |
+ +---------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
+ | :ref:`Setting Up ONAP <installing-onap>`                      | Installation guidelines and requirements help the very first set up of an                     |
+ |                                                               | ONAP environment. The ONAP Operations Manager Cloud setup Guide and the                       |
+ |                                                               | ONAP Operations Manager Quick Start Guide support the deployment and installation activities. |
+ +---------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
+ | :ref:`Developer Guides <ONAP_developer_guides>`               | Developers contributing to the ONAP development can find crucial information                  |
+ |                                                               | in the Developer Guides. The reader can search among the developers’ topics                   |
+ |                                                               | in alphabetical order.                                                                        |
+ +---------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
+ | :ref:`User Guides <user-guides>`                              | The User Guides provide details on the ONAP portal, which portal integrates                   |
+ |                                                               | numerous different ONAP applications at one place. Platform operations are                    |
+ |                                                               | supported with ONAP Operations Quick Start Guide and with an ONAP Operations                  |
+ |                                                               | User Guide. The instantiation and the management of resources and the services                |
+ |                                                               | are supported with a Service Design Guide and with guidelines on Service Deployment.          |
+ +---------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
+ | :ref:`VNF and PNF Requirements and Guidelines <vnf_pnf_reqs>` | Harmonized VNF and PNF requirements and reduced customization of onboarding VNFs              |
+ |                                                               | and PNFs can accelerate the optimal usage of this ONAP environment. The guidelines            |
+ |                                                               | on VNF and PNF requirements facilitates synchronized and aligned activities for all           |
+ |                                                               | participants.                                                                                 |
+ +---------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
 
-You can reach the complete Casablanca Release documentation from the Navigation bar on the left.
+You can reach the complete set of Dublin Release documentation from the Navigation bar on the left.
 
 .. toctree::
    :maxdepth: 1
index a54a0a4..c3bcba2 100644 (file)
@@ -4,78 +4,27 @@
 
 .. _casablancarelease-notes:
 
-Casablanca Release Notes
-^^^^^^^^^^^^^^^^^^^^^^^^
+Dublin Release Notes
+^^^^^^^^^^^^^^^^^^^^
 
-This page is the ONAP Casablanca Release Notes. The first release was labelled
-Amsterdam, second release Beijing and subsequent major release will be named
-using city names.
+This page provides the release notes for the ONAP Dublin release. This includes details of software versions used, known limitations, and
+outstanding trouble reports.
 
-Release notes are cumulative for the release, meaning this release note for Casablanca will have an entry for each Major, Minor, and Maintenance release, if applicable. Information that is applicable regardless of release is included in the `Getting Started With ONAP`_ section of this document.
+Release notes are cumulative for the release, meaning this release note for the Dublin release will have an entry for each Major, Minor, and Maintenance
+release, if applicable. Information that is applicable regardless of release is included in the `Getting Started With ONAP`_ section of this
+document.
 
-Each component within the ONAP solution maintains their own component level release notes and links to those release notes are provided below. Details on the specific items delivered in each releaese by each component is maintained in the component specific release notes.
+Each component within the ONAP solution maintains their own component level release notes and links to those release notes are provided below.
+Details on the specific items delivered in each releaese by each component is maintained in the component specific release notes.
 
-Casablanca Releases
-===================
-
-The following releases are available for Casablanca:
-  - `Casablanca Maintenance Release 3.0.2`_
-  - `Casablanca Maintenance Release 3.0.1`_
-  - `Casablanca Major Release 3.0.0`_
-
-Casablanca Maintenance Release 3.0.2
-====================================
-
-* Release Name: Casablanca
-* Release Version: 3.0.2
-* Release Date: Apr 15, 2019
-
-Casablanca Maintenance Release 3.0.2 addresses issue of certificate expiry across the following projects:
- - AAI
- - CLAMP
- - DMAAP Data Router
- - Policy
- - VID
- - Portal
-
-Details on the specific Jira tickets addressed by each project can be found in the component specific Release Notes. Link can be found below in section `Project Specific Release Notes`_.
-
-
-Casablanca Maintenance Release 3.0.1
-====================================
-
-* Release Name: Casablanca
-* Release Version: 3.0.1
-* Release Date: Jan 31, 2019
-
-Casablanca Maintenance Release 3.0.1 delivered a number of fixes and updates across the following projects:
- - AAI
- - APPC
- - CCSDK
- - CLAMP
- - DCAEGEN2
- - DOC
- - EXTAPI
- - Integration
- - MultiCloud
- - OOM
- - OOF
- - Policy
- - Portal
- - SDC
- - SDNC
- - SO
-
-Details on the specific Jira tickets addressed by each project can be found in the component specific Release Notes. Link can be found below in section `Project Specific Release Notes`_.
-
-Casablanca Major Release 3.0.0
-==============================
+Dublin Major Release 4.0.0
+==========================
 
-* Release Name: Casablanca
-* Release Version: 3.0.0
-* Release Date: Nov 30, 2018
+* Release Name: Dublin
+* Release Version: 4.0.0
+* Release Date: , 2019
 
-The Casablanca 3.0.0 is the first of Casablanca.
+The Dublin 4.0.0 is the first release for Dublin.
 
 .. _getting-started:
 
@@ -171,7 +120,8 @@ Detect -> Publish -> Respond:
 
 Project Specific Release Notes
 ==============================
-ONAP releases are specified by a list of project artifact versions in a :ref:`manifest artifacts <doc-release-manifest-artifacts>` and :ref:`manifest dockers <doc-release-manifest-docker>`.
+ONAP releases are specified by a list of project artifact versions in a :ref:`manifest artifacts <doc-release-manifest-artifacts>`
+and :ref:`manifest dockers <doc-release-manifest-docker>`.
 
 .. toctree::
    :hidden:
@@ -191,7 +141,7 @@ ONAP is installed using :ref:`ONAP Operations Manager (OOM) over Kubernetes<inst
 
 Documentation
 =============
-ONAP Casablanca Release provides multiple documents including the following:
+ONAP Dublin Release provides multiple documents including the following:
 
  * A high level :ref:`architecture view<doc-architecture>` of how component
    relate to each other.
index 6c74e83..685a3ee 160000 (submodule)
@@ -1 +1 @@
-Subproject commit 6c74e83e3a47a1e5b218253a1dba8bb89af5a002
+Subproject commit 685a3eea830c15d2b26a1f2851251203fa4f6156
index 298a8f5..25f856f 160000 (submodule)
@@ -1 +1 @@
-Subproject commit 298a8f5143c8ce87094770f68dfbbcc39ef14553
+Subproject commit 25f856faedd92ba62e8348507f7baf8ef34f4540
index 7bace3d..5acce93 160000 (submodule)
@@ -1 +1 @@
-Subproject commit 7bace3db55c2ca51431e88191cc7a8587d7aa508
+Subproject commit 5acce93a0594a249d972c2871a0631021d95de35
index 82be31b..646fb75 160000 (submodule)
@@ -1 +1 @@
-Subproject commit 82be31b8817c8070d5eff1f998098ee476c156ed
+Subproject commit 646fb75dbedd44a769faeb1c1ca075dc3a932883
index f3d5c90..63c4144 160000 (submodule)
@@ -1 +1 @@
-Subproject commit f3d5c900d268667062d98530dd9cb806f9c99827
+Subproject commit 63c4144c0664db9ea526c0608a30b47de80eed86
index 4f32aa9..906f5e2 160000 (submodule)
@@ -1 +1 @@
-Subproject commit 4f32aa90356e982b81940739414a4f28d384d7da
+Subproject commit 906f5e2dc9b12074a12b69cc874056ef4a185dcc
index 36d6db0..b38821c 160000 (submodule)
@@ -1 +1 @@
-Subproject commit 36d6db0d7b7cb2f8f1105b1a393d1f5f1f575564
+Subproject commit b38821c4136369ef50680b24c55d76ec3898af54
index b6a27e6..3ec4fe1 160000 (submodule)
@@ -1 +1 @@
-Subproject commit b6a27e640cba472d090090e990fae8856a6871f3
+Subproject commit 3ec4fe1a420c0bc440e433194c6c7e45e494787b
index 0c99792..8a09f07 160000 (submodule)
@@ -1 +1 @@
-Subproject commit 0c99792d581e9bd829b0ce61698dd20cd310f544
+Subproject commit 8a09f077a777fff2df144f4cd26e8704ed15d353
index 7a3fdbe..3ae6d64 160000 (submodule)
@@ -1 +1 @@
-Subproject commit 7a3fdbe253f2f4c7cf407d27fbd0bc990fdca817
+Subproject commit 3ae6d6484dbd735b6db373fab8da47306b61392b
index 5a96514..8c6eda2 160000 (submodule)
@@ -1 +1 @@
-Subproject commit 5a965147815d39f7825b2fc207e49bc470373129
+Subproject commit 8c6eda290e70036035b89d924d203a8c20e2a52c
index 9a8bdf2..b6c6c77 160000 (submodule)
@@ -1 +1 @@
-Subproject commit 9a8bdf20dbaf2f7e5ad473a60f9b083505ad908c
+Subproject commit b6c6c770247f737e7e2cfe52cec6e7a0b7f7178d
index 8537f3c..32a312c 160000 (submodule)
@@ -1 +1 @@
-Subproject commit 8537f3c5ee8bf3897404dff5442c6a10f4d1420d
+Subproject commit 32a312c7094841489ee5611d8c9fca55382954bd
index 7d140fd..8f3bfd7 160000 (submodule)
@@ -1 +1 @@
-Subproject commit 7d140fdfdffbd54bcc1dfcd7ba7762daa74017b3
+Subproject commit 8f3bfd740a868f4d2ccfc965880053f6712152b3
index 62dfa44..1decc54 160000 (submodule)
@@ -1 +1 @@
-Subproject commit 62dfa44900b49551f83b1e215fbf8b7d940f23a9
+Subproject commit 1decc54bebb62de71e5eed6cf1e7931065287846
index 06dbbc0..d69ada1 160000 (submodule)
@@ -1 +1 @@
-Subproject commit 06dbbc0751e9918b2c178b1144f4d52aa05a46e8
+Subproject commit d69ada1539f9d4bb716a723c1dad0c8c0b1c087d
index 3a6d8ec..117bf6f 160000 (submodule)
@@ -1 +1 @@
-Subproject commit 3a6d8ecba65a9c99cd5c2542978465969ead1590
+Subproject commit 117bf6f6409c77b3ceb435c368950040bcf90ec6
index 9a8b8ae..d6e7b63 160000 (submodule)
@@ -1 +1 @@
-Subproject commit 9a8b8ae8d7c8d6931f99def68068f8936a8cc0b3
+Subproject commit d6e7b63cc580e7b3822be61fe92a493ad5e222a3
index a661234..e323097 160000 (submodule)
@@ -1 +1 @@
-Subproject commit a661234e77ca4c42eae85abf36d6876b246b1347
+Subproject commit e323097501a808b41e57d6b501c33d2eeadb8359
index e7fd645..280ef8d 160000 (submodule)
@@ -1 +1 @@
-Subproject commit e7fd64586455a7c1270c1b1c846c19e030780315
+Subproject commit 280ef8da90cf2bab9ddf7b3df78b12a3b2cf6040
index 3aebac8..cc67f22 160000 (submodule)
@@ -1 +1 @@
-Subproject commit 3aebac8a20c046a36d6f0d28dfa0c4eb6a196b94
+Subproject commit cc67f224925c03f50ce47068cbde66799c65e3a0
index c46ef94..964c918 160000 (submodule)
@@ -1 +1 @@
-Subproject commit c46ef94c1b65b58646f20a3541c94ece28c2e0f0
+Subproject commit 964c918cbe56d463c32690da1e07b0f17a79eef2
index e460bd5..289472c 160000 (submodule)
@@ -1 +1 @@
-Subproject commit e460bd5616557985f28da94e82eb0d2673069913
+Subproject commit 289472c2259e9c18c1a4bdeffcc0f04e45a4b13f
index 39bac7e..07cb87c 160000 (submodule)
@@ -1 +1 @@
-Subproject commit 39bac7ed034c56eeb2b19a1b274fab35dbc9818f
+Subproject commit 07cb87c6cea08b59762c84f31eb08c6c182041aa
index cf91564..af688d7 160000 (submodule)
@@ -1 +1 @@
-Subproject commit cf915641e6476ff74761dd71601add65a8762e17
+Subproject commit af688d7c4ab6b387bcfe14c461a8832681864ade
index 8364c2d..19493ec 160000 (submodule)
@@ -1 +1 @@
-Subproject commit 8364c2d4c986e37cc1ea7e4120f5d13d14b03067
+Subproject commit 19493ec749d39407c90e841a2f3e503f6a03ecd7
index 14a1448..371ee58 160000 (submodule)
@@ -1 +1 @@
-Subproject commit 14a144870accfaf046e2b874cd6f519ecf6a7ae9
+Subproject commit 371ee58ccabb526a45ebfbd0acebb4b76ac888f4
index e43909d..f9c309f 160000 (submodule)
@@ -1 +1 @@
-Subproject commit e43909d8b17b2a243942c5bf299ab2a0ad5bfb3d
+Subproject commit f9c309fb9e789225ccd6b02ec9ab4777bbd4021c
index c50f96c..11d2ec9 160000 (submodule)
@@ -1 +1 @@
-Subproject commit c50f96c8914ba6a5153d81a600eb3bb8073a431d
+Subproject commit 11d2ec986be2c53da9bb4fecd49af0ccf4e6103c
index 531976a..0d3c00c 160000 (submodule)
@@ -1 +1 @@
-Subproject commit 531976ab0537e54c59eb6b443941dea5b2c83cb0
+Subproject commit 0d3c00cea893cff8d40ee740af3282f3077c8f37