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