summaryrefslogtreecommitdiffstats
path: root/docs/release/index.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/release/index.rst')
-rw-r--r--docs/release/index.rst102
1 files changed, 86 insertions, 16 deletions
diff --git a/docs/release/index.rst b/docs/release/index.rst
index cdda8734c..222484838 100644
--- a/docs/release/index.rst
+++ b/docs/release/index.rst
@@ -3,7 +3,8 @@
Releases
========
-This page is the ONAP Amsterdam Release Notes. The first release is Amsterdam and subsequent major release will be named using city names.
+This page is the ONAP Amsterdam Release Notes. The first release is
+Amsterdam and subsequent major release will be named using city names.
* Release Name: Amsterdam
* Release Version: 1.0.0
@@ -26,7 +27,63 @@ 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.
+*Design Time Framework* - a comprehensive development environment with
+tools, techniques, and repositories for defining/describing resources,
+services, and products:
+
+ - Service Design and Creation (SDC) provides tools, techniques, and
+ 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.
+
+ - Policy Creation (POLICY) deals with conditions, requirements,
+ constraints, attributes, or needs that must be provided, maintained,
+ and/or enforced.
+
+ - Closed Loop Automation Management Platform (CLAMP) provides a method
+ for designing and managing control loops.**
+
+*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
+controlled domain:
+
+ - Service Orchestrator (SO) executes the specified processes and automates
+ sequences of activities, tasks, rules and policies needed for on-demand
+ creation, modification or removal of network, application or infrastructure
+ services and resources.
+
+ - Software Defined Network Controller (SDNC) network configuration of
+ cloud computing resources.
+
+ - Application Controller (APPC) Application resources.
+
+ - Virtual Function Controller (VF-C) provides an ETSI NFV compliant NFV-O
+ functions, and is responsible for life cycle management of virtual services
+ and the associated physical COTS server infrastructure.
+
+ - Active and Available Inventory (A&AI) provides real-time views of a
+ system’s resources, services, products and their relationships with each
+ other.
+
+*Closed-Loop Automation* -- Design -> Create -> Collect -> Analyze >
+Detect -> Publish -> Respond:
+
+ - Data Collection, Analytics and Events (DCAE) collects performance,
+ usage, and configuration data and publishes information to policy,
+ orchestration, and the data lake.
+
+ - “Holmes” provides alarm correlation and analysis for Telecom cloud
+ infrastructure and services, including hosts, vims, VNFs and NSs
+
+ - Common Services - operational services for all ONAP components including
+ activity logging, reporting, common data layer, access control, resiliency,
+ and software lifecycle management.
Project Specific Release Notes
++++++++++++++++++++++++++++++
@@ -39,24 +96,26 @@ are compatible with a major release are made available.
Supported Platforms
+++++++++++++++++++
-ONAP Amsterdam Release has been tested on Ubuntu 16.04 and thus is the only OS supported.
+ONAP Amsterdam Release has been tested on Ubuntu 16.04 and thus is
+the only OS supported.
Documentation
+++++++++++++
ONAP Amsterdam Release documentation is available :ref:`here <master_index>`.
For Amsterdam this includes:
-* 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.
-* A collection of documentation provided
- by :ref:`each project <doc_onap-developer_guide_projects>`.
+ * A collection of documentation provided
+ by :ref:`each project <doc_onap-developer_guide_projects>`.
-* Application Programming Interface Reference :ref:`available here <doc-apiref>`.
+ * Application Programming Interface
+ Reference :ref:`available here <doc-apiref>`.
-* The `developer wiki <http://wiki.onap.org>`_ remains a good source of
- information on meeting plans and notes from committees, project teams and
- community events.
+ * The `developer wiki <http://wiki.onap.org>`_ remains a good source of
+ information on meeting plans and notes from committees, project teams and
+ community events.
Known Issues and Limitations
@@ -74,9 +133,12 @@ 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 creating a Jira issue at `ONAP Jira <https://jira.onap.org>`_.
+ * In case you are familiar within ONAP, you can directly
+ report a bug by creating a Jira issue
+ at `ONAP Jira <https://jira.onap.org>`_.
-If you don't know you are facing a bug or have a question, email the ONAP Discuss mailing list at onap-discuss@lists.onap.org .
+ * If you don't know you are facing a bug or have a question, email
+ the ONAP Discuss mailing list at onap-discuss@lists.onap.org .
You may consider these `recommendations <https://wiki.onap.org/display/DW/Tracking+Issues+with+JIRA#TrackingIssueswithJIRA-RecommendationsforwrittingProperJIRAIssue>`_ to elaborate the issue you are facing and this `guideline <https://wiki.onap.org/display/DW/Mailing+Lists>`_ to register into the ONAP Discuss mailing list.
@@ -93,14 +155,22 @@ Install
+++++++
There are 2 approaches to install ONAP.
-* From a complete demo solution perspective. This installs the whole ONAP, refer to :ref:`Setting Up ONAP <demo-installing-running-onap>`.
+* From a complete demo solution perspective. This installs the whole ONAP,
+ refer to :ref:`Setting Up ONAP <demo-installing-running-onap>`.
-* From a developer perspective. ONAP is installed component per component. Each component :ref:`installation is listed in<doc_onap-developer_guide_projects>`.
-The list of ports used by default within ONAP is documented in `ONAP Service List <https://wiki.onap.org/display/DW/ONAP+Services+List>`_.
+* From a developer perspective. ONAP is installed component per component.
+ Each
+ component :ref:`installation is listed in<doc_onap-developer_guide_projects>`.
+ The list of ports used by default within ONAP is documented
+ in `ONAP Service List <https://wiki.onap.org/display/DW/ONAP+Services+List>`_.
Usage
+++++
This section is intended to provide users on the usage of ONAP components.
-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>`_.
+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>`_.