summaryrefslogtreecommitdiffstats
path: root/docs/release
diff options
context:
space:
mode:
Diffstat (limited to 'docs/release')
-rw-r--r--docs/release/index.rst118
-rw-r--r--docs/release/release-manifest.rst14
-rw-r--r--docs/release/releaserepos.rst100
3 files changed, 117 insertions, 115 deletions
diff --git a/docs/release/index.rst b/docs/release/index.rst
index c5748cdfe..3139479dc 100644
--- 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
+.. contents::
+ :depth: 2
+
.. 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
-* Release Date: May, 2018
+* Release Date: June 7, 2018
Getting Started With ONAP
--------------------------
+=========================
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
@@ -30,7 +33,7 @@ for network automation-with an open standards focus-faster than any one
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.
@@ -42,8 +45,8 @@ services, and products:
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,
@@ -52,6 +55,9 @@ services, and products:
- 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
@@ -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,
- 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
-++++++++++++++++++++++++++++++
+==============================
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.
-Platforms Requirements
-++++++++++++++++++++++
-ONAP Beijing Release has been tested on Linux OSs. Details are
-:ref:`available here <demo-installing-running-onap-requirements>`.
-
-
.. index:: Download
-Download & Install
-++++++++++++++++++
+Installation
+============
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
-+++++++++++++
-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.
@@ -164,35 +143,34 @@ For Beijing this includes:
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
-++++++++
+========
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
-+++++++++++++++++++
+===================
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
- `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
diff --git a/docs/release/release-manifest.rst b/docs/release/release-manifest.rst
index bb08880f5..5778d8e02 100644
--- 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.
+.. contents::
+ :depth: 3
+
.. index:: Release Manifest
.. _doc-release-manifest:
@@ -9,19 +12,16 @@
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
-
-Docker Images nexus3.onap.org
-++++++++++++++++++++++++++++++
+Docker Released Images nexus3.onap.org
++++++++++++++++++++++++++++++++++++++++
.. csv-table::
:align: left
diff --git a/docs/release/releaserepos.rst b/docs/release/releaserepos.rst
index 71a163073..4b4586d49 100644
--- 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.
@@ -7,7 +8,8 @@
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
------------------------------
@@ -16,7 +18,16 @@ Active and Available Inventory
: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
----------------------
@@ -34,26 +45,26 @@ Common Controller Software Development Kit
: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:
- 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:
- cli<../submodules/cli.git/docs/release-notes.rst>
+ clamp<../submodules/clamp.git/docs/release-notes.rst>
+
Data Collection, Analysis, and Events
-------------------------------------
@@ -80,10 +91,10 @@ Data Management as a Platform Message Router
: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
-------
+------------------
.. toctree::
:maxdepth: 1
@@ -98,10 +109,19 @@ Holmes
: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
@@ -126,7 +146,7 @@ Micro Services Bus
:maxdepth: 1
:titlesonly:
- msb/apigateway<../submodules/msb/apigateway.git/docs/release-notes.rst>
+ msb<../submodules/msb/apigateway.git/docs/release-notes.rst>
MultiVIM Cloud
--------------
@@ -146,15 +166,23 @@ Music
music<../submodules/music.git/docs/release-notes.rst>
-
-ONAP Operations Manager (experimental)
---------------------------------------
+ONAP Operations Manager
+-----------------------
.. 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
----------------
@@ -163,7 +191,7 @@ Policy Framework
:maxdepth: 1
:titlesonly:
- policy/engine<../submodules/policy/engine.git/docs/release-notes.rst>
+ policy<../submodules/policy/engine.git/docs/release-notes.rst>
Portal Platform
---------------
@@ -182,29 +210,27 @@ Service Design & Creation
: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:
- 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:
- 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
@@ -219,7 +245,7 @@ Virtual Function Controller
: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
---------------------------------
@@ -237,9 +263,7 @@ VNF Requirements
: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
----------------------------
@@ -248,7 +272,7 @@ VNF Software Development Kit
: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
----------------------
@@ -256,7 +280,7 @@ VNF Validation Project
: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