Cherry pick beijing improvements to master

Replicating changes made when finalizing Beijing branch
in the doc master branch.

Change-Id: Ib1da658aef8cb84f896c6abac23631579ec0b80c
Issue-ID: DOC-280
Signed-off-by: Rich Bennett <rb2745@att.com>

diff --git a/docs/conf.py b/docs/conf.py
index f81a78b..146b009 100644 (file)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -67,7 +67,7 @@ master_doc = 'index'
 
 # General information about the project.
 project = u''
 
 # General information about the project.
 project = u''

-copyright = u'2017 ONAP. Licensed under Creative Commons Attribution 4.0 International License'
+copyright = u'2018 ONAP. Licensed under Creative Commons Attribution 4.0 International License'

 
 
 author = u'Open Network Automation Platform'
 
 
 author = u'Open Network Automation Platform'

diff --git a/docs/guides/onap-developer/apiref/index.rst b/docs/guides/onap-developer/apiref/index.rst
index 8ae5aab..f1a1171 100644 (file)
--- a/docs/guides/onap-developer/apiref/index.rst
+++ b/docs/guides/onap-developer/apiref/index.rst
@@ -35,9 +35,9 @@ Platform Components
    DCAE - Data Collection, Analytics, and Events <../../../submodules/dcaegen2.git/docs/sections/offeredapis.rst>
    Holmes - Alarm Correlation <../../../submodules/holmes/rule-management.git/docs/platform/offeredapis.rst>
    Policy <../../../submodules/policy/engine.git/docs/platform/offeredapis.rst>
    DCAE - Data Collection, Analytics, and Events <../../../submodules/dcaegen2.git/docs/sections/offeredapis.rst>
    Holmes - Alarm Correlation <../../../submodules/holmes/rule-management.git/docs/platform/offeredapis.rst>
    Policy <../../../submodules/policy/engine.git/docs/platform/offeredapis.rst>

+   SDNC - SDN Controller OAM <../../../submodules/sdnc/oam.git/docs/offeredapis.html>

    SO - Service Orchestration <../../../submodules/so.git/docs/offered_consumed_apis.rst>
    VFC - Virtual Function Controller <../../../submodules/vfc/nfvo/lcm.git/docs/platform/APIs/index.rst>
    SO - Service Orchestration <../../../submodules/so.git/docs/offered_consumed_apis.rst>
    VFC - Virtual Function Controller <../../../submodules/vfc/nfvo/lcm.git/docs/platform/APIs/index.rst>

-   NBI - NorthBound API <../../../submodules/externalapi/nbi.git/docs/offeredapis/index.rst>

 
 Common Services
 ---------------
 
 Common Services
 ---------------


@@ -46,13 +46,15 @@ Common Services
    :maxdepth: 1
    :titlesonly:
 
    :maxdepth: 1
    :titlesonly:
 

-   AAI - Active and Available Inventory Common <../../../submodules/aai/aai-common.git/docs/AAI REST API Documentation/AAIRESTAPI_AMSTERDAM.rst>
-   AAI - Active and Available Inventory ESR <../../../submodules/submodules/aai/esr-server.git/docs/offeredapis.rst>
-   DMaaP - Data Management as a Platform Message Router <../../../submodules/dmaap/messagerouter/messageservice.git/docs/offeredapis/offeredapis.rst>
+   AAI - Active and Available Inventory <../../../submodules/aai/aai-common.git/docs/AAI REST API Documentation/AAIRESTAPI_AMSTERDAM.rst>
+   AAI ESR <../../../submodules/aai/esr-server.git/docs/offeredapis.rst>
+   DMAAP MR - Data Management as a Platform (Message Router) <../../../submodules/dmaap/messagerouter/messageservice.git/docs/offeredapis/offeredapis.rst>
+   ExtAPI- External API/NBI - NorthBound API <../../../submodules/externalapi/nbi.git/docs/offeredapis/index.rst>

    Modeling Parsers <../../../submodules/modeling/toscaparsers.git/docs/offeredapis.rst>
    MSB - Micro Services Bus <../../../submodules/msb/apigateway.git/docs/platform/offeredapis.rst>
    Modeling Parsers <../../../submodules/modeling/toscaparsers.git/docs/offeredapis.rst>
    MSB - Micro Services Bus <../../../submodules/msb/apigateway.git/docs/platform/offeredapis.rst>

-   MultiVIM Cloud <../../../submodules/multicloud/framework.git/docs/MultiCloud-API-Specification-V1.rst>
-   Music <../../../submodules/music.git/docs/offeredapis.rst>
+   Multi Cloud <../../../submodules/multicloud/framework.git/docs/MultiCloud-API-Specification-V1.rst>
+   MUSIC - Multi-site State Coordination Service <../../../submodules/music.git/docs/offeredapis.rst>
+   OPTF - Optimization Framework <../../../submodules/optf/osdf.git/docs/sections/offeredapis.rst>

    VVP - VNF Validation Project <../../../submodules/vvp/documentation.git/docs/offeredapis.rst>
 
 SDK
    VVP - VNF Validation Project <../../../submodules/vvp/documentation.git/docs/offeredapis.rst>
 
 SDK

diff --git a/docs/guides/onap-developer/architecture/blueprint-enr.rst b/docs/guides/onap-developer/architecture/blueprint-enr.rst
index 8c1616d..a3018a1 100644 (file)
--- a/docs/guides/onap-developer/architecture/blueprint-enr.rst
+++ b/docs/guides/onap-developer/architecture/blueprint-enr.rst
@@ -1,5 +1,5 @@
 ONAP Blueprint Enrichment
 ONAP Blueprint Enrichment

-~~~~~~~~~~~~~~~~~~~~~~~~~
+-------------------------

 
 The ONAP Beijing release includes four functional enhancements in the
 areas of manually triggered scaling, change management, and hardware
 
 The ONAP Beijing release includes four functional enhancements in the
 areas of manually triggered scaling, change management, and hardware


@@ -9,7 +9,7 @@ applicable to any use case; however, to showcase them in a concrete
 manner, they have been incorporated into VoLTE and vCPE blueprints.
 
 Manually Triggered Scaling
 manner, they have been incorporated into VoLTE and vCPE blueprints.
 
 Manually Triggered Scaling

-^^^^^^^^^^^^^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~~~~~~~~~~~~~

 
 Scale-out and scale-in are two primary benefits of NFV. Scaling can be
 triggered manually (e.g., by a user or OSS/BSS) or automatically via a
 
 Scale-out and scale-in are two primary benefits of NFV. Scaling can be
 triggered manually (e.g., by a user or OSS/BSS) or automatically via a


@@ -27,7 +27,7 @@ The Beijing release provides the initial support for these capabilities.
 The community has implemented manually triggered scale-out and scale-in
 in combination with a specific VNF manager (sVNFM) and demonstrated this
 with the VoLTE blueprint. An operator uses the Usecase UI (UUI) project
 The community has implemented manually triggered scale-out and scale-in
 in combination with a specific VNF manager (sVNFM) and demonstrated this
 with the VoLTE blueprint. An operator uses the Usecase UI (UUI) project

-to trigger a scaling operation. UUI communicates with the Service
+to trigger a scaleing operation. UUI communicates with the Service

 Orchestrator (SO). SO uses the VF-C controller, which in turn instructs
 a vendor-provided sVNFM to implement the scale-out action.
 
 Orchestrator (SO). SO uses the VF-C controller, which in turn instructs
 a vendor-provided sVNFM to implement the scale-out action.
 


@@ -41,7 +41,7 @@ APPC over DMaaP, where APPC picks it up and executes the configuration
 scale out action on the requested VNF.
 
 Change Management
 scale out action on the requested VNF.
 
 Change Management

-^^^^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~~~~

 
 NFV will bring with it an era of continuous, incremental changes instead
 of periodic step-function software upgrades, in addition to a constant
 
 NFV will bring with it an era of continuous, incremental changes instead
 of periodic step-function software upgrades, in addition to a constant


@@ -69,7 +69,7 @@ the SDN-C controller in terms of running the pre-check, post-check and
 upgrade through Ansible playbooks.
 
 Hardware Platform Awareness (HPA)
 upgrade through Ansible playbooks.
 
 Hardware Platform Awareness (HPA)

-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

 
 Many VNFs have specific hardware requirements to achieve their
 performance and security goals. These hardware requirements may range
 
 Many VNFs have specific hardware requirements to achieve their
 performance and security goals. These hardware requirements may range

diff --git a/docs/guides/onap-developer/architecture/references.rst b/docs/guides/onap-developer/architecture/references.rst
index 3f5fb8e..520f8f9 100644 (file)
--- a/docs/guides/onap-developer/architecture/references.rst
+++ b/docs/guides/onap-developer/architecture/references.rst
@@ -28,10 +28,12 @@ User Interfaces
    :maxdepth: 1
    :titlesonly:
 
    :maxdepth: 1
    :titlesonly:
 

+   APPC CDT - Application Controller Design Tool  <../../../submodules/appc.git/docs/APPC CDT Guide/APPC CDT Guide.rst>

    CLAMP - Closed Loop Automation Platform <../../../submodules/clamp.git/docs/architecture.rst>
    CLI - Command Line Interface <../../../submodules/cli.git/docs/architecture.rst>
    CLAMP - Closed Loop Automation Platform <../../../submodules/clamp.git/docs/architecture.rst>
    CLI - Command Line Interface <../../../submodules/cli.git/docs/architecture.rst>

+   PORTAL <../../../submodules/portal.git/docs/platform/architecture.rst>

    SDC - Service Design and Creation <../../../submodules/sdc.git/docs/architecture.rst>
    SDC - Service Design and Creation <../../../submodules/sdc.git/docs/architecture.rst>

-   ../../../submodules/usecase-ui.git/docs/platform/architecture.rst
+   UUI- Usecase UI <../../../submodules/usecase-ui.git/docs/platform/architecture.rst>

    VID - Virtual Infrastructure Deployment <../../../submodules/vid.git/docs/architecture.rst>
 
 Platform Components
    VID - Virtual Infrastructure Deployment <../../../submodules/vid.git/docs/architecture.rst>
 
 Platform Components


@@ -41,11 +43,13 @@ Platform Components
    :maxdepth: 1
    :titlesonly:
 
    :maxdepth: 1
    :titlesonly:
 

+   APPC - Application Controller <../../../submodules/appc.git/docs/APPC User Guide/APPC User Guide.rst>

    DCAE - Data Collection Analytics and Events <../../../submodules/dcaegen2.git/docs/sections/architecture.rst>
    Holmes <../../../submodules/holmes/rule-management.git/docs/platform/architecture.rst>
    DCAE - Data Collection Analytics and Events <../../../submodules/dcaegen2.git/docs/sections/architecture.rst>
    Holmes <../../../submodules/holmes/rule-management.git/docs/platform/architecture.rst>

-   SDN Controller OAM <../../../submodules/sdnc/oam.git/docs/architecture.rst>
-   ../../../submodules/so.git/docs/architecture.rst
-   NBI - NorthBound API <../../../submodules/externalapi/nbi.git/docs/architecture/architecture.rst>
+   Policy <../../../submodules/policy/engine.git/docs/platform/architecture.rst>
+   SDNC - SDN Controller OAM <../../../submodules/sdnc/oam.git/docs/architecture.rst>
+   SO - Service Orchestrator <../../../submodules/so.git/docs/architecture.rst>
+   VFC - Virtual Function Controller <../../../submodules/vfc/nfvo/lcm.git/docs/platform/architecture.rst>

 
 Common Services
 ---------------
 
 Common Services
 ---------------


@@ -54,27 +58,16 @@ Common Services
    :maxdepth: 1
    :titlesonly:
 
    :maxdepth: 1
    :titlesonly:
 

+   AAF - Application Authorization Framework <../../../submodules/aaf/authz.git/docs/sections/architecture.rst>

    AAI - Active and Available Inventory <../../../submodules/aai/aai-common.git/docs/platform/architecture.rst>
    AAI - Active and Available Inventory <../../../submodules/aai/aai-common.git/docs/platform/architecture.rst>

-   AAI ESR UI <../../../submodules/aai/esr-gui.git/docs/platform/architecture.rst>
-   AAI ESR Server <../../../submodules/aai/esr-server.git/docs/platform/architecture.rst>
+   AAI ESR <../../../submodules/aai/esr-gui.git/docs/platform/architecture.rst>
+   DMAAP MR - Data Management as a Platform (Message Router)  <../../../submodules/dmaap/messagerouter/messageservice.git/docs/architecture/architecture.rst>
+   ExtAPI - External API/NBI <../../../submodules/externalapi/nbi.git/docs/architecture/architecture.rst>
+   Logging Framework - <../../../submodules/logging-analytics.git/docs/Logging_User_Guide/Logging_User_Guide.rst>

    MSB - Microservices Bus <../../../submodules/msb/apigateway.git/docs/platform/architecture.rst>
    MSB - Microservices Bus <../../../submodules/msb/apigateway.git/docs/platform/architecture.rst>

+   Multi Cloud <../../../submodules/multicloud/framework.git/docs/MultiCloud-Administration-Guide.rst>
+   MUSIC - Multi-site State Coordination Service <../../../submodules/music.git/docs/architecture.rst>
+   OOM - ONAP Operations Manager <../../../submodules/oom.git/docs/oom_project_description.rst>
+   OPTF - Optimization Framework <../../../submodules/optf/osdf.git/docs/sections/architecture.rst>
+   VNF SDK <../../../submodules/vnfsdk/model.git/docs/files/vnfsdk-apis.rst>

    VVP - VNF Validation Project <../../../submodules/vvp/documentation.git/docs/architecture.rst>
    VVP - VNF Validation Project <../../../submodules/vvp/documentation.git/docs/architecture.rst>

-
-
-SDKs
-----
-
-.. toctree::
-   :maxdepth: 1
-   :titlesonly:
-
-   Portal <../../../submodules/portal.git/docs/tutorials/portal-sdk/architecture.rst>
-
-
-VNFs
-----
-
-.. toctree::
-   :maxdepth: 1
-   :titlesonly:
-

diff --git a/docs/guides/onap-developer/developing/index.rst b/docs/guides/onap-developer/developing/index.rst
index 3524cf6..41e3c70 100644 (file)
--- a/docs/guides/onap-developer/developing/index.rst
+++ b/docs/guides/onap-developer/developing/index.rst
@@ -1,4 +1,5 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. This work is licensed under a Creative Commons Attribution
+.. 4.0 International License.

 .. http://creativecommons.org/licenses/by/4.0
 .. Copyright 2017 AT&T Intellectual Property.  All rights reserved.
 
 .. http://creativecommons.org/licenses/by/4.0
 .. Copyright 2017 AT&T Intellectual Property.  All rights reserved.
 


@@ -33,6 +34,25 @@ Application Controller
    ../../../submodules/appc/deployment.git/docs/index
    ../../../submodules/appc.git/docs/index
 
    ../../../submodules/appc/deployment.git/docs/index
    ../../../submodules/appc.git/docs/index
 

+Application Authorization Framework
+-----------------------------------
+
+.. toctree::
+   :maxdepth: 2
+   :titlesonly:
+
+   ../../../submodules/aaf/authz.git/docs/index
+
+Command Line Interface
+----------------------
+
+.. toctree::
+   :maxdepth: 2
+   :titlesonly:
+
+   ../../../submodules/cli.git/docs/index
+
+

 Closed Loop Automation Platform
 -------------------------------
 
 Closed Loop Automation Platform
 -------------------------------
 


@@ -116,11 +136,15 @@ Holmes
 Integration
 -----------
 
 Integration
 -----------
 

-* ONAP Amsterdam release content is specified within a list of project artifact versions available in the form of a :ref:`manifest<doc-release-manifest>`.
-* To install the whole ONAP (from a complete demo solution perspective) refer to :ref:`Setting Up ONAP <demo-installing-running-onap>`.
+* ONAP Beijing release content is specified within a list of project
+  artifact versions available in the form of
+  a :ref:`manifest<doc-release-manifest>`.

 
 

-Logging Enhancements Project
-----------------------------
+* To install the whole ONAP (from a complete demo solution perspective)
+  refer to :ref:`Setting Up ONAP <demo-installing-running-onap-requirements>`.
+
+Logging Analytics
+-----------------

 
 .. toctree::
    :maxdepth: 2
 
 .. toctree::
    :maxdepth: 2


@@ -171,18 +195,8 @@ Music
 
    ../../../submodules/music.git/docs/index
 
 
    ../../../submodules/music.git/docs/index
 

-
-ONAP Command Line Interface
----------------------------
-
-.. toctree::
-   :maxdepth: 2
-   :titlesonly:
-
-   ../../../submodules/cli.git/docs/index
-
-ONAP Operations Manager (experimental)
---------------------------------------
+ONAP Operations Manager
+-----------------------

 
 .. toctree::
    :maxdepth: 2
 
 .. toctree::
    :maxdepth: 2


@@ -190,8 +204,8 @@ ONAP Operations Manager (experimental)
 
    ../../../submodules/oom.git/docs/index
 
 
    ../../../submodules/oom.git/docs/index
 

-ONAP Optimization Framework
---------------------------------------
+Optimization Framework
+----------------------

 
 .. toctree::
    :maxdepth: 2
 
 .. toctree::
    :maxdepth: 2


@@ -200,16 +214,6 @@ ONAP Optimization Framework
    ../../../submodules/optf/has.git/docs/index
    ../../../submodules/optf/osdf.git/docs/index
 
    ../../../submodules/optf/has.git/docs/index
    ../../../submodules/optf/osdf.git/docs/index
 

-
-ONAP Use Case User Interface
-----------------------------
-
-.. toctree::
-   :maxdepth: 2
-   :titlesonly:
-
-   ../../../submodules/usecase-ui.git/docs/index
-

 Policy Framework
 ----------------
 
 Policy Framework
 ----------------
 


@@ -273,6 +277,15 @@ Software Defined Network Controller
    ../../../submodules/sdnc/parent.git/docs/index
    ../../../submodules/sdnc/plugins.git/docs/index
 
    ../../../submodules/sdnc/parent.git/docs/index
    ../../../submodules/sdnc/plugins.git/docs/index
 

+Use Case User Interface
+-----------------------
+
+.. toctree::
+   :maxdepth: 2
+   :titlesonly:
+
+   ../../../submodules/usecase-ui.git/docs/index
+

 User Interface Applications
 ---------------------------
 
 User Interface Applications
 ---------------------------
 

diff --git a/docs/guides/onap-developer/index.rst b/docs/guides/onap-developer/index.rst
index 8ef2c0a..8ed4eae 100644 (file)
--- a/docs/guides/onap-developer/index.rst
+++ b/docs/guides/onap-developer/index.rst
@@ -4,8 +4,8 @@
 
 .. _onap_developer_guides:
 
 
 .. _onap_developer_guides:
 

-ONAP Developer Guides
-=====================
+Developer Guides
+================

 The following guides are provided for developers who want to
 understanding or contribute to the ONAP open source.
 
 The following guides are provided for developers who want to
 understanding or contribute to the ONAP open source.
 


@@ -18,4 +18,5 @@ understanding or contribute to the ONAP open source.
    developing/index
    how-to-use-docs/index
    apiref/index
    developing/index
    how-to-use-docs/index
    apiref/index

+   use-cases/index

 
 

diff --git a/docs/guides/onap-developer/settingup/index.rst b/docs/guides/onap-developer/settingup/index.rst
index f9b4881..d905a79 100644 (file)
--- a/docs/guides/onap-developer/settingup/index.rst
+++ b/docs/guides/onap-developer/settingup/index.rst
@@ -7,11 +7,30 @@
 Setting Up ONAP
 ===============
 
 Setting Up ONAP
 ===============
 

-ONAP can be deployed using 2 different solutions:
+ONAP can be deployed using 3 different solutions:
+
+* Installation using Kubernetes (aka OOM). Recommended method.
+* Installation using Heat template.
+* Advanced installation to install individual components.
+
+The following table presents the required resources to deploy ONAP.
+
+  ============  ===  ====  ===========  ============
+  Installation  VM   vCPU  Memory (GB)  Storage (GB)
+  ============  ===  ====  ===========  ============
+  Kubernetes    4    32    128          160
+  Heat          20   88    176          1760
+  Individual    1*   1*    2*           20*
+  ============  ===  ====  ===========  ============
+
+(*) For individual deployment, it depends on the components.
+
+The various installations can be found here:

 
 .. toctree::
    :maxdepth: 1
    :titlesonly:
 
 
 .. toctree::
    :maxdepth: 1
    :titlesonly:
 

-   onap_heat.rst

    onap_oom.rst
    onap_oom.rst

+   onap_heat.rst
+   onap_individual.rst

diff --git a/docs/guides/onap-developer/settingup/onap_heat.rst b/docs/guides/onap-developer/settingup/onap_heat.rst
index afbbd6b..f3b545a 100644 (file)
--- a/docs/guides/onap-developer/settingup/onap_heat.rst
+++ b/docs/guides/onap-developer/settingup/onap_heat.rst
@@ -10,18 +10,17 @@
 
 .. index:: Setting Up Full ONAP using Virtual Machines
 
 
 .. index:: Setting Up Full ONAP using Virtual Machines
 

+==============================
+**Setting Up ONAP using Heat**
+==============================

 
 

-===============================================
-**Setting Up Full ONAP using Virtual Machines**
-===============================================
-
-.. _demo-installing-running-onap:
+.. _installing-onap-heat:

 
 **Context**
 ===========
 ONAP may be deployed in different contexts depending on your requirements.
 The recommended installation for Beijng Release over virtual machines is based
 
 **Context**
 ===========
 ONAP may be deployed in different contexts depending on your requirements.
 The recommended installation for Beijng Release over virtual machines is based

-on OpenStack HEAT Template.
+on OpenStack Heat Template.

 
 The VNFs managed by ONAP may be deployed in different OpenStack tenants or
 based on top of VMware based infrastructure. For details, refer
 
 The VNFs managed by ONAP may be deployed in different OpenStack tenants or
 based on top of VMware based infrastructure. For details, refer


@@ -30,6 +29,11 @@ based on top of VMware based infrastructure. For details, refer
 The current installation is based on the single tenant deployment (all the ONAP
 components will be hosted in a unique tenant).
 
 The current installation is based on the single tenant deployment (all the ONAP
 components will be hosted in a unique tenant).
 

+.. note::
+   Prior to deployment of ONAP, there is no need to download manually any Docker Container.
+   The Heat deployment takes care to automatically download the Docker Containers.
+
+

 .. _demo-installing-running-onap-requirements:
 
 **Requirements**
 .. _demo-installing-running-onap-requirements:
 
 **Requirements**


@@ -148,9 +152,9 @@ Both following files must be downloaded and configured to match your
 configuration:
 
 - Template file:
 configuration:
 
 - Template file:

-  https://git.onap.org/demo/plain/heat/ONAP/onap_openstack.yaml
+  https://git.onap.org/demo/plain/heat/ONAP/onap_openstack.yaml?h=beijing

 - Environment file:
 - Environment file:

-  https://git.onap.org/demo/plain/heat/ONAP/onap_openstack.env
+  https://git.onap.org/demo/plain/heat/ONAP/onap_openstack.env?h=beijing

 
 The environment file must be customized as described in the following sections.
 
 
 The environment file must be customized as described in the following sections.
 


@@ -408,7 +412,7 @@ command:
 ========================
 The current ONAP installation is using the *onap.org* domain.
 To use the portal on your desktop, you must configure the following information
 ========================
 The current ONAP installation is using the *onap.org* domain.
 To use the portal on your desktop, you must configure the following information

-in your *host* file (located in /etc/hosts for Linux or
+in your *hosts* file (located in /etc/hosts for Linux or

 /windows/system32/drivers/etc/hosts for Windows):
 
 .. code-block:: bash
 /windows/system32/drivers/etc/hosts for Windows):
 
 .. code-block:: bash

diff --git a/docs/guides/onap-developer/settingup/onap_individual.rst b/docs/guides/onap-developer/settingup/onap_individual.rst
new file mode 100644 (file)
index 0000000..8bd92d8
--- /dev/null
+++ b/docs/guides/onap-developer/settingup/onap_individual.rst
@@ -0,0 +1,35 @@
+.. This work is licensed undera Creative Commons Attribution 4.0
+.. International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright 2017-2018 ONAP
+
+
+.. index:: Setting Up ONAP individual components
+
+
+=========================================
+**Setting Up ONAP individual components**
+=========================================
+
+.. _installing-onap-individual:
+
+**Context**
+===========
+From a developer perspective, ONAP can be installed component per component.
+For details, refer to :ref:`the installation procedure available for each
+component<index-setting-individual-components>`.
+The advanced installation procedure is recommended only for experienced
+developers who desire to focus their attention on a few components and who
+have a deep understanding of dependencies between components.
+This type of installation is not recommended to fully install ONAP.
+
+* The list of ports used by default within ONAP is documented
+  in `ONAP Service List <https://wiki.onap.org/display/DW/ONAP+Services+List>`_.
+
+* The ONAP Source Code is available through Gerrit
+  at https://gerrit.onap.org/r/#/admin/projects or Git at https://git.onap.org/.
+
+* ONAP is packaged within Docker and can be dowloaded from Docker Hub at https://hub.docker.com/r/onap.
+
+* ONAP Docker releases are specified by a list of project artifact versions
+  in a :ref:`manifest<doc-release-manifest>`.

diff --git a/docs/guides/onap-developer/settingup/onap_oom.rst b/docs/guides/onap-developer/settingup/onap_oom.rst
index d793376..813168f 100644 (file)
--- a/docs/guides/onap-developer/settingup/onap_oom.rst
+++ b/docs/guides/onap-developer/settingup/onap_oom.rst
@@ -3,23 +3,58 @@
 .. http://creativecommons.org/licenses/by/4.0
 .. Copyright 2018 ONAP
 
 .. http://creativecommons.org/licenses/by/4.0
 .. Copyright 2018 ONAP
 

+.. index:: Setting Up Full ONAP using Containers

 
 

-.. contents::
-   :depth: 2
-..
+====================================
+**Setting Up ONAP using Kubernetes**
+====================================

 
 

-.. index:: Setting Up Full ONAP using Containers
+.. _installing-onap-k8s:

 
 

+**Context**
+===========

 
 

-=========================================
-**Setting Up Full ONAP using Containers**
-=========================================
+The recommended ONAP deployment is based on Kubernetes and Docker containers.
+This method is also called deployment through OOM.

 
 

+The following is the recommended component version.

 
 

-.. This work is licensed under a Creative Commons Attribution 4.0
-.. International License.
-..  http://creativecommons.org/licenses/by/4.0
-.. Copyright 2018 ONAP
+  ===========  =========
+  Software     Version
+  ===========  =========
+  Kubernetes   1.8.10
+  Helm         2.8.2
+  kubectl      1.8.10
+  Docker       17.03.x
+  ===========  =========
+
+Creation of Kubernetes cluster is described here:
+
+.. toctree::
+   :maxdepth: 1
+   :titlesonly:
+
+   ../../../../submodules/oom.git/docs/oom_cloud_setup_guide.rst
+
+
+The ONAP full installation requires the following footprint:
+ - 4 VM
+ - 32 vCPU
+ - 128 GB RAM
+ - 160 GB Storage
+
+ONAP installation is described here:
+
+.. toctree::
+   :maxdepth: 1
+   :titlesonly:
+
+   ../../../../submodules/oom.git/docs/oom_quickstart_guide.rst

 
 

+.. note::
+   Prior to deployment of ONAP, there is no need to download manually any Docker container.
+   The OOM deployment takes care to automatically download the Docker containers.

 
 

-.. contents::
\ No newline at end of file
+   It is also possible to deploy a subset of ONAP components on a single VM.
+   The VM flavor to be used depends on the number of ONAP components to be
+   deployed.

diff --git a/docs/guides/onap-developer/use-cases/index.rst b/docs/guides/onap-developer/use-cases/index.rst
new file mode 100644 (file)
index 0000000..d9dc0d2
--- /dev/null
+++ b/docs/guides/onap-developer/use-cases/index.rst
@@ -0,0 +1,15 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright 2017 AT&T Intellectual Property.  All rights reserved.
+
+Use Cases
+=========
+
+Example uses case descriptions and sequence diagrams illustrating
+interactions between platform components.
+
+.. toctree::
+   :maxdepth: 1
+
+   vfw.rst
+   volte.rst

diff --git a/docs/guides/onap-developer/use-cases/vfw.rst b/docs/guides/onap-developer/use-cases/vfw.rst
new file mode 100644 (file)
index 0000000..2f83102
--- /dev/null
+++ b/docs/guides/onap-developer/use-cases/vfw.rst
@@ -0,0 +1,74 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright 2017 AT&T Intellectual Property.  All rights reserved.
+
+vFirewall Use Case
+==================
+
+Description
+-----------
+
+Onboarding
+----------
+
+
+.. uml::
+
+   @startuml
+   title vFW/vFWCL and vDNS VNF Onboarding (R1)\nVFW/vFWCL and vDNS use the same flows but they are separate VNFs/Services
+   ONAP_User -> SDC : vFW_vDNS resource onboarding  (HEAT)
+   note right : vFWCL (vpg & vfw,vsn)\nvFW (vpg, vfw, vsn)\nvDNS (vpg, vlb,vdns) + DNSScaling (vdns)\
+   ONAP_User -> SDC : vFW_vDNS service onboarding
+   ONAP_User -> SDC : vFW_vDNS distribution
+   |||
+   SDC -> SO : artifact distribution\nNOTIFY,DOWNLOAD,DEPLOY_OK
+   SDC -> AAI : artifact distribution\nNOTIFY,DOWNLOAD,DEPLOY_OK
+   SDC -> SDNC : artifact distribution\nNOTIFY,DOWNLOAD,DEPLOY_OK
+   @enduml
+
+Instantiation
+-------------
+
+.. uml::
+
+ @startuml
+   title vFW vDNS Instantiation (R1)\nvFW and vDNS use the same flows but they are separate VNFs/Services
+   participant ONAP_User
+   participant Robot
+   Participant SDC
+   Participant VID
+   Participant SO
+   ONAP_User -> AAI : populate cloud inventory
+   note left of AAI:  manual via curl or POSTMAN
+   |||
+   ONAP_User -> VID : vFW_vDNS deployment
+   VID -> SDC : Lookup VNF artifacts
+   VID -> AAI : Lookup cloud locations, subscriber
+   VID -> SO : vFW_vDNS Service \nInstantiation\n(base modules)
+   SO -> AAI : inventory update
+   VID -> SO : vFW_vDNS VNF Instantiation\n(base modules)
+   note left of AAI : VFWCL is two VNFs in one service\nso VNF instantiate occurs twice
+   SO -> AAI : inventory update
+   ONAP_User -> SDNC : VNF API Preload VNF/VF data
+   VID -> SO : vFW_vDNS VF Instantiation\n(base modules)
+   SO -> AAI : inventory update
+   SO -> SDNC : Generic VNF API\n(assign)
+   SO -> Multi_VIM : vFW_vDNS Heat template, \nENV file, preload parameters
+   Multi_VIM -> CloudAPI : vFW_vDNS Heat template,\nENV file, preload parameters or
+   CloudAPI -> Hypervisor : vFW_vDNS Infrastructure instantiation
+   Hypervisor -> vFW_vDNS : Nova/Neutron Instantiation
+   Hypervisor -> CloudAPI : complete
+   CloudAPI -> Multi_VIM : complete
+   Multi_VIM -> SO : complete
+   note right : SO may poll for completion
+   SO -> SDNC:  Generic VNF API\n(activated)
+   note left : on failure from Openstack SO issues rollback to SDNC
+   SDNC -> AAI : L3 Network resource update
+   SO -> VID : complete
+   note right : VID will poll for completion
+   ONAP_User -> Robot : run Heat Bridge
+   Robot -> CloudAPI  :  retrieve cloud data 
+   Robot -> AAI :  Update with cloud data
+   |||
+   @enduml
+

diff --git a/docs/guides/onap-provider/index.rst b/docs/guides/onap-provider/index.rst
index 4978d3c..55702a1 100644 (file)
--- a/docs/guides/onap-provider/index.rst
+++ b/docs/guides/onap-provider/index.rst
@@ -4,8 +4,8 @@
 
 
 
 
 
 

-ONAP VNF Requirements and Guidelines
-=====================================
+VNF Requirements and Guidelines
+===============================

 
 The following includes guides and requirements are provided to
 describe tasks that an xNF provider of ONAP may need to properly
 
 The following includes guides and requirements are provided to
 describe tasks that an xNF provider of ONAP may need to properly

diff --git a/docs/guides/onap-provider/vnfvalidator.rst b/docs/guides/onap-provider/vnfvalidator.rst
index 5c0c032..193edc7 100644 (file)
--- a/docs/guides/onap-provider/vnfvalidator.rst
+++ b/docs/guides/onap-provider/vnfvalidator.rst
@@ -1,9 +1,9 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 
 VNF Validation Documentation
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 
 VNF Validation Documentation

-===========================
+============================

 
 .. toctree::
 
 .. toctree::

-   :maxdepth:2
+   :maxdepth: 2

 
    ../../../submodules/vvp/documentation.git/docs/index.rst
 
    ../../../submodules/vvp/documentation.git/docs/index.rst

diff --git a/docs/guides/onap-user/index.rst b/docs/guides/onap-user/index.rst
index aabc755..af9f6df 100644 (file)
--- a/docs/guides/onap-user/index.rst
+++ b/docs/guides/onap-user/index.rst
@@ -4,8 +4,8 @@
 
 
 
 
 
 

-ONAP User Guides
-================
+User Guides
+===========

 The following guides are provided to describe tasks that a user of
 ONAP may need to perform when integrating, deploying, and operating
 an instance of ONAP.
 The following guides are provided to describe tasks that a user of
 ONAP may need to perform when integrating, deploying, and operating
 an instance of ONAP.

diff --git a/docs/index.rst b/docs/index.rst
index 7129de8..9c69842 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -5,11 +5,10 @@
 ONAP Documentation
 ==================
 
 ONAP Documentation
 ==================
 

-.. note::
+.. caution::

    This version of documentation is created from the latest master branch of
    This version of documentation is created from the latest master branch of

-   source repositories and is not a stable release.
-
-   To get the current stable release use one of the following
+   source repositories and is not a stable release.  To get the current stable
+   release use one of the following

 
    * http://docs.onap.org
    * http://docs.onap.org/en/beijing
 
    * http://docs.onap.org
    * http://docs.onap.org/en/beijing


@@ -22,7 +21,6 @@ ONAP Documentation
    guides/onap-developer/index
    guides/onap-user/index
    guides/onap-provider/index
    guides/onap-developer/index
    guides/onap-user/index
    guides/onap-provider/index

-   use-cases/index

 
 
 
 
 
 

diff --git a/docs/release-notes.rst b/docs/release-notes.rst
index 00e9a11..8b9cc2c 100644 (file)
--- a/docs/release-notes.rst
+++ b/docs/release-notes.rst
@@ -1,4 +1,3 @@
-

 .. This work is licensed under a Creative Commons Attribution 4.0
    International License. http://creativecommons.org/licenses/by/4.0
    Copyright 2017 AT&T Intellectual Property.  All rights reserved.
 .. This work is licensed under a Creative Commons Attribution 4.0
    International License. http://creativecommons.org/licenses/by/4.0
    Copyright 2017 AT&T Intellectual Property.  All rights reserved.


@@ -8,6 +7,28 @@
 Release Notes
 =============
 
 Release Notes
 =============
 

+Version: 2.0.0
+--------------
+
+:Release Date: 2018-06-07
+
+
+**New Features**
+
+* Created a beijing branch referencing all repos providing documentation
+  for the beijing release.
+
+* Added tox environments and documentation for linkcheck and spellcheck buiders.
+
+* Verify jobs now include the html build in the archived log to make it
+  easier to review changes prior to merge.
+
+* Provided guidelines for document "code reviews" and
+  end of release work with multiple branches.
+
+* Added a template for a Virtual Netework Function
+
+**Other**

 
 Version: 1.0.0
 --------------
 
 Version: 1.0.0
 --------------

diff --git a/docs/release/index.rst b/docs/release/index.rst
index c5748cd..3139479 100644 (file)
--- a/docs/release/index.rst
+++ b/docs/release/index.rst
@@ -1,23 +1,26 @@
 .. This work is licensed under a Creative Commons Attribution 4.0
    International License. http://creativecommons.org/licenses/by/4.0
 
 .. This work is licensed under a Creative Commons Attribution 4.0
    International License. http://creativecommons.org/licenses/by/4.0
 

+.. contents::
+   :depth: 2
+

 .. index:: Release Notes
 
 .. index:: Release Notes
 

-Releases
-========
-This page is the draft ONAP Beijing Release Notes. The first release was
+Beijing Release Notes
+^^^^^^^^^^^^^^^^^^^^^
+This page is the ONAP Beijing Release Notes. The first release was

 Amsterdam and subsequent major release will be named using city names.
 
 * Release Name: Beijing
 * Release Version: 2.0.0
 Amsterdam and subsequent major release will be named using city names.
 
 * Release Name: Beijing
 * Release Version: 2.0.0

-* Release Date: May, 2018
+* Release Date: June 7, 2018

 
 
 Getting Started With ONAP
 
 
 Getting Started With ONAP

--------------------------
+=========================

 
 Summary
 
 Summary

-+++++++
+-------

 ONAP provides a comprehensive platform for real-time, policy-driven
 service orchestration and automation including virtual network functions and
 applications instantiation and configuration, but also physical network
 ONAP provides a comprehensive platform for real-time, policy-driven
 service orchestration and automation including virtual network functions and
 applications instantiation and configuration, but also physical network


@@ -30,7 +33,7 @@ for network automation-with an open standards focus-faster than any one
 product could on its own.
 
 Functionality
 product could on its own.
 
 Functionality

-+++++++++++++
+-------------

 **Portal** - a single, consistent user experience for both design timer
 and run time environments, based on the user’s role.
 
 **Portal** - a single, consistent user experience for both design timer
 and run time environments, based on the user’s role.
 


@@ -42,8 +45,8 @@ services, and products:
    repositories to define/simulate/certify system assets as well as their
    associated processes and policies.
 
    repositories to define/simulate/certify system assets as well as their
    associated processes and policies.
 

- - A VNF Software Development Kit (VNFSDK) with tools for VNF supplier
-   packaging and validation.
+ - A VNF Software Development Kit (VNFSDK) and VNF Validation Program (VVP)
+   with tools for VNF supplier packaging and validation.

 
  - Policy Creation (POLICY) deals with conditions, requirements,
    constraints, attributes, or needs that must be provided, maintained,
 
  - Policy Creation (POLICY) deals with conditions, requirements,
    constraints, attributes, or needs that must be provided, maintained,


@@ -52,6 +55,9 @@ services, and products:
  - Closed Loop Automation Management Platform (CLAMP) provides a method
    for designing and managing control loops.
 
  - Closed Loop Automation Management Platform (CLAMP) provides a method
    for designing and managing control loops.
 

+ - Optimization Framework (OOF) provides a policy-driven and model-driven
+   framework for creating optimization applications.
+

 **Runtime Framework** - The runtime execution framework executes the
 rules and policies distributed by the design and creation environment
 and Controllers that manage resources corresponding to their assigned
 **Runtime Framework** - The runtime execution framework executes the
 rules and policies distributed by the design and creation environment
 and Controllers that manage resources corresponding to their assigned


@@ -90,66 +96,39 @@ Detect -> Publish -> Respond:
 
  - Common Services - operational services for all ONAP components including
    activity logging, reporting, common data layer, access control, resiliency,
 
  - Common Services - operational services for all ONAP components including
    activity logging, reporting, common data layer, access control, resiliency,

-   and software lifecycle management.
+   multisite state coordination, credential/secret management and
+   software lifecycle management.
+
+**Microservices Support**
+
+ - ONAP Operation Manager (OOM) use kubernetes and Helm to manage ONAP
+   components.
+ - Microservices Bus (MSB) provides service registration/discovery,
+   external API gateway, internal API gateway, client software development kit
+   (SDK), and Swagger SDK.

 
 Project Specific Release Notes
 
 Project Specific Release Notes

-++++++++++++++++++++++++++++++
+==============================

 ONAP releases are specified by a list of project artifact
 versions in a :ref:`manifest<doc-release-manifest>`.
 ONAP releases are specified by a list of project artifact
 versions in a :ref:`manifest<doc-release-manifest>`.

+

 Each project provides detailed :ref:`release notes<doc-releaserepos>`
 and prepends to these if/when any updated versions the project team believes
 are compatible with a major release are made available.
 
 Each project provides detailed :ref:`release notes<doc-releaserepos>`
 and prepends to these if/when any updated versions the project team believes
 are compatible with a major release are made available.
 

-Platforms Requirements
-++++++++++++++++++++++
-ONAP Beijing Release has been tested on Linux OSs. Details are
-:ref:`available here <demo-installing-running-onap-requirements>`.
-
-

 .. index:: Download
 
 .. index:: Download
 

-Download & Install
-++++++++++++++++++
+Installation
+============

 There are 3 approaches to install ONAP:
 
 There are 3 approaches to install ONAP:
 

-* Full ONAP installation using Heat template
-* Advanced installation to install individual components
-* Experimental installation using Kubernetes
-
-Full ONAP installation using Heat template
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-From a complete demo solution perspective. This installs the whole ONAP,
-refer to :ref:`Setting Up ONAP <demo-installing-running-onap>`.
-
-Advanced installation to install individual components
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-From a developer perspective, ONAP can be installed component per component.
-For details, refer to :ref:`the installation procedure available for each
-component<index-setting-individual-components>`.
-The advanced installation procedure is recommended only for experienced
-developers who desire to focus their attention on a few components and who have
-a deep understanding of dependencies between components.
-This type of installation is not recommended to fully install ONAP.
-
-* The list of ports used by default within ONAP is documented in
-  `ONAP Service List <https://wiki.onap.org/display/DW/ONAP+Services+List>`_.
-
-* The ONAP Source Code is available through Gerrit at https://gerrit.onap.org
-  or Git at https://git.onap.org/.
-
-* ONAP is packaged within Docker and can be dowloaded from Docker Hub at
-  https://hub.docker.com/r/onap.
-
-Experimental installation using Kubernetes
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-From a complete demo solution perspective using Kubernetes. This installs the
-whole ONAP, refer to :ref:`ONAP Operations Manager -
-Quick Start Guide <onap-operations-manager-project>`.
+* :ref:`Installation using Kubernetes (aka OOM) <installing-onap-k8s>`. Recommended method.
+* :ref:`Installation using Heat template <installing-onap-heat>`.
+* :ref:`Advanced installation to install individual components <installing-onap-individual>`.

 
 Documentation
 
 Documentation

-+++++++++++++
-ONAP Beijing Release documentation is available :ref:`here <master_index>`.
-For Beijing this includes:
+=============
+ONAP Beijing Release provides multiple documents including the following:

 
  * A high level :ref:`architecture view<doc-architecture>` of how components
    relate to each other.
 
  * A high level :ref:`architecture view<doc-architecture>` of how components
    relate to each other.


@@ -164,35 +143,34 @@ For Beijing this includes:
    information on meeting plans and notes from committees, project teams and
    community events.
 
    information on meeting plans and notes from committees, project teams and
    community events.
 

-Usage
-+++++
-This section is intended to provide users on the usage of ONAP components.
+.. index:: Licensing

 
 

-Instructions on using the ONAP deployment including Robot, Portal, SDC and VID
-in the context of running (Onboarding, service creation, service deployment,
-VNF creation, VNF preload, VF Module creation and closed loop operations)
-the vFirewall sanity use case is documented
-in `Running the ONAP Demos
-<https://wiki.onap.org/display/DW/Running+the+ONAP+Demos>`_.
+Security Notes
+==============
+ONAP has adopted the `CII Best Practice Badge Program <https://bestpractices.coreinfrastructure.org/en>`_. The goal of the Beijing release is for all ONAP projects to be close to achieving a CII Passing badge.

 
 

-.. index:: Licensing
+- `Badging Requirements <https://github.com/coreinfrastructure/best-practices-badge#core-infrastructure-initiative-best-practices-badge>`_
+- `Badging Status for all ONAP projects <https://bestpractices.coreinfrastructure.org/en/projects?q=onap>`_
+
+Project specific details are in the :ref:`release notes<doc-releaserepos>`
+for each project.

 
 Licenses
 
 Licenses

-++++++++
+========

 ONAP Source Code is licensed under the `Apache Version 2 License
 <http://www.apache.org/licenses/LICENSE-2.0>`_.
 ONAP Documentation is licensed under the `Creative Commons Attribution 4.0
 International License <http://creativecommons.org/licenses/by/4.0>`_.
 
 Known Issues and Limitations
 ONAP Source Code is licensed under the `Apache Version 2 License
 <http://www.apache.org/licenses/LICENSE-2.0>`_.
 ONAP Documentation is licensed under the `Creative Commons Attribution 4.0
 International License <http://creativecommons.org/licenses/by/4.0>`_.
 
 Known Issues and Limitations

-++++++++++++++++++++++++++++
+============================

 Known Issues and limitations are documented in each
 :ref:`project Release Notes <doc-releaserepos>`.
 
 .. index:: Reporting Bugs
 
 How to Report a Bug
 Known Issues and limitations are documented in each
 :ref:`project Release Notes <doc-releaserepos>`.
 
 .. index:: Reporting Bugs
 
 How to Report a Bug

-+++++++++++++++++++
+===================

 There are 2 ways to report a bug in ONAP.
 
  * In case you are familiar within ONAP, you can directly report a bug by
 There are 2 ways to report a bug in ONAP.
 
  * In case you are familiar within ONAP, you can directly report a bug by


@@ -203,9 +181,9 @@ There are 2 ways to report a bug in ONAP.
    `Ask question <https://wiki.onap.org/display/DW/questions/all>`_.
    You will need a Linux Foundation ID to login and post your question.
    Get a Linux Foundation Identity using this
    `Ask question <https://wiki.onap.org/display/DW/questions/all>`_.
    You will need a Linux Foundation ID to login and post your question.
    Get a Linux Foundation Identity using this

-   `quick procedure <https://wiki.onap.org/display/DW/Joining+the+Community>`_.
+   `quick procedure <https://wiki.onap.org/display/DW/Joining+the+ONAP+Technical+Community#JoiningtheONAPTechnicalCommunity-WhereDoIStart?>`_.

 
 

-You may consider these `recommendations <https://wiki.onap.org/display/DW/Tracking+Issues+with+JIRA#TrackingIssueswithJIRA-RecommendationsforwrittingProperJIRAIssue>`_ to elaborate the issue you are facing.
+To properly report a bug in Jira, you may want to consider these `recommendations <https://wiki.onap.org/display/DW/Tracking+Issues+with+JIRA#TrackingIssueswithJIRA-RecommendationsforwrittingProperJIRAIssue>`_ to elaborate the issue you are facing.

 
 
 .. Include files referenced by link in the toctree as hidden
 
 
 .. Include files referenced by link in the toctree as hidden

diff --git a/docs/release/release-manifest.rst b/docs/release/release-manifest.rst
index bb08880..5778d8e 100644 (file)
--- a/docs/release/release-manifest.rst
+++ b/docs/release/release-manifest.rst
@@ -2,6 +2,9 @@
    International License. http://creativecommons.org/licenses/by/4.0
    Copyright 2017 AT&T Intellectual Property.  All rights reserved.
 
    International License. http://creativecommons.org/licenses/by/4.0
    Copyright 2017 AT&T Intellectual Property.  All rights reserved.
 

+.. contents::
+   :depth: 3
+

 .. index:: Release Manifest
 
 .. _doc-release-manifest:
 .. index:: Release Manifest
 
 .. _doc-release-manifest:


@@ -9,19 +12,16 @@
 Release Manifest
 ----------------
 
 Release Manifest
 ----------------
 

-
-Nexus Artifacts nexus.onap.org
-++++++++++++++++++++++++++++++
-
+Nexus Released Artifacts nexus.onap.org
++++++++++++++++++++++++++++++++++++++++

 
 .. csv-table::
    :align: left
    :header-rows: 1
    :file:  ../submodules/integration.git/version-manifest/src/main/resources/java-manifest.csv
 
 
 .. csv-table::
    :align: left
    :header-rows: 1
    :file:  ../submodules/integration.git/version-manifest/src/main/resources/java-manifest.csv
 

-
-Docker Images  nexus3.onap.org
-++++++++++++++++++++++++++++++
+Docker Released Images  nexus3.onap.org
++++++++++++++++++++++++++++++++++++++++

 
 .. csv-table::
    :align: left
 
 .. csv-table::
    :align: left

diff --git a/docs/release/releaserepos.rst b/docs/release/releaserepos.rst
index 71a1630..4b4586d 100644 (file)
--- a/docs/release/releaserepos.rst
+++ b/docs/release/releaserepos.rst
@@ -1,4 +1,5 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. This work is licensed under a Creative Commons Attribution
+.. 4.0 International License.

 .. http://creativecommons.org/licenses/by/4.0
 .. Copyright 2017 AT&T Intellectual Property.  All rights reserved.
 
 .. http://creativecommons.org/licenses/by/4.0
 .. Copyright 2017 AT&T Intellectual Property.  All rights reserved.
 


@@ -7,7 +8,8 @@
 
 Project Specific Release Notes
 ++++++++++++++++++++++++++++++
 
 Project Specific Release Notes
 ++++++++++++++++++++++++++++++

-Each project is listed below followed by the Gerrit repositories in which there are release notes.
+Each project is listed below followed by the Gerrit repositories in which
+there are release notes.

 
 Active and Available Inventory
 ------------------------------
 
 Active and Available Inventory
 ------------------------------


@@ -16,7 +18,16 @@ Active and Available Inventory
    :maxdepth: 1
    :titlesonly:
 
    :maxdepth: 1
    :titlesonly:
 

-   aai/aai-common<../submodules/aai/aai-common.git/docs/release-notes.rst>
+   aai<../submodules/aai/aai-common.git/docs/release-notes.rst>
+
+Application Authorization Framework
+-----------------------------------
+
+.. toctree::
+   :maxdepth: 1
+   :titlesonly:
+
+   aaf<../submodules/aaf/authz.git/docs/sections/release-notes.rst>

 
 Application Controller
 ----------------------
 
 Application Controller
 ----------------------


@@ -34,26 +45,26 @@ Common Controller Software Development Kit
    :maxdepth: 1
    :titlesonly:
 
    :maxdepth: 1
    :titlesonly:
 

-   ccsdk/distribution<../submodules/ccsdk/distribution.git/docs/release-notes.rst>
-   ccsdk/platform/plugins<../submodules/ccsdk/platform/plugins.git/docs/release-notes.rst>
+   ccsdk<../submodules/ccsdk/distribution.git/docs/release-notes.rst>

 
 

-Closed Loop Automation Platform
--------------------------------
+Command Line Interface
+----------------------

 
 .. toctree::
    :maxdepth: 1
    :titlesonly:
 
 
 .. toctree::
    :maxdepth: 1
    :titlesonly:
 

-   clamp<../submodules/clamp.git/docs/release-notes.rst>
+   cli<../submodules/cli.git/docs/release-notes.rst>

 
 

-ONAP Command Line Interface
----------------------------
+Closed Loop Automation Platform
+-------------------------------

 
 .. toctree::
    :maxdepth: 1
    :titlesonly:
 
 
 .. toctree::
    :maxdepth: 1
    :titlesonly:
 

-   cli<../submodules/cli.git/docs/release-notes.rst>
+   clamp<../submodules/clamp.git/docs/release-notes.rst>
+

 
 Data Collection, Analysis, and Events
 -------------------------------------
 
 Data Collection, Analysis, and Events
 -------------------------------------


@@ -80,10 +91,10 @@ Data Management as a Platform Message Router
    :maxdepth: 1
    :titlesonly:
 
    :maxdepth: 1
    :titlesonly:
 

-   dmaap/messagerouter/messageservice<../submodules/dmaap/messagerouter/messageservice.git/docs/release-notes/release-notes.rst>
+   dmaap<../submodules/dmaap/messagerouter/messageservice.git/docs/release-notes/release-notes.rst>

 
 External API / NBI
 
 External API / NBI

-------
+------------------

 
 .. toctree::
    :maxdepth: 1
 
 .. toctree::
    :maxdepth: 1


@@ -98,10 +109,19 @@ Holmes
    :maxdepth: 1
    :titlesonly:
 
    :maxdepth: 1
    :titlesonly:
 

-   holmes/rule-management<../submodules/holmes/rule-management.git/docs/release-notes.rst>
+   holmes<../submodules/holmes/rule-management.git/docs/release-notes.rst>

 
 

-Logging Enhancements Project
-----------------------------
+Integration
+-----------
+
+.. toctree::
+   :maxdepth: 1
+   :titlesonly:
+
+   integration<../submodules/integration.git/docs/release-notes.rst>
+
+Logging Analytics
+-----------------

 
 .. toctree::
    :maxdepth: 1
 
 .. toctree::
    :maxdepth: 1


@@ -126,7 +146,7 @@ Micro Services Bus
    :maxdepth: 1
    :titlesonly:
 
    :maxdepth: 1
    :titlesonly:
 

-   msb/apigateway<../submodules/msb/apigateway.git/docs/release-notes.rst>
+   msb<../submodules/msb/apigateway.git/docs/release-notes.rst>

 
 MultiVIM Cloud
 --------------
 
 MultiVIM Cloud
 --------------


@@ -146,15 +166,23 @@ Music
 
    music<../submodules/music.git/docs/release-notes.rst>
 
 
    music<../submodules/music.git/docs/release-notes.rst>
 

-
-ONAP Operations Manager (experimental)
---------------------------------------
+ONAP Operations Manager
+-----------------------

 
 .. toctree::
    :maxdepth: 2
    :titlesonly:
 
 
 .. toctree::
    :maxdepth: 2
    :titlesonly:
 

-   OOM<../submodules/oom.git/docs/release-notes.rst>
+   oom<../submodules/oom.git/docs/release-notes.rst>
+
+Optimization Framework
+----------------------
+
+.. toctree::
+   :maxdepth: 1
+   :titlesonly:
+
+   optf<../submodules/optf/osdf.git/docs/sections/release-notes.rst>

 
 Policy Framework
 ----------------
 
 Policy Framework
 ----------------


@@ -163,7 +191,7 @@ Policy Framework
    :maxdepth: 1
    :titlesonly:
 
    :maxdepth: 1
    :titlesonly:
 

-   policy/engine<../submodules/policy/engine.git/docs/release-notes.rst>
+   policy<../submodules/policy/engine.git/docs/release-notes.rst>

 
 Portal Platform
 ---------------
 
 Portal Platform
 ---------------


@@ -182,29 +210,27 @@ Service Design & Creation
    :titlesonly:
 
    sdc<../submodules/sdc.git/docs/release-notes.rst>
    :titlesonly:
 
    sdc<../submodules/sdc.git/docs/release-notes.rst>

-   sdc/sdc-workflow-designer<../submodules/sdc/sdc-workflow-designer.git/docs/release-notes.rst>

 
 

-Software Defined Network Controller
------------------------------------
+Service Orchestration
+---------------------

 
 .. toctree::
    :maxdepth: 1
    :titlesonly:
 
 
 .. toctree::
    :maxdepth: 1
    :titlesonly:
 

-   sdnc/oam<../submodules/sdnc/oam.git/docs/release-notes.rst>
+   so<../submodules/so.git/docs/release-notes.rst>

 
 

-Service Orchestration
----------------------
+Software Defined Network Controller
+-----------------------------------

 
 .. toctree::
    :maxdepth: 1
    :titlesonly:
 
 
 .. toctree::
    :maxdepth: 1
    :titlesonly:
 

-   so<../submodules/so.git/docs/release-notes.rst>
-   so/libs<../submodules/so/libs.git/docs/release-notes.rst>
+   sdnc<../submodules/sdnc/oam.git/docs/release-notes.rst>

 
 

-ONAP Use Case User Interface
-----------------------------
+Use Case User Interface
+-----------------------

 
 .. toctree::
    :maxdepth: 1
 
 .. toctree::
    :maxdepth: 1


@@ -219,7 +245,7 @@ Virtual Function Controller
    :maxdepth: 1
    :titlesonly:
 
    :maxdepth: 1
    :titlesonly:
 

-   vfc/nfvo/lcm<../submodules/vfc/nfvo/lcm.git/docs/release-notes.rst>
+   vfc<../submodules/vfc/nfvo/lcm.git/docs/release-notes.rst>

 
 Virtual Infrastructure Deployment
 ---------------------------------
 
 Virtual Infrastructure Deployment
 ---------------------------------


@@ -237,9 +263,7 @@ VNF Requirements
    :maxdepth: 1
    :titlesonly:
 
    :maxdepth: 1
    :titlesonly:
 

-   vnfrqts/requirements<../submodules/vnfrqts/requirements.git/docs/release-notes.rst>
-   vnfrqts/testcases<../submodules/vnfrqts/testcases.git/docs/release-notes.rst>
-   vnfrqts/usecases<../submodules/vnfrqts/usecases.git/docs/release-notes.rst>
+   vnfrqts<../submodules/vnfrqts/requirements.git/docs/release-notes.rst>

 
 VNF Software Development Kit
 ----------------------------
 
 VNF Software Development Kit
 ----------------------------


@@ -248,7 +272,7 @@ VNF Software Development Kit
    :maxdepth: 1
    :titlesonly:
 
    :maxdepth: 1
    :titlesonly:
 

-   vnfsdk/model<../submodules/vnfsdk/model.git/docs/release-notes.rst>
+   vnfsdk<../submodules/vnfsdk/model.git/docs/release-notes.rst>

 
 VNF Validation Project
 ----------------------
 
 VNF Validation Project
 ----------------------


@@ -256,7 +280,7 @@ VNF Validation Project
    :maxdepth: 1
    :titlesonly:
 
    :maxdepth: 1
    :titlesonly:
 

-   vvp/documentation<../submodules/vvp/documentation.git/docs/release-notes.rst>
+   vvp<../submodules/vvp/documentation.git/docs/release-notes.rst>

 
 
 .. Not in / not used this release
 
 
 .. Not in / not used this release