X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Frelease%2Findex.rst;h=a60eac5d0eb8990f000a32754badf6dc1af08226;hb=9ef206024451107fb0687a518e0a42dcfb20e6c3;hp=03ffc1f334758289ef8844743c1b3a65c06421ba;hpb=a9d6a44c8795e62f0c2f154960c470cf600f9270;p=doc.git diff --git a/docs/release/index.rst b/docs/release/index.rst index 03ffc1f33..a60eac5d0 100644 --- a/docs/release/index.rst +++ b/docs/release/index.rst @@ -1,36 +1,192 @@ -.. 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 +.. contents:: + :depth: 2 -Release -======= +.. index:: Release Notes -Overview of use cases, installation, release notes, etc. +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: June 7, 2018 -Architecture ------------- +Getting Started With ONAP +========================== -Use Cases ---------- +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. +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 +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. -Tutorials ---------- +**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) and VNF Validation Program (VVP) with tools for VNF supplier + packaging and validation. -Release Notes -------------- + - Policy Creation (POLICY) deals with conditions, requirements, + constraints, attributes, or needs that must be provided, maintained, + and/or enforced. -Projects Providing Documentation --------------------------------- + - Closed Loop Automation Management Platform (CLAMP) provides a method + for designing and managing control loops. -.. toctree:: - :maxdepth: 1 + - Optimization Framework (OOF) provides a policy-driven and model-driven framework + for creating optimization applications. - repolist.rst +**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 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. + + - 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. + + - 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 events, performance, + usage and publishes information to policy that executes the rules to perform + closed loop actions. + + - Holmes provides alarm correlation and analysis for Telecom cloud + infrastructure and services, including servers, cloud infrastructure, + VNFs and Network Services. + + - Common Services - operational services for all ONAP components including + activity logging, reporting, common data layer, access control, resiliency, 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`. + +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. + +.. index:: Download + +Download & Install +================== +There are 3 approaches to install ONAP: + +* Installation using Kubernetes (aka OOM). Recommended method +* Installation using Heat template +* Advanced installation to install individual components +Documentation +============= +ONAP Beijing Release provides multiple documents including the following: + * 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. + +.. index:: Licensing + +Security Notes +============== +ONAP has adopted the `CII Best Practice Badge Program `_. The goal of the Beijing release is for all ONAP projects to be close to achieving a CII Passing badge. + +- `Badging Requirements `_ +- `Badging Status for all ONAP projects `_ + +Project specific details are in the :ref:`release notes` for each project. + +Licenses +======== +ONAP Source Code is licensed under the `Apache Version 2 License +`_. +ONAP 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, 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 `_. + +To properly report a bug in Jira, you may want to consider these `recommendations `_ to elaborate the issue you are facing. + + +.. Include files referenced by link in the toctree as hidden + +.. toctree:: + :hidden: + + release-manifest.rst + releaserepos.rst + repolist.rst