X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Frelease%2Findex.rst;h=ae74f412cf1090a517474f3ef81ce946fde29f6a;hb=7b727a59bb7a41a2b477205ca2d57c12f236cdc5;hp=22248483845eb190becadbc2ae5f259191902660;hpb=0172ec27a6e54ebdd0f7ded1478ff79b28ed10d3;p=doc.git diff --git a/docs/release/index.rst b/docs/release/index.rst index 222484838..ae74f412c 100644 --- a/docs/release/index.rst +++ b/docs/release/index.rst @@ -1,6 +1,8 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. http://creativecommons.org/licenses/by/4.0 +.. index:: Release Notes + Releases ======== This page is the ONAP Amsterdam Release Notes. The first release is @@ -11,8 +13,8 @@ Amsterdam and subsequent major release will be named using city names. * Release Date: November 16, 2017 -Amsterdam Release ------------------ +Getting Started With Amsterdam +------------------------------ Summary +++++++ @@ -27,10 +29,10 @@ product could on its own. Functionality +++++++++++++ -*Portal* - a single, consistent user experience for both design timer +**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 +**Design Time Framework** - a comprehensive development environment with tools, techniques, and repositories for defining/describing resources, services, and products: @@ -46,9 +48,9 @@ services, and products: and/or enforced. - Closed Loop Automation Management Platform (CLAMP) provides a method - for designing and managing control loops.** + for designing and managing control loops. -*Runtime Framework* - The runtime execution framework executes the +**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: @@ -71,7 +73,7 @@ controlled domain: system’s resources, services, products and their relationships with each other. -*Closed-Loop Automation* -- Design -> Create -> Collect -> Analyze > +**Closed-Loop Automation** -- Design -> Create -> Collect -> Analyze > Detect -> Publish -> Respond: - Data Collection, Analytics and Events (DCAE) collects performance, @@ -93,11 +95,38 @@ Each project provides detailed :ref:`release notes` 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 Amsterdam Release has been tested on Linux OSs. Details are `available here `_. -Supported Platforms -+++++++++++++++++++ -ONAP Amsterdam Release has been tested on Ubuntu 16.04 and thus is -the only OS supported. + +.. index:: Download + +Download & Install +++++++++++++++++++ +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 `. + +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`. +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 `_. +* 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 `ONAP Operations Manager - Quick Start Guide `_. Documentation +++++++++++++ @@ -117,60 +146,46 @@ For Amsterdam 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. -Known Issues and Limitations -++++++++++++++++++++++++++++ -Known Issues and limitations are documented in each project Release Notes. +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 `_. -Refer to :ref:`release notes ` for each project. +.. index:: Licensing Licenses ++++++++ ONAP Amsterdam Source Code is licensed under the `Apache Version 2 License `_. ONAP Amsterdam Documentation is licensed under the `Creative Commons Attribution 4.0 International License `_. +Known Issues and Limitations +++++++++++++++++++++++++++++ +Known Issues and limitations are documented in each :ref:`project Release Notes `. + +.. 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 creating a Jira issue - at `ONAP Jira `_. - - * 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 `_ to elaborate the issue you are facing and this `guideline `_ to register into the ONAP Discuss mailing list. - - -Download -++++++++ - -* 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 . + * In case you are familiar within ONAP, you can directly report a bug by creating a Jira issue at `ONAP Jira `_. + * If you don't know you are facing a bug or have a question, post your question into the `Ask question `_. + You will need a Linux Foundation ID to login and post your question. Get a Linux Foundation Identity using this `quick procedure `_. -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 `. +You may consider these `recommendations `_ to elaborate the issue you are facing. -* From a developer perspective. ONAP is installed component per component. - Each - component :ref:`installation is listed in`. - The list of ports used by default within ONAP is documented - in `ONAP Service List `_. -Usage -+++++ -This section is intended to provide users on the usage of ONAP components. +.. Include files referenced by link in the toctree as hidden -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 `_. +.. toctree:: + :hidden: + release-manifest.rst + releaserepos.rst + repolist.rst