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
16 Getting Started With Amsterdam
17 ------------------------------
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.
98 Platforms Requirements
99 ++++++++++++++++++++++
100 ONAP Amsterdam Release has been tested on Linux OSs. Details are `available here <http://onap.readthedocs.io/en/latest/guides/onap-developer/settingup/fullonap.html#requirements>`_.
107 There are 3 approaches to install ONAP:
109 * Full ONAP installation using Heat template
110 * Advanced installation to install individual components
111 * Experimental installation using Kubernetes
113 Full ONAP installation using Heat template
114 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
115 From a complete demo solution perspective. This installs the whole ONAP, refer to :ref:`Setting Up ONAP <demo-installing-running-onap>`.
117 Advanced installation to install individual components
118 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
119 From a developer perspective, ONAP can be installed component per component. For details, refer to :ref:`the installation procedure available for each component<doc_onap-developer_guide_projects>`.
120 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.
121 This type of installation is not recommended to fully install ONAP.
123 * The list of ports used by default within ONAP is documented in `ONAP Service List <https://wiki.onap.org/display/DW/ONAP+Services+List>`_.
124 * The ONAP Source Code is available through Gerrit at https://gerrit.onap.org or Git at https://git.onap.org/.
125 * ONAP is packaged within Docker and can be dowloaded from Docker Hub at https://hub.docker.com/r/onap.
127 Experimental installation using Kubernetes
128 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
129 From a complete demo solution perspective using Kubernetes. This installs the whole ONAP, refer to `ONAP Operations Manager - Quick Start Guide <http://onap.readthedocs.io/en/latest/submodules/oom.git/docs/OOM%20Project%20Description/oom_project_description.html#quick-start-guide>`_.
133 ONAP Amsterdam Release documentation is available :ref:`here <master_index>`.
134 For Amsterdam this includes:
136 * A high level :ref:`architecture view<doc-architecture>` of how components
137 relate to each other.
139 * A collection of documentation provided
140 by :ref:`each project <doc_onap-developer_guide_projects>`.
142 * Application Programming Interface
143 Reference :ref:`available here <doc-apiref>`.
145 * The `developer wiki <http://wiki.onap.org>`_ remains a good source of
146 information on meeting plans and notes from committees, project teams and
151 This section is intended to provide users on the usage of ONAP components.
153 Instructions on using the ONAP deployment including Robot, Portal, SDC and VID
154 in the context of running (Onboarding, service creation, service deployment,
155 VNF creation, VNF preload, VF Module creation and closed loop operations)
156 the vFirewall sanity use case is documented
157 in `Running the ONAP Demos <https://wiki.onap.org/display/DW/Running+the+ONAP+Demos>`_.
163 ONAP Amsterdam Source Code is licensed under the `Apache Version 2 License <http://www.apache.org/licenses/LICENSE-2.0>`_.
164 ONAP Amsterdam Documentation is licensed under the `Creative Commons Attribution 4.0 International License <http://creativecommons.org/licenses/by/4.0>`_.
166 Known Issues and Limitations
167 ++++++++++++++++++++++++++++
168 Known Issues and limitations are documented in each :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 creating a Jira issue at `ONAP Jira <https://jira.onap.org>`_.
178 * 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>`_.
179 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>`_.
181 You may consider these `recommendations <https://wiki.onap.org/display/DW/Tracking+Issues+with+JIRA#TrackingIssueswithJIRA-RecommendationsforwrittingProperJIRAIssue>`_ to elaborate the issue you are facing.
184 .. Include files referenced by link in the toctree as hidden