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