From: Rich Bennett Date: Thu, 3 Jan 2019 18:18:25 +0000 (+0000) Subject: Merge "Documentation for ccsdk/apps" X-Git-Tag: elalto.1.5.2~7715 X-Git-Url: https://gerrit.onap.org/r/gitweb?a=commitdiff_plain;h=3806a3c200eb7e1309d6be6cbd7c7a646ccdfe14;hp=1efcc552a80ff081fddc2924d518528ab98d3784;p=doc.git Merge "Documentation for ccsdk/apps" --- diff --git a/docs/documentation.rst b/docs/documentation.rst deleted file mode 100644 index b0ceb914c..000000000 --- a/docs/documentation.rst +++ /dev/null @@ -1,42 +0,0 @@ - -.. _onap-documentation: - -ONAP Documentation -================== - -Welcome to the Open Network Automation Platform (ONAP) documentation site for the Casablanca Release! - -Please find some guidance here on the content of the Casablanca Release documentation for ONAP: - - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------+ - | Main documentation areas | Description | - +=======================================================+===============================================================================================+ - | :ref:`ONAP Overview ` | 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 ` | 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 ` | 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 ` | 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 ` | 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 ` | 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. | - +-------------------------------------------------------+-----------------------------------------------------------------------------------------------+ -You can reach the complete Casablanca Release documentation from the Navigation bar on the left. - diff --git a/docs/index.rst b/docs/index.rst index 549850bf8..27ef9c457 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -18,25 +18,40 @@ 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. -The ONAP Platform architecture is built on the highly efficient cooperation of -Design-time Framework activities with the functions provided by the -Run-time Framework. The Design-time Framework defines resources, services -and products, creates and manages processes and policies, provides a single -platform for deploying and defining instantiation management besides many -other activities. The Run-time framework manages the full lifecycle of -networks, services, resources, topology, orchestrates delivery, provides -monitoring via analytics and controls activities for applications and -virtual functions. +Please find some guidance here on the content of the Casablanca Release documentation for ONAP: -ONAP platform activities are supported by the Microservices support -system and by the ONAP Portal. + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | Main documentation areas | Description | + +=======================================================+===============================================================================================+ + | :ref:`ONAP Overview ` | 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 ` | 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 ` | 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 ` | 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 ` | 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 ` | 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. | + +-------------------------------------------------------+-----------------------------------------------------------------------------------------------+ -The following figure presents the high-level architecture of ONAP: - -.. image:: media/ONAP-architecture-high-level.png - :width: 800px - -For more details, see :ref:`ONAP Documentation ` (or alternatively you can also use the navigation bar on the left). +You can reach the complete Casablanca Release documentation from the Navigation bar on the left. .. toctree:: :maxdepth: 1 diff --git a/docs/submodules/aaf/authz.git b/docs/submodules/aaf/authz.git index 52c89c994..a5b72a805 160000 --- a/docs/submodules/aaf/authz.git +++ b/docs/submodules/aaf/authz.git @@ -1 +1 @@ -Subproject commit 52c89c9940544c1b2db1dd1e0ce9b22e2fcdca42 +Subproject commit a5b72a805fdf6fc88de674be886e9c170d0241bd diff --git a/docs/submodules/aai/aai-common.git b/docs/submodules/aai/aai-common.git index e42c7cf9d..1dd67efca 160000 --- a/docs/submodules/aai/aai-common.git +++ b/docs/submodules/aai/aai-common.git @@ -1 +1 @@ -Subproject commit e42c7cf9d25b5a5ec3e3bf2cbb5e04441ec45359 +Subproject commit 1dd67efcaf40c5b4278ad8594b78f63a838514ca diff --git a/docs/submodules/aai/sparky-be.git b/docs/submodules/aai/sparky-be.git index 8aec4dcf8..57e7ef7a5 160000 --- a/docs/submodules/aai/sparky-be.git +++ b/docs/submodules/aai/sparky-be.git @@ -1 +1 @@ -Subproject commit 8aec4dcf8241295b48cfbfe1f4827ba6b4ccf982 +Subproject commit 57e7ef7a5b1a20b6237c78f3a85a9b4bb5aefa54 diff --git a/docs/submodules/appc.git b/docs/submodules/appc.git index f87fdde3d..34aecca73 160000 --- a/docs/submodules/appc.git +++ b/docs/submodules/appc.git @@ -1 +1 @@ -Subproject commit f87fdde3dc86f801f97c1d18bee03d0c973de014 +Subproject commit 34aecca733edd7842139a33f57ea050dffb2f2ab diff --git a/docs/submodules/integration.git b/docs/submodules/integration.git index 27e162442..aa8c584d3 160000 --- a/docs/submodules/integration.git +++ b/docs/submodules/integration.git @@ -1 +1 @@ -Subproject commit 27e1624422a4ed07b349719522e4eaa375ad694f +Subproject commit aa8c584d3330ed3fe291f792ee01c323dcbc182c diff --git a/docs/submodules/modeling/modelspec.git b/docs/submodules/modeling/modelspec.git index 91680af84..1acf18950 160000 --- a/docs/submodules/modeling/modelspec.git +++ b/docs/submodules/modeling/modelspec.git @@ -1 +1 @@ -Subproject commit 91680af84aa4ca5e531436c3e173339e3ae481a1 +Subproject commit 1acf18950af916b21790a471b6994b724ec70bb1 diff --git a/docs/submodules/policy/apex-pdp.git b/docs/submodules/policy/apex-pdp.git index a3322831c..8f142981c 160000 --- a/docs/submodules/policy/apex-pdp.git +++ b/docs/submodules/policy/apex-pdp.git @@ -1 +1 @@ -Subproject commit a3322831cd5efec598613e8335931944db222e9f +Subproject commit 8f142981c3f5fddfd58c2e106ead7b4f5fc93da0 diff --git a/docs/submodules/policy/engine.git b/docs/submodules/policy/engine.git index ffdaf107b..31e122b8c 160000 --- a/docs/submodules/policy/engine.git +++ b/docs/submodules/policy/engine.git @@ -1 +1 @@ -Subproject commit ffdaf107b89321de081a4f122cf83393c196d769 +Subproject commit 31e122b8c77b933db7475b2889efcfba83e378b5 diff --git a/docs/submodules/sdc.git b/docs/submodules/sdc.git index 56ad07f5a..866418030 160000 --- a/docs/submodules/sdc.git +++ b/docs/submodules/sdc.git @@ -1 +1 @@ -Subproject commit 56ad07f5a6e107f198b239bbf6a10b1792dd5903 +Subproject commit 866418030975f2ee09a27d144de4e880218e84e8 diff --git a/docs/submodules/sdc/jtosca.git b/docs/submodules/sdc/jtosca.git index 8e6ae20e9..92208f69e 160000 --- a/docs/submodules/sdc/jtosca.git +++ b/docs/submodules/sdc/jtosca.git @@ -1 +1 @@ -Subproject commit 8e6ae20e9ae0a66c4f518f74d059e8cedf157693 +Subproject commit 92208f69ec00a3f9d28a917d6f6a43ef150863dd diff --git a/docs/submodules/sdc/sdc-tosca.git b/docs/submodules/sdc/sdc-tosca.git index 9cfa2619c..e502e8a5b 160000 --- a/docs/submodules/sdc/sdc-tosca.git +++ b/docs/submodules/sdc/sdc-tosca.git @@ -1 +1 @@ -Subproject commit 9cfa2619c0db224e4965797a1013f7a6cd1396ab +Subproject commit e502e8a5b21819ddaceb7c7d3ab387467231cc3c diff --git a/docs/submodules/sdc/sdc-workflow-designer.git b/docs/submodules/sdc/sdc-workflow-designer.git index 9ba698bac..3bfe76a41 160000 --- a/docs/submodules/sdc/sdc-workflow-designer.git +++ b/docs/submodules/sdc/sdc-workflow-designer.git @@ -1 +1 @@ -Subproject commit 9ba698bacab8e97da24f41cbba0c340e6099c9cc +Subproject commit 3bfe76a41d7c46d6b367801a0802eb8d4273dfe4 diff --git a/docs/submodules/so.git b/docs/submodules/so.git index 9898169af..85a47c701 160000 --- a/docs/submodules/so.git +++ b/docs/submodules/so.git @@ -1 +1 @@ -Subproject commit 9898169afc2281162121c298e8bb88c56f6fd6c7 +Subproject commit 85a47c701c3b34c58d2b121ba466d41ffb4fb7b0