docs/release/index.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0
   2    International License. http://creativecommons.org/licenses/by/4.0
   3
   4 Releases
   5 ========
   6 This page is the ONAP Amsterdam Release Notes. The first release is Amsterdam and subsequent major release will be named using city names.
   7
   8 * Release Name: Amsterdam
   9 * Release Version: 1.0.0
  10 * Release Date: November 16, 2017
  11
  12
  13 Amsterdam Release
  14 -----------------
  15
  16 Summary
  17 +++++++
  18 ONAP provides a comprehensive platform for real-time, policy-driven
  19 orchestration and automation of physical and virtual network functions
  20 that will enable software, network, IT and cloud providers and developers
  21 to rapidly automate new services and support complete life cycle management.
  22 By unifying member resources, ONAP will accelerate the development of a
  23 vibrant ecosystem around a globally shared architecture and implementation
  24 for network automation–with an open standards focus–faster than any one
  25 product could on its own.
  26
  27 Functionality
  28 +++++++++++++
  29
  30
  31 Project Specific Release Notes
  32 ++++++++++++++++++++++++++++++
  33 ONAP releases are specified by a list of project artifact
  34 versions in a :ref:`manifest<doc-release-manifest>`.
  35 Each project provides detailed :ref:`release notes<doc-releaserepos>`
  36 and prepends to these if/when any updated versions the project team believes
  37 are compatible with a major release are made available.
  38
  39
  40 Supported Platforms
  41 +++++++++++++++++++
  42 ONAP Amsterdam Release has been tested on Ubuntu 16.04 and thus is the only OS supported.
  43
  44 Documentation
  45 +++++++++++++
  46 ONAP Amsterdam Release documentation is available :ref:`here <master_index>`.
  47 For Amsterdam this includes:
  48
  49 * A high level :ref:`architecture view<doc-architecture>` of how components
  50   relate to each other.
  51
  52 * A collection of documentation provided
  53   by :ref:`each project <doc_onap-developer_guide_projects>`.
  54
  55 * Application Programming Interface Reference :ref:`available here <doc-apiref>`.
  56
  57 * The `developer wiki <http://wiki.onap.org>`_ remains a good source of
  58   information on meeting plans and notes from committees, project teams and
  59   community events.
  60
  61
  62 Known Issues and Limitations
  63 ++++++++++++++++++++++++++++
  64 Known Issues and limitations are documented in each project Release Notes.
  65
  66 Refer to :ref:`release notes <doc-releaserepos>` for each project.
  67
  68 Licenses
  69 ++++++++
  70 ONAP Amsterdam Source Code is licensed under the `Apache Version 2 License <http://www.apache.org/licenses/LICENSE-2.0>`_.
  71 ONAP Amsterdam Documentation is licensed under the `Creative Commons Attribution 4.0 International License <http://creativecommons.org/licenses/by/4.0>`_.
  72
  73 How to Report a Bug
  74 +++++++++++++++++++
  75 There are 2 ways to report a bug in ONAP.
  76
  77 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>`_.
  78
  79 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 .
  80
  81 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.
  82
  83
  84 Download
  85 ++++++++
  86
  87 * ONAP Source Code is available through Gerrit at https://gerrit.onap.org or Git at https://git.onap.org/ .
  88
  89 * ONAP is packaged within Docker and can be dowloaded from Docker Hub at https://hub.docker.com/r/onap .
  90
  91
  92 Install
  93 +++++++
  94 There are 2 approaches to install ONAP.
  95
  96 * From a complete demo solution perspective. This installs the whole ONAP, refer to :ref:`Setting Up ONAP <demo-installing-running-onap>`.
  97
  98 * From a developer perspective. ONAP is installed component per component. Each component :ref:`installation is listed in<doc_onap-developer_guide_projects>`.
  99 The list of ports used by default within ONAP is documented in `ONAP Service List <https://wiki.onap.org/display/DW/ONAP+Services+List>`_.
 100
 101 Usage
 102 +++++
 103 This section is intended to provide users on the usage of ONAP components.