Releases
========
-ONAP is developed and released around 6 month cycles. After an initial
-major release, additional stable point releases may be created. The first
-release is Amsterdam and subsequent major release will be named using city
-names.
+This page is the ONAP Amsterdam Release Notes. The first release is Amsterdam and subsequent major release will be named using city names.
+
+* Release Name: Amsterdam
+* Release Version: 1.0.0
+* Release Date: November 16, 2017
Amsterdam Release
Summary
+++++++
+ONAP provides a comprehensive platform for real-time, policy-driven
+orchestration and automation of physical and virtual network functions
+that 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
+++++++++++++
Project Specific Release Notes
++++++++++++++++++++++++++++++
-Major and stable point releases are specified by a list of project artifact
+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
Supported Platforms
+++++++++++++++++++
-
+ONAP Amsterdam Release has been tested on Ubuntu 16.04 and thus is the only OS supported.
Documentation
+++++++++++++
-Release controlled documentation is available :ref:`here <master_index>`.
+ONAP Amsterdam Release documentation is available :ref:`here <master_index>`.
For Amsterdam this includes:
* A high level :ref:`architecture view<doc-architecture>` of how components
* A collection of documentation provided
by :ref:`each project <doc_onap-developer_guide_projects>`.
-* Application Programming Interface Reference :ref:`available here <doc-apiref>`
+* 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,
- community events and general, release independent information about
- ONAP. Release dependent information is being migrated from the wiki to
- gerrit source control. See the doc
- project :ref:`release notes <doc-release-notes>` for current status.
+ information on meeting plans and notes from committees, project teams and
+ community events.
Known Issues and Limitations
++++++++++++++++++++++++++++
-TBP overall / general statement
-See :ref:`release notes <doc-releaserepos>` for each project.
+Known Issues and limitations are documented in each project Release Notes.
-License
-+++++++
+Refer to :ref:`release notes <doc-releaserepos>` for each project.
+Licenses
+++++++++
+ONAP Amsterdam Source Code is licensed under the `Apache Version 2 License <http://www.apache.org/licenses/LICENSE-2.0>`_.
+ONAP Amsterdam Documentation is licensed under the `Creative Commons Attribution 4.0 International License <http://creativecommons.org/licenses/by/4.0>`_.
How to Report a Bug
+++++++++++++++++++
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.
-Download and Use
-++++++++++++++++
+Download
+++++++++
+
+* ONAP Source Code is available through Gerrit at https://gerrit.onap.org or Git at https://git.onap.org/ .
-* Source Code in Gerrit https://gerrit.onap.org
+* ONAP is packaged within Docker and can be dowloaded from Docker Hub at https://hub.docker.com/r/onap .
+
+
+Install
++++++++
+There are 2 approaches to install ONAP.
-* Artifacts in Nexus / Docker Hub
+* From a complete demo solution perspective. This installs the whole ONAP, refer to :ref:`Setting Up ONAP <demo-installing-running-onap>`.
-* Platform :ref:`Demo <demo-installing-running-onap>`.
+* From a developer perspective. ONAP is installed component per component. Each component :ref:`installation is listed in<doc_onap-developer_guide_projects>`.
+The list of ports used by default within ONAP is documented in `ONAP Service List <https://wiki.onap.org/display/DW/ONAP+Services+List>`_.
+Usage
++++++
+This section is intended to provide users on the usage of ONAP components.
Code Review / doc.git / blobdiff