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