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