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 .. index:: Release Notes
   5
   6 Releases
   7 ========
   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.
  10
  11 * Release Name: Amsterdam
  12 * Release Version: 1.0.0
  13 * Release Date: November 16, 2017
  14
  15
  16 Getting Started With Amsterdam
  17 ------------------------------
  18
  19 Summary
  20 +++++++
  21 ONAP provides a comprehensive platform for real-time, policy-driven
  22 service orchestration and automation including virtual network functions and applications
  23 instantiation and configuration, but also physical network functions configuration.
  24 ONAP will enable software, network, IT and cloud providers and developers
  25 to rapidly automate new services and support complete life cycle management.
  26 By unifying member resources, ONAP will accelerate the development of a
  27 vibrant ecosystem around a globally shared architecture and implementation
  28 for network automationâ€“with an open standards focusâ€“faster than any one
  29 product could on its own.
  30
  31 Functionality
  32 +++++++++++++
  33 **Portal** - a single, consistent user experience for both design timer
  34 and run time environments, based on the user’s role.
  35
  36 **Design Time Framework** - a comprehensive development environment with
  37 tools, techniques, and repositories for defining/describing resources,
  38 services, and products:
  39
  40  - Service Design and Creation (SDC) provides tools, techniques, and
  41    repositories to define/simulate/certify system assets as well as their
  42    associated processes and policies.
  43
  44  - A VNF Software Development Kit (VNFSDK) with tools for VNF supplier
  45    packaging and validation.
  46
  47  - Policy Creation (POLICY) deals with conditions, requirements,
  48    constraints, attributes, or needs that must be provided, maintained,
  49    and/or enforced.
  50
  51  - Closed Loop Automation Management Platform (CLAMP) provides a method
  52    for designing and managing control loops.
  53
  54 **Runtime Framework** - The runtime execution framework executes the
  55 rules and policies distributed by the design and creation environment
  56 and Controllers that manage resources corresponding to their assigned
  57 controlled domain:
  58
  59  - Service Orchestrator (SO) executes the specified BPMN processes and automates
  60    sequences of activities, tasks, rules and policies needed for on-demand
  61    creation, modification or removal of network, application or infrastructure
  62    services and resources. SO is especially able to drive any OpenStack-based cloud platform.
  63
  64  - Software Defined Network Controller (SDNC) executes network configuration for
  65    cloud computing resources and network.
  66
  67  - Application Controller (APPC) executes Virtual Network Functions (VNF) configurations and lifecycle
  68    management operations.
  69
  70  - Virtual Function Controller (VF-C) is responsible for lifecycle management of virtual network functions
  71    and network services based on VNF using VNF Manager.
  72
  73  - Active and Available Inventory (A&AI) provides real-time views of a
  74    system’s resources, services, products and their relationships with each
  75    other.
  76
  77 **Closed-Loop Automation** -- Design -> Create -> Collect -> Analyze >
  78 Detect -> Publish -> Respond:
  79
  80  - Data Collection, Analytics and Events (DCAE) collects events, performance,
  81    usage and publishes information to policy that executes the rules to perform
  82    closed loop actions.
  83
  84  - Holmes provides alarm correlation and analysis for Telecom cloud
  85    infrastructure and services, including servers, cloud infrastructure,
  86    VNFs and Network Services.
  87
  88  - Common Services - operational services for all ONAP components including
  89    activity logging, reporting, common data layer, access control, resiliency,
  90    and software lifecycle management.
  91
  92 Project Specific Release Notes
  93 ++++++++++++++++++++++++++++++
  94 ONAP releases are specified by a list of project artifact
  95 versions in a :ref:`manifest<doc-release-manifest>`.
  96 Each project provides detailed :ref:`release notes<doc-releaserepos>`
  97 and prepends to these if/when any updated versions the project team believes
  98 are compatible with a major release are made available.
  99
 100 Platforms Requirements
 101 ++++++++++++++++++++++
 102 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>`_.
 103
 104
 105 .. index:: Download
 106
 107 Download & Install
 108 ++++++++++++++++++
 109 There are 3 approaches to install ONAP:
 110
 111 * Full ONAP installation using Heat template
 112 * Advanced installation to install individual components
 113 * Experimental installation using Kubernetes
 114
 115 Full ONAP installation using Heat template
 116 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 117 From a complete demo solution perspective. This installs the whole ONAP, refer to :ref:`Setting Up ONAP <demo-installing-running-onap>`.
 118
 119 Advanced installation to install individual components
 120 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 121 From a developer perspective. ONAP can be installed component per component, refer to :ref:`the installation procedure available for each component<doc_onap-developer_guide_projects>`.
 122
 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.
 126
 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>`_.
 130
 131 Documentation
 132 +++++++++++++
 133 ONAP Amsterdam Release documentation is available :ref:`here <master_index>`.
 134 For Amsterdam this includes:
 135
 136  * A high level :ref:`architecture view<doc-architecture>` of how components
 137    relate to each other.
 138
 139  * A collection of documentation provided
 140    by :ref:`each project <doc_onap-developer_guide_projects>`.
 141
 142  * Application Programming Interface
 143    Reference :ref:`available here <doc-apiref>`.
 144
 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
 147    community events.
 148
 149 Usage
 150 +++++
 151 This section is intended to provide users on the usage of ONAP components.
 152
 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>`_.
 158
 159 .. index:: Licensing
 160
 161 Licenses
 162 ++++++++
 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>`_.
 165
 166 Known Issues and Limitations
 167 ++++++++++++++++++++++++++++
 168 Known Issues and limitations are documented in each :ref:`project Release Notes <doc-releaserepos>`.
 169
 170 .. index:: Reporting Bugs
 171
 172 How to Report a Bug
 173 +++++++++++++++++++
 174 There are 2 ways to report a bug in ONAP.
 175
 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>`_.
 177
 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>`_.
 180
 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 and this `guideline <https://wiki.onap.org/display/DW/Mailing+Lists>`_ to register into the ONAP Discuss mailing list.
 182
 183
 184 .. Include files referenced by link in the toctree as hidden
 185
 186 .. toctree::
 187    :hidden:
 188
 189    release-manifest.rst
 190    releaserepos.rst
 191    repolist.rst