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 Amsterdam Release Notes. The first release is
9 Amsterdam and subsequent major release will be named using city names.
11 * Release Name: Amsterdam
12 * Release Version: 1.0.0
13 * Release Date: November 16, 2017
21 ONAP provides a comprehensive platform for real-time, policy-driven
22 orchestration and automation of physical and virtual network functions
23 that will enable software, network, IT and cloud providers and developers
24 to rapidly automate new services and support complete life cycle management.
25 By unifying member resources, ONAP will accelerate the development of a
26 vibrant ecosystem around a globally shared architecture and implementation
27 for network automation–with an open standards focus–faster than any one
28 product could on its own.
32 **Portal** - a single, consistent user experience for both design timer
33 and run time environments, based on the user’s role.
35 **Design Time Framework** - a comprehensive development environment with
36 tools, techniques, and repositories for defining/describing resources,
37 services, and products:
39 - Service Design and Creation (SDC) provides tools, techniques, and
40 repositories to define/simulate/certify system assets as well as their
41 associated processes and policies.
43 - A VNF Software Development Kit (VNFSDK) with tools for VNF supplier
44 packaging and validation.
46 - Policy Creation (POLICY) deals with conditions, requirements,
47 constraints, attributes, or needs that must be provided, maintained,
50 - Closed Loop Automation Management Platform (CLAMP) provides a method
51 for designing and managing control loops.
53 **Runtime Framework** - The runtime execution framework executes the
54 rules and policies distributed by the design and creation environment
55 and Controllers that manage resources corresponding to their assigned
58 - Service Orchestrator (SO) executes the specified processes and automates
59 sequences of activities, tasks, rules and policies needed for on-demand
60 creation, modification or removal of network, application or infrastructure
61 services and resources.
63 - Software Defined Network Controller (SDNC) network configuration of
64 cloud computing resources.
66 - Application Controller (APPC) Application resources.
68 - Virtual Function Controller (VF-C) provides an ETSI NFV compliant NFV-O
69 functions, and is responsible for life cycle management of virtual services
70 and the associated physical COTS server infrastructure.
72 - Active and Available Inventory (A&AI) provides real-time views of a
73 system’s resources, services, products and their relationships with each
76 **Closed-Loop Automation** -- Design -> Create -> Collect -> Analyze >
77 Detect -> Publish -> Respond:
79 - Data Collection, Analytics and Events (DCAE) collects performance,
80 usage, and configuration data and publishes information to policy,
81 orchestration, and the data lake.
83 - “Holmes” provides alarm correlation and analysis for Telecom cloud
84 infrastructure and services, including hosts, vims, VNFs and NSs
86 - Common Services - operational services for all ONAP components including
87 activity logging, reporting, common data layer, access control, resiliency,
88 and software lifecycle management.
90 Project Specific Release Notes
91 ++++++++++++++++++++++++++++++
92 ONAP releases are specified by a list of project artifact
93 versions in a :ref:`manifest<doc-release-manifest>`.
94 Each project provides detailed :ref:`release notes<doc-releaserepos>`
95 and prepends to these if/when any updated versions the project team believes
96 are compatible with a major release are made available.
101 ONAP Amsterdam Release has been tested on Ubuntu 16.04 and thus is
102 the only OS supported.
106 ONAP Amsterdam Release documentation is available :ref:`here <master_index>`.
107 For Amsterdam this includes:
109 * A high level :ref:`architecture view<doc-architecture>` of how components
110 relate to each other.
112 * A collection of documentation provided
113 by :ref:`each project <doc_onap-developer_guide_projects>`.
115 * Application Programming Interface
116 Reference :ref:`available here <doc-apiref>`.
118 * The `developer wiki <http://wiki.onap.org>`_ remains a good source of
119 information on meeting plans and notes from committees, project teams and
123 Known Issues and Limitations
124 ++++++++++++++++++++++++++++
125 Known Issues and limitations are documented in each project Release Notes.
127 Refer to :ref:`release notes <doc-releaserepos>` for each project.
134 ONAP Amsterdam Source Code is licensed under the `Apache Version 2 License <http://www.apache.org/licenses/LICENSE-2.0>`_.
135 ONAP Amsterdam Documentation is licensed under the `Creative Commons Attribution 4.0 International License <http://creativecommons.org/licenses/by/4.0>`_.
137 .. index:: Reporting Bugs
141 There are 2 ways to report a bug in ONAP.
143 * In case you are familiar within ONAP, you can directly
144 report a bug by creating a Jira issue
145 at `ONAP Jira <https://jira.onap.org>`_.
147 * If you don't know you are facing a bug or have a question, email
148 the ONAP Discuss mailing list at onap-discuss@lists.onap.org .
150 You may consider these `recommendations <https://wiki.onap.org/display/DW/Tracking+Issues+with+JIRA#TrackingIssueswithJIRA-RecommendationsforwrittingProperJIRAIssue>`_ to elaborate the issue you are facing and this `guideline <https://wiki.onap.org/display/DW/Mailing+Lists>`_ to register into the ONAP Discuss mailing list.
157 * ONAP Source Code is available through Gerrit at https://gerrit.onap.org or Git at https://git.onap.org/ .
159 * ONAP is packaged within Docker and can be dowloaded from Docker Hub at https://hub.docker.com/r/onap .
162 .. index:: Installation
167 There are 2 approaches to install ONAP.
169 * From a complete demo solution perspective. This installs the whole ONAP,
170 refer to :ref:`Setting Up ONAP <demo-installing-running-onap>`.
172 * From a developer perspective. ONAP is installed component per component.
174 component :ref:`installation is listed in<doc_onap-developer_guide_projects>`.
175 The list of ports used by default within ONAP is documented
176 in `ONAP Service List <https://wiki.onap.org/display/DW/ONAP+Services+List>`_.
180 This section is intended to provide users on the usage of ONAP components.
182 Instructions on using the ONAP deployment including Robot, Portal, SDC and VID
183 in the context of running (Onboarding, service creation, service deployment,
184 VNF creation, VNF preload, VF Module creation and closed loop operations)
185 the vFirewall sanity use case is documented
186 in `Running the ONAP Demos <https://wiki.onap.org/display/DW/Running+the+ONAP+Demos>`_.
189 .. Include files referenced by link in the toctree as hidden