1 .. This work is licensed under a Creative Commons Attribution 4.0
2 International License. http://creativecommons.org/licenses/by/4.0
7 .. index:: Release Notes
11 This page is the ONAP Beijing Release Notes. The first release was
12 Amsterdam and subsequent major release will be named using city names.
14 * Release Name: Beijing
15 * Release Version: 2.0.0
16 * Release Date: June 7, 2018
19 Getting Started With ONAP
20 =========================
24 ONAP provides a comprehensive platform for real-time, policy-driven
25 service orchestration and automation including virtual network functions and
26 applications instantiation and configuration, but also physical network
27 functions configuration.
28 ONAP will enable software, network, IT and cloud providers and developers
29 to rapidly automate new services and support complete life cycle management.
30 By unifying member resources, ONAP will accelerate the development of a
31 vibrant ecosystem around a globally shared architecture and implementation
32 for network automation-with an open standards focus-faster than any one
33 product could on its own.
37 **Portal** - a single, consistent user experience for both design timer
38 and run time environments, based on the user’s role.
40 **Design Time Framework** - a comprehensive development environment with
41 tools, techniques, and repositories for defining/describing resources,
42 services, and products:
44 - Service Design and Creation (SDC) provides tools, techniques, and
45 repositories to define/simulate/certify system assets as well as their
46 associated processes and policies.
48 - A VNF Software Development Kit (VNFSDK) and VNF Validation Program (VVP)
49 with tools for VNF supplier packaging and validation.
51 - Policy Creation (POLICY) deals with conditions, requirements,
52 constraints, attributes, or needs that must be provided, maintained,
55 - Closed Loop Automation Management Platform (CLAMP) provides a method
56 for designing and managing control loops.
58 - Optimization Framework (OOF) provides a policy-driven and model-driven
59 framework for creating optimization applications.
61 **Runtime Framework** - The runtime execution framework executes the
62 rules and policies distributed by the design and creation environment
63 and Controllers that manage resources corresponding to their assigned
66 - Service Orchestrator (SO) executes the specified BPMN processes and
67 automates sequences of activities, tasks, rules and policies needed for
68 on-demand creation, modification or removal of network, application or
69 infrastructure services and resources. SO is especially able to drive
70 any OpenStack-based cloud platform.
72 - Software Defined Network Controller (SDNC) executes network configuration
73 for cloud computing resources and network.
75 - Application Controller (APPC) executes Virtual Network Functions (VNF)
76 configurations and lifecycle management operations.
78 - Virtual Function Controller (VF-C) is responsible for lifecycle management
79 of virtual network functions and network services based on VNF using
82 - Active and Available Inventory (A&AI) provides real-time views of a
83 system’s resources, services, products and their relationships with each
86 **Closed-Loop Automation** -- Design -> Create -> Collect -> Analyze >
87 Detect -> Publish -> Respond:
89 - Data Collection, Analytics and Events (DCAE) collects events, performance,
90 usage and publishes information to policy that executes the rules to perform
93 - Holmes provides alarm correlation and analysis for Telecom cloud
94 infrastructure and services, including servers, cloud infrastructure,
95 VNFs and Network Services.
97 - Common Services - operational services for all ONAP components including
98 activity logging, reporting, common data layer, access control, resiliency,
99 multisite state coordination, credential/secret management and
100 software lifecycle management.
102 **Microservices Support**
104 - ONAP Operation Manager (OOM) use kubernetes and Helm to manage ONAP
106 - Microservices Bus (MSB) provides service registration/discovery,
107 external API gateway, internal API gateway, client software development kit
108 (SDK), and Swagger SDK.
110 Project Specific Release Notes
111 ==============================
112 ONAP releases are specified by a list of project artifact
113 versions in a :ref:`manifest<doc-release-manifest>`.
115 Each project provides detailed :ref:`release notes<doc-releaserepos>`
116 and prepends to these if/when any updated versions the project team believes
117 are compatible with a major release are made available.
123 There are 3 approaches to install ONAP:
125 * :ref:`Installation using Kubernetes (aka OOM) <installing-onap-k8s>`. Recommended method.
126 * :ref:`Installation using Heat template <installing-onap-heat>`.
127 * :ref:`Advanced installation to install individual components <installing-onap-individual>`.
131 ONAP Beijing Release provides multiple documents including the following:
133 * A high level :ref:`architecture view<doc-architecture>` of how components
134 relate to each other.
136 * A collection of documentation provided
137 by :ref:`each project <doc_onap-developer_guide_projects>`.
139 * Application Programming Interface
140 Reference :ref:`available here <doc-apiref>`.
142 * The `developer wiki <http://wiki.onap.org>`_ remains a good source of
143 information on meeting plans and notes from committees, project teams and
150 ONAP has adopted the `CII Best Practice Badge Program <https://bestpractices.coreinfrastructure.org/en>`_. The goal of the Beijing release is for all ONAP projects to be close to achieving a CII Passing badge.
152 - `Badging Requirements <https://github.com/coreinfrastructure/best-practices-badge#core-infrastructure-initiative-best-practices-badge>`_
153 - `Badging Status for all ONAP projects <https://bestpractices.coreinfrastructure.org/en/projects?q=onap>`_
155 Project specific details are in the :ref:`release notes<doc-releaserepos>`
160 ONAP Source Code is licensed under the `Apache Version 2 License
161 <http://www.apache.org/licenses/LICENSE-2.0>`_.
162 ONAP Documentation is licensed under the `Creative Commons Attribution 4.0
163 International License <http://creativecommons.org/licenses/by/4.0>`_.
165 Known Issues and Limitations
166 ============================
167 Known Issues and limitations are documented in each
168 :ref:`project Release Notes <doc-releaserepos>`.
170 .. index:: Reporting Bugs
174 There are 2 ways to report a bug in ONAP.
176 * In case you are familiar within ONAP, you can directly report a bug by
177 creating a Jira issue at `ONAP Jira <https://jira.onap.org>`_.
179 * If you don't know you are facing a bug or have a question, post your
181 `Ask question <https://wiki.onap.org/display/DW/questions/all>`_.
182 You will need a Linux Foundation ID to login and post your question.
183 Get a Linux Foundation Identity using this
184 `quick procedure <https://wiki.onap.org/display/DW/Joining+the+ONAP+Technical+Community#JoiningtheONAPTechnicalCommunity-WhereDoIStart?>`_.
186 To properly report a bug in Jira, you may want to consider these `recommendations <https://wiki.onap.org/display/DW/Tracking+Issues+with+JIRA#TrackingIssueswithJIRA-RecommendationsforwrittingProperJIRAIssue>`_ to elaborate the issue you are facing.
189 .. Include files referenced by link in the toctree as hidden