1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
|
.. 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 Beijing Release Notes. The first release was
Amsterdam and subsequent major release will be named using city names.
* Release Name: Beijing
* Release Version: 1.0.0
* Release Date: May 24, 2018
Getting Started With ONAP
-------------------------
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.
**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 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,
and software lifecycle management.
Project Specific Release Notes
++++++++++++++++++++++++++++++
ONAP releases are specified by a list of project artifact
versions in a :ref:`manifest<doc-release-manifest>`.
Each project provides detailed :ref:`release notes<doc-releaserepos>`
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 Beijing Release has been tested on Linux OSs. Details are
:ref:`available here <demo-installing-running-onap-requirements>`.
.. 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 <demo-installing-running-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<index-setting-individual-components>`.
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 <https://wiki.onap.org/display/DW/ONAP+Services+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 :ref:`ONAP Operations Manager -
Quick Start Guide <onap-operations-manager-project>`.
Documentation
+++++++++++++
ONAP Beijing Release documentation is available :ref:`here <master_index>`.
For Beijing this includes:
* A high level :ref:`architecture view<doc-architecture>` of how components
relate to each other.
* A collection of documentation provided
by :ref:`each project <doc_onap-developer_guide_projects>`.
* Application Programming Interface
Reference :ref:`available here <doc-apiref>`.
* The `developer wiki <http://wiki.onap.org>`_ remains a good source of
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.
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
<https://wiki.onap.org/display/DW/Running+the+ONAP+Demos>`_.
.. index:: Licensing
Licenses
++++++++
ONAP Source Code is licensed under the `Apache Version 2 License
<http://www.apache.org/licenses/LICENSE-2.0>`_.
ONAP Documentation is licensed under the `Creative Commons Attribution 4.0
International License <http://creativecommons.org/licenses/by/4.0>`_.
Known Issues and Limitations
++++++++++++++++++++++++++++
Known Issues and limitations are documented in each
:ref:`project Release Notes <doc-releaserepos>`.
.. 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 <https://jira.onap.org>`_.
* If you don't know you are facing a bug or have a question, post your
question into the
`Ask question <https://wiki.onap.org/display/DW/questions/all>`_.
You will need a Linux Foundation ID to login and post your question.
Get a Linux Foundation Identity using this
`quick procedure <https://wiki.onap.org/display/DW/Joining+the+Community>`_.
You may consider these `recommendations <https://wiki.onap.org/display/DW/Tracking+Issues+with+JIRA#TrackingIssueswithJIRA-RecommendationsforwrittingProperJIRAIssue>`_ 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
|
