summaryrefslogtreecommitdiffstats
path: root/docs/release/index.rst
blob: 73af7336dbf7aa78950edb39d7bc092e11aa1a9b (plain)
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
.. This work is licensed under a Creative Commons Attribution 4.0
   International License. http://creativecommons.org/licenses/by/4.0

Releases
========
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
+++++++

Functionality
+++++++++++++


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.


Supported Platforms
+++++++++++++++++++
ONAP Amsterdam Release has been tested on Ubuntu 16.04 and thus is the only OS supported.

Documentation
+++++++++++++
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
  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. See the doc
  project :ref:`release notes <doc-release-notes>` for current status on documentation.


Known Issues and Limitations
++++++++++++++++++++++++++++
Known Issues and limitations are documented in each project Release Notes.

Refer to :ref:`release notes <doc-releaserepos>` for each project.

License
+++++++
ONAP Amsterdam is an `Apache Version 2 license <http://www.apache.org/licenses/LICENSE-2.0>`_ type of Open Source project.

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, email the ONAP Discuss mailing list at onap-discuss@lists.onap.org .

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
++++++++++++++++

* 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 .

* To Install Amsterdam ONAP refer to :ref:`Setting Up ONAP <demo-installing-running-onap>`.