1 .. This work is licensed under a Creative Commons Attribution 4.0
2 International License. http://creativecommons.org/licenses/by/4.0
4 .. index:: Release Notes
8 This page is the ONAP Beijing Release Notes. The first release was
9 Amsterdam and subsequent major release will be named using city names.
11 * Release Name: Beijing
12 * Release Version: 1.0.0
13 * Release Date: May 24, 2018
16 Getting Started With ONAP
17 -------------------------
21 ONAP provides a comprehensive platform for real-time, policy-driven
22 service orchestration and automation including virtual network functions and
23 applications instantiation and configuration, but also physical network
24 functions configuration.
25 ONAP will enable software, network, IT and cloud providers and developers
26 to rapidly automate new services and support complete life cycle management.
27 By unifying member resources, ONAP will accelerate the development of a
28 vibrant ecosystem around a globally shared architecture and implementation
29 for network automation-with an open standards focus-faster than any one
30 product could on its own.
34 **Portal** - a single, consistent user experience for both design timer
35 and run time environments, based on the user’s role.
37 **Design Time Framework** - a comprehensive development environment with
38 tools, techniques, and repositories for defining/describing resources,
39 services, and products:
41 - Service Design and Creation (SDC) provides tools, techniques, and
42 repositories to define/simulate/certify system assets as well as their
43 associated processes and policies.
45 - A VNF Software Development Kit (VNFSDK) with tools for VNF supplier
46 packaging and validation.
48 - Policy Creation (POLICY) deals with conditions, requirements,
49 constraints, attributes, or needs that must be provided, maintained,
52 - Closed Loop Automation Management Platform (CLAMP) provides a method
53 for designing and managing control loops.
55 **Runtime Framework** - The runtime execution framework executes the
56 rules and policies distributed by the design and creation environment
57 and Controllers that manage resources corresponding to their assigned
60 - Service Orchestrator (SO) executes the specified BPMN processes and
61 automates sequences of activities, tasks, rules and policies needed for
62 on-demand creation, modification or removal of network, application or
63 infrastructure services and resources. SO is especially able to drive
64 any OpenStack-based cloud platform.
66 - Software Defined Network Controller (SDNC) executes network configuration
67 for cloud computing resources and network.
69 - Application Controller (APPC) executes Virtual Network Functions (VNF)
70 configurations and lifecycle management operations.
72 - Virtual Function Controller (VF-C) is responsible for lifecycle management
73 of virtual network functions and network services based on VNF using
76 - Active and Available Inventory (A&AI) provides real-time views of a
77 system’s resources, services, products and their relationships with each
80 **Closed-Loop Automation** -- Design -> Create -> Collect -> Analyze >
81 Detect -> Publish -> Respond:
83 - Data Collection, Analytics and Events (DCAE) collects events, performance,
84 usage and publishes information to policy that executes the rules to perform
87 - Holmes provides alarm correlation and analysis for Telecom cloud
88 infrastructure and services, including servers, cloud infrastructure,
89 VNFs and Network Services.
91 - Common Services - operational services for all ONAP components including
92 activity logging, reporting, common data layer, access control, resiliency,
93 and software lifecycle management.
95 Project Specific Release Notes
96 ++++++++++++++++++++++++++++++
97 ONAP releases are specified by a list of project artifact
98 versions in a :ref:`manifest<doc-release-manifest>`.
99 Each project provides detailed :ref:`release notes<doc-releaserepos>`
100 and prepends to these if/when any updated versions the project team believes
101 are compatible with a major release are made available.
103 Platforms Requirements
104 ++++++++++++++++++++++
105 ONAP Beijing Release has been tested on Linux OSs. Details are
106 :ref:`available here <demo-installing-running-onap-requirements>`.
113 There are 3 approaches to install ONAP:
115 * Full ONAP installation using Heat template
116 * Advanced installation to install individual components
117 * Experimental installation using Kubernetes
119 Full ONAP installation using Heat template
120 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
121 From a complete demo solution perspective. This installs the whole ONAP,
122 refer to :ref:`Setting Up ONAP <demo-installing-running-onap>`.
124 Advanced installation to install individual components
125 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
126 From a developer perspective, ONAP can be installed component per component.
127 For details, refer to :ref:`the installation procedure available for each
128 component<index-setting-individual-components>`.
129 The advanced installation procedure is recommended only for experienced
130 developers who desire to focus their attention on a few components and who have
131 a deep understanding of dependencies between components.
132 This type of installation is not recommended to fully install ONAP.
134 * The list of ports used by default within ONAP is documented in
135 `ONAP Service List <https://wiki.onap.org/display/DW/ONAP+Services+List>`_.
137 * The ONAP Source Code is available through Gerrit at https://gerrit.onap.org
138 or Git at https://git.onap.org/.
140 * ONAP is packaged within Docker and can be dowloaded from Docker Hub at
141 https://hub.docker.com/r/onap.
143 Experimental installation using Kubernetes
144 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
145 From a complete demo solution perspective using Kubernetes. This installs the
146 whole ONAP, refer to :ref:`ONAP Operations Manager -
147 Quick Start Guide <onap-operations-manager-project>`.
151 ONAP Beijing Release documentation is available :ref:`here <master_index>`.
152 For Beijing this includes:
154 * A high level :ref:`architecture view<doc-architecture>` of how components
155 relate to each other.
157 * A collection of documentation provided
158 by :ref:`each project <doc_onap-developer_guide_projects>`.
160 * Application Programming Interface
161 Reference :ref:`available here <doc-apiref>`.
163 * The `developer wiki <http://wiki.onap.org>`_ remains a good source of
164 information on meeting plans and notes from committees, project teams and
169 This section is intended to provide users on the usage of ONAP components.
171 Instructions on using the ONAP deployment including Robot, Portal, SDC and VID
172 in the context of running (Onboarding, service creation, service deployment,
173 VNF creation, VNF preload, VF Module creation and closed loop operations)
174 the vFirewall sanity use case is documented
175 in `Running the ONAP Demos
176 <https://wiki.onap.org/display/DW/Running+the+ONAP+Demos>`_.
182 ONAP Source Code is licensed under the `Apache Version 2 License
183 <http://www.apache.org/licenses/LICENSE-2.0>`_.
184 ONAP Documentation is licensed under the `Creative Commons Attribution 4.0
185 International License <http://creativecommons.org/licenses/by/4.0>`_.
187 Known Issues and Limitations
188 ++++++++++++++++++++++++++++
189 Known Issues and limitations are documented in each
190 :ref:`project Release Notes <doc-releaserepos>`.
192 .. index:: Reporting Bugs
196 There are 2 ways to report a bug in ONAP.
198 * In case you are familiar within ONAP, you can directly report a bug by
199 creating a Jira issue at `ONAP Jira <https://jira.onap.org>`_.
201 * If you don't know you are facing a bug or have a question, post your
203 `Ask question <https://wiki.onap.org/display/DW/questions/all>`_.
204 You will need a Linux Foundation ID to login and post your question.
205 Get a Linux Foundation Identity using this
206 `quick procedure <https://wiki.onap.org/display/DW/Joining+the+Community>`_.
208 You may consider these `recommendations <https://wiki.onap.org/display/DW/Tracking+Issues+with+JIRA#TrackingIssueswithJIRA-RecommendationsforwrittingProperJIRAIssue>`_ to elaborate the issue you are facing.
211 .. Include files referenced by link in the toctree as hidden