X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Frelease%2Findex.rst;h=ae74f412cf1090a517474f3ef81ce946fde29f6a;hb=7b727a59bb7a41a2b477205ca2d57c12f236cdc5;hp=8518a713807c8af60266b280c2380cd6c09c3475;hpb=80455a5d969d7ca773c9c5a9bba1f19986071574;p=doc.git diff --git a/docs/release/index.rst b/docs/release/index.rst index 8518a7138..ae74f412c 100644 --- a/docs/release/index.rst +++ b/docs/release/index.rst @@ -1,77 +1,191 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. http://creativecommons.org/licenses/by/4.0 +.. index:: Release Notes + Releases ======== -ONAP is developed and released around 6 month cycles. After an initial -major release, additional stable point releases may be created. 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 +* Release Date: November 16, 2017 -Amsterdam Release ------------------ +Getting Started With Amsterdam +------------------------------ Summary +++++++ +ONAP provides a comprehensive platform for real-time, policy-driven +orchestration and automation of physical and virtual network functions +that 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 +vibrant ecosystem around a globally shared architecture and implementation +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. + +**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 ++++++++++++++++++++++++++++++ -Major and stable point releases are specified by a list of project artifact +ONAP releases are specified by a list of project artifact versions in a :ref:`manifest`. 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 -+++++++++++++++++++ +.. 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 +++++++++++++ -Release controlled documentation is available :ref:`here `. +ONAP Amsterdam Release documentation is available :ref:`here `. For Amsterdam this includes: -* A high level :ref:`architecture view` of how components - relate to each other. + * A high level :ref:`architecture view` of how components + relate to each other. + + * A collection of documentation provided + by :ref:`each project `. + + * Application Programming Interface + Reference :ref:`available here `. + + * The `developer wiki `_ remains a good source of + information on meeting plans and notes from committees, project teams and + community events. -* A collection of documentation provided - by :ref:`each project `. +Usage ++++++ +This section is intended to provide users on the usage of ONAP components. -* Application Programming Interface Reference :ref:`available here ` +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 `_. -* The `developer wiki `_ remains a good source of - information on meeting plans and notes from committees, project teams, - community events and general, release independent information about - ONAP. Release dependent information is being migrated from the wiki to - gerrit source control. See the doc - project :ref:`release notes ` for current status. +.. 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 ++++++++++++++++++++++++++++ -TBP overall / general statement -See :ref:`release notes ` for each project. - -License -+++++++ +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, 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 `_. -Download and Use -++++++++++++++++ +You may consider these `recommendations `_ to elaborate the issue you are facing. -* Source Code in Gerrit https://gerrit.onap.org -* Artifacts in Nexus / Docker Hub +.. Include files referenced by link in the toctree as hidden -* Platform :ref:`Demo `. +.. toctree:: + :hidden: + release-manifest.rst + releaserepos.rst + repolist.rst