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