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