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