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