diff options
| -rw-r--r-- | docs/release/index.rst | 93 |
1 files changed, 59 insertions, 34 deletions
diff --git a/docs/release/index.rst b/docs/release/index.rst index 1e4804167..16ab8b9c6 100644 --- a/docs/release/index.rst +++ b/docs/release/index.rst @@ -5,22 +5,23 @@ Releases ======== -This page is the ONAP Amsterdam Release Notes. The first release is +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: Amsterdam +* Release Name: Beijing * Release Version: 1.0.0 -* Release Date: November 16, 2017 +* Release Date: May 24, 2018 -Getting Started With Amsterdam ------------------------------- +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 functions configuration. +service orchestration and automation including virtual network functions and +applications instantiation and configuration, but also physical network +functions configuration. ONAP will enable software, network, IT and cloud providers and developers to rapidly automate new services and support complete life cycle management. By unifying member resources, ONAP will accelerate the development of a @@ -56,19 +57,21 @@ 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 BPMN 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. SO is especially able to drive any OpenStack-based cloud platform. + - Service Orchestrator (SO) executes the specified BPMN 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. SO is especially able to drive + any OpenStack-based cloud platform. - - Software Defined Network Controller (SDNC) executes network configuration for - cloud computing resources and network. + - Software Defined Network Controller (SDNC) executes network configuration + for cloud computing resources and network. - - Application Controller (APPC) executes Virtual Network Functions (VNF) configurations and lifecycle - management operations. + - Application Controller (APPC) executes Virtual Network Functions (VNF) + configurations and lifecycle management operations. - - Virtual Function Controller (VF-C) is responsible for lifecycle management of virtual network functions - and network services based on VNF using VNF Manager. + - Virtual Function Controller (VF-C) is responsible for lifecycle management + of virtual network functions and network services based on VNF using + VNF Manager. - Active and Available Inventory (A&AI) provides real-time views of a system’s resources, services, products and their relationships with each @@ -99,7 +102,8 @@ are compatible with a major release are made available. Platforms Requirements ++++++++++++++++++++++ -ONAP Amsterdam Release has been tested on Linux OSs. Details are :ref:`available here <demo-installing-running-onap-requirements>`. +ONAP Beijing Release has been tested on Linux OSs. Details are +:ref:`available here <demo-installing-running-onap-requirements>`. .. index:: Download @@ -114,26 +118,38 @@ There are 3 approaches to install ONAP: 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>`. +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. +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. +* 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>`. +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>`. Documentation +++++++++++++ -ONAP Amsterdam Release documentation is available :ref:`here <master_index>`. -For Amsterdam this includes: +ONAP Beijing Release documentation is available :ref:`here <master_index>`. +For Beijing this includes: * A high level :ref:`architecture view<doc-architecture>` of how components relate to each other. @@ -156,18 +172,22 @@ 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>`_. +in `Running the ONAP Demos +<https://wiki.onap.org/display/DW/Running+the+ONAP+Demos>`_. .. index:: Licensing Licenses ++++++++ -ONAP Amsterdam Source Code is licensed under the `Apache Version 2 License <http://www.apache.org/licenses/LICENSE-2.0>`_. -ONAP Amsterdam Documentation is licensed under the `Creative Commons Attribution 4.0 International License <http://creativecommons.org/licenses/by/4.0>`_. +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>`. +Known Issues and limitations are documented in each +:ref:`project Release Notes <doc-releaserepos>`. .. index:: Reporting Bugs @@ -175,10 +195,15 @@ 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, post your question into the `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>`_. + * If you don't know you are facing a bug or have a question, post your + question into the + `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>`_. You may consider these `recommendations <https://wiki.onap.org/display/DW/Tracking+Issues+with+JIRA#TrackingIssueswithJIRA-RecommendationsforwrittingProperJIRAIssue>`_ to elaborate the issue you are facing. |