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 .. contents::
   5    :depth: 2
   6
   7 .. index:: Release Notes
   8
   9 Beijing Release Notes
  10 =====================
  11 This page is the ONAP Beijing Release Notes. The first release was
  12 Amsterdam and subsequent major release will be named using city names.
  13
  14 * Release Name: Beijing
  15 * Release Version: 2.0.0
  16 * Release Date: June 7, 2018
  17
  18
  19 Getting Started With ONAP
  20 ==========================
  21
  22 Summary
  23 -------
  24 ONAP provides a comprehensive platform for real-time, policy-driven
  25 service orchestration and automation including virtual network functions and
  26 applications instantiation and configuration, but also physical network
  27 functions configuration.
  28 ONAP will enable software, network, IT and cloud providers and developers
  29 to rapidly automate new services and support complete life cycle management.
  30 By unifying member resources, ONAP will accelerate the development of a
  31 vibrant ecosystem around a globally shared architecture and implementation
  32 for network automation-with an open standards focus-faster than any one
  33 product could on its own.
  34
  35 Functionality
  36 -------------
  37 **Portal** - a single, consistent user experience for both design timer
  38 and run time environments, based on the user’s role.
  39
  40 **Design Time Framework** - a comprehensive development environment with
  41 tools, techniques, and repositories for defining/describing resources,
  42 services, and products:
  43
  44  - Service Design and Creation (SDC) provides tools, techniques, and
  45    repositories to define/simulate/certify system assets as well as their
  46    associated processes and policies.
  47
  48  - A VNF Software Development Kit (VNFSDK) and VNF Validation Program (VVP) with tools for VNF supplier
  49    packaging and validation.
  50
  51  - Policy Creation (POLICY) deals with conditions, requirements,
  52    constraints, attributes, or needs that must be provided, maintained,
  53    and/or enforced.
  54
  55  - Closed Loop Automation Management Platform (CLAMP) provides a method
  56    for designing and managing control loops.
  57
  58  - Optimization Framework (OOF) provides a policy-driven and model-driven framework
  59    for creating optimization applications.
  60
  61 **Runtime Framework** - The runtime execution framework executes the
  62 rules and policies distributed by the design and creation environment
  63 and Controllers that manage resources corresponding to their assigned
  64 controlled domain:
  65
  66  - Service Orchestrator (SO) executes the specified BPMN processes and
  67    automates sequences of activities, tasks, rules and policies needed for
  68    on-demand creation, modification or removal of network, application or
  69    infrastructure services and resources. SO is especially able to drive
  70    any OpenStack-based cloud platform.
  71
  72  - Software Defined Network Controller (SDNC) executes network configuration
  73    for cloud computing resources and network.
  74
  75  - Application Controller (APPC) executes Virtual Network Functions (VNF)
  76    configurations and lifecycle management operations.
  77
  78  - Virtual Function Controller (VF-C) is responsible for lifecycle management
  79    of virtual network functions and network services based on VNF using
  80    VNF Manager.
  81
  82  - Active and Available Inventory (A&AI) provides real-time views of a
  83    system’s resources, services, products and their relationships with each
  84    other.
  85
  86 **Closed-Loop Automation** -- Design -> Create -> Collect -> Analyze >
  87 Detect -> Publish -> Respond:
  88
  89  - Data Collection, Analytics and Events (DCAE) collects events, performance,
  90    usage and publishes information to policy that executes the rules to perform
  91    closed loop actions.
  92
  93  - Holmes provides alarm correlation and analysis for Telecom cloud
  94    infrastructure and services, including servers, cloud infrastructure,
  95    VNFs and Network Services.
  96
  97  - Common Services - operational services for all ONAP components including
  98    activity logging, reporting, common data layer, access control, resiliency, multisite state coordination,
  99    credential/secret management and software lifecycle management.
 100
 101 **Microservices Support**
 102
 103  - ONAP Operation Manager (OOM) use kubernetes and Helm to manage ONAP components.
 104  - Microservices Bus (MSB) provides service registration/discovery,
 105    external API gateway, internal API gateway, client software development kit (SDK), and Swagger SDK.
 106
 107 Project Specific Release Notes
 108 ==============================
 109 ONAP releases are specified by a list of project artifact
 110 versions in a :ref:`manifest<doc-release-manifest>`.
 111
 112 Each project provides detailed :ref:`release notes<doc-releaserepos>`
 113 and prepends to these if/when any updated versions the project team believes
 114 are compatible with a major release are made available.
 115
 116 .. index:: Download
 117
 118 Download & Install
 119 ==================
 120 There are 3 approaches to install ONAP:
 121
 122 * Installation using Kubernetes (aka OOM). Recommended method
 123 * Installation using Heat template
 124 * Advanced installation to install individual components
 125
 126 Documentation
 127 =============
 128 ONAP Beijing Release provides multiple documents including the following:
 129
 130  * A high level :ref:`architecture view<doc-architecture>` of how components
 131    relate to each other.
 132
 133  * A collection of documentation provided
 134    by :ref:`each project <doc_onap-developer_guide_projects>`.
 135
 136  * Application Programming Interface
 137    Reference :ref:`available here <doc-apiref>`.
 138
 139  * The `developer wiki <http://wiki.onap.org>`_ remains a good source of
 140    information on meeting plans and notes from committees, project teams and
 141    community events.
 142
 143 .. index:: Licensing
 144
 145 Security Notes
 146 ==============
 147 ONAP has adopted the `CII Best Practice Badge Program <https://bestpractices.coreinfrastructure.org/en>`_. The goal of the Beijing release is for all ONAP projects to be close to achieving a CII Passing badge.
 148
 149 - `Badging Requirements <https://github.com/coreinfrastructure/best-practices-badge#core-infrastructure-initiative-best-practices-badge>`_
 150 - `Badging Status for all ONAP projects <https://bestpractices.coreinfrastructure.org/en/projects?q=onap>`_
 151
 152 Project specific details are in the :ref:`release notes<doc-releaserepos>` for each project.
 153
 154 Licenses
 155 ========
 156 ONAP Source Code is licensed under the `Apache Version 2 License
 157 <http://www.apache.org/licenses/LICENSE-2.0>`_.
 158 ONAP Documentation is licensed under the `Creative Commons Attribution 4.0
 159 International License <http://creativecommons.org/licenses/by/4.0>`_.
 160
 161 Known Issues and Limitations
 162 ============================
 163 Known Issues and limitations are documented in each
 164 :ref:`project Release Notes <doc-releaserepos>`.
 165
 166 .. index:: Reporting Bugs
 167
 168 How to Report a Bug
 169 ===================
 170 There are 2 ways to report a bug in ONAP.
 171
 172  * In case you are familiar within ONAP, you can directly report a bug by
 173    creating a Jira issue at `ONAP Jira <https://jira.onap.org>`_.
 174
 175  * If you don't know you are facing a bug or have a question, post your
 176    question into the
 177    `Ask question <https://wiki.onap.org/display/DW/questions/all>`_.
 178    You will need a Linux Foundation ID to login and post your question.
 179    Get a Linux Foundation Identity using this
 180    `quick procedure <https://wiki.onap.org/display/DW/Joining+the+ONAP+Technical+Community#JoiningtheONAPTechnicalCommunity-WhereDoIStart?>`_.
 181
 182 To properly report a bug in Jira, you may want to consider these `recommendations <https://wiki.onap.org/display/DW/Tracking+Issues+with+JIRA#TrackingIssueswithJIRA-RecommendationsforwrittingProperJIRAIssue>`_ to elaborate the issue you are facing.
 183
 184
 185 .. Include files referenced by link in the toctree as hidden
 186
 187 .. toctree::
 188    :hidden:
 189
 190    release-manifest.rst
 191    releaserepos.rst
 192    repolist.rst