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