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