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