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