blob: 6972311e4d9d58d6b58490f90584d76bf8ee295a [file] [log] [blame]
Rich Bennett6dd9b672017-11-03 15:27:24 -04001.. This work is licensed under a Creative Commons Attribution 4.0
2 International License. http://creativecommons.org/licenses/by/4.0
Rich Bennett5baea462017-09-13 03:19:19 -04003
Gildas Lanilis9be906b2018-11-02 17:47:42 -07004Casablanca Release Notes
5^^^^^^^^^^^^^^^^^^^^^^^^
6This page is the ONAP Casablanca Release Notes. The first release was labelled
Eric Debeauf0319832018-11-08 21:35:23 +00007Amsterdam, second release Beijing and subsequent major release will be named
8using city names.
Gildas Lanilis4ad97c92017-11-13 12:10:01 -08009
Scott Seabolt9b7934c2019-01-29 09:20:38 -050010Release 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
12Each 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
14Casablanca Releases
15===================
16
17The following releases are available for Casablanca:
Scott Seabolt8a4bc532019-04-09 11:53:35 -040018 - `Casablanca Maintenance Release 3.0.2`_
Scott Seabolt9b7934c2019-01-29 09:20:38 -050019 - `Casablanca Maintenance Release 3.0.1`_
20 - `Casablanca Major Release 3.0.0`_
21
Scott Seabolt8a4bc532019-04-09 11:53:35 -040022Casablanca Maintenance Release 3.0.2
23====================================
24
25* Release Name: Casablanca
26* Release Version: 3.0.2
27* Release Date: Apr 15, 2019
28
29Casablanca Maintenance Release 3.0.2 addresses issue of certificate expiry across the following projects:
30 - AAI
31 - CLAMP
32 - DMAAP
33 - Policy
34 - VID
Scott Seaboltc005d312019-04-10 15:17:00 -040035 - Portal
Scott Seabolt8a4bc532019-04-09 11:53:35 -040036
37Details 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`_.
38
39
Scott Seabolt9b7934c2019-01-29 09:20:38 -050040Casablanca Maintenance Release 3.0.1
41====================================
42
43* Release Name: Casablanca
44* Release Version: 3.0.1
45* Release Date: Jan 31, 2019
46
Scott Seabolt8a4bc532019-04-09 11:53:35 -040047Casablanca Maintenance Release 3.0.1 delivered a number of fixes and updates across the following projects:
Scott Seabolt9b7934c2019-01-29 09:20:38 -050048 - AAI
49 - APPC
50 - CCSDK
51 - CLAMP
52 - DCAEGEN2
53 - DOC
54 - EXTAPI
55 - Integration
56 - MultiCloud
Scott Seabolt9b7934c2019-01-29 09:20:38 -050057 - OOM
58 - OOF
59 - Policy
Manoop Talasila23cbfb12019-02-08 15:10:05 -050060 - Portal
Scott Seabolt9b7934c2019-01-29 09:20:38 -050061 - SDC
62 - SDNC
63 - SO
Scott Seabolt9b7934c2019-01-29 09:20:38 -050064
65Details 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`_.
66
67Casablanca Major Release 3.0.0
68==============================
69
Gildas Lanilis9be906b2018-11-02 17:47:42 -070070* Release Name: Casablanca
71* Release Version: 3.0.0
Eric Debeauf0319832018-11-08 21:35:23 +000072* Release Date: Nov 30, 2018
Rich Bennett7134cba2017-10-10 07:39:06 -040073
Scott Seabolt9b7934c2019-01-29 09:20:38 -050074The Casablanca 3.0.0 is the first of Casablanca.
75
Noemi Wagnerbef82322018-12-11 13:17:41 +010076.. _getting-started:
Rich Bennett5baea462017-09-13 03:19:19 -040077
Eric Debeau58c20bf2018-03-20 20:33:44 +000078Getting Started With ONAP
Rich Bennett52b5c092018-09-01 09:48:13 -040079=========================
Rich Bennett5baea462017-09-13 03:19:19 -040080
Rich Bennett6dd9b672017-11-03 15:27:24 -040081Summary
Rich Bennett52b5c092018-09-01 09:48:13 -040082-------
Rich Bennettc4c034b2017-11-13 16:31:43 -050083ONAP provides a comprehensive platform for real-time, policy-driven
Eric Debeau58c20bf2018-03-20 20:33:44 +000084service orchestration and automation including virtual network functions and
85applications instantiation and configuration, but also physical network
86functions configuration.
Eric Debeau37fde6e2017-11-20 22:23:08 +000087ONAP will enable software, network, IT and cloud providers and developers
Rich Bennettc4c034b2017-11-13 16:31:43 -050088to rapidly automate new services and support complete life cycle management.
89By unifying member resources, ONAP will accelerate the development of a
90vibrant ecosystem around a globally shared architecture and implementation
Gildas Lanilisc10c7c92017-11-21 11:50:18 -080091for network automation-with an open standards focus-faster than any one
Rich Bennettc4c034b2017-11-13 16:31:43 -050092product could on its own.
Rich Bennett6dd9b672017-11-03 15:27:24 -040093
94Functionality
Rich Bennett52b5c092018-09-01 09:48:13 -040095-------------
ankatarefafe5802018-10-09 13:04:24 +053096**Portal** - a single, consistent user experience for both design time
Rich Bennett0172ec22017-11-16 07:52:35 -050097and run time environments, based on the users role.
Rich Bennett6dd9b672017-11-03 15:27:24 -040098
Rich Bennettb921b992017-11-17 08:28:37 -050099**Design Time Framework** - a comprehensive development environment with
Rich Bennett0172ec22017-11-16 07:52:35 -0500100tools, techniques, and repositories for defining/describing resources,
Eric Debeauf0319832018-11-08 21:35:23 +0000101and services:
Rich Bennett0172ec22017-11-16 07:52:35 -0500102
103 - Service Design and Creation (SDC) provides tools, techniques, and
104 repositories to define/simulate/certify system assets as well as their
105 associated processes and policies.
106
Rich Bennett52b5c092018-09-01 09:48:13 -0400107 - A VNF Software Development Kit (VNFSDK) and VNF Validation Program (VVP)
108 with tools for VNF supplier packaging and validation.
Rich Bennett0172ec22017-11-16 07:52:35 -0500109
110 - Policy Creation (POLICY) deals with conditions, requirements,
111 constraints, attributes, or needs that must be provided, maintained,
112 and/or enforced.
113
114 - Closed Loop Automation Management Platform (CLAMP) provides a method
Rich Bennettb921b992017-11-17 08:28:37 -0500115 for designing and managing control loops.
Rich Bennett0172ec22017-11-16 07:52:35 -0500116
Rich Bennett52b5c092018-09-01 09:48:13 -0400117 - Optimization Framework (OOF) provides a policy-driven and model-driven
118 framework for creating optimization applications.
119
Rich Bennettb921b992017-11-17 08:28:37 -0500120**Runtime Framework** - The runtime execution framework executes the
Rich Bennett0172ec22017-11-16 07:52:35 -0500121rules and policies distributed by the design and creation environment
122and Controllers that manage resources corresponding to their assigned
123controlled domain:
124
Eric Debeau58c20bf2018-03-20 20:33:44 +0000125 - Service Orchestrator (SO) executes the specified BPMN processes and
126 automates sequences of activities, tasks, rules and policies needed for
127 on-demand creation, modification or removal of network, application or
128 infrastructure services and resources. SO is especially able to drive
129 any OpenStack-based cloud platform.
Rich Bennett0172ec22017-11-16 07:52:35 -0500130
Eric Debeau58c20bf2018-03-20 20:33:44 +0000131 - Software Defined Network Controller (SDNC) executes network configuration
132 for cloud computing resources and network.
Rich Bennett0172ec22017-11-16 07:52:35 -0500133
Eric Debeau58c20bf2018-03-20 20:33:44 +0000134 - Application Controller (APPC) executes Virtual Network Functions (VNF)
135 configurations and lifecycle management operations.
Rich Bennett0172ec22017-11-16 07:52:35 -0500136
Eric Debeau58c20bf2018-03-20 20:33:44 +0000137 - Virtual Function Controller (VF-C) is responsible for lifecycle management
138 of virtual network functions and network services based on VNF using
139 VNF Manager.
Rich Bennett0172ec22017-11-16 07:52:35 -0500140
141 - Active and Available Inventory (A&AI) provides real-time views of a
142 systems resources, services, products and their relationships with each
143 other.
144
Rich Bennettb921b992017-11-17 08:28:37 -0500145**Closed-Loop Automation** -- Design -> Create -> Collect -> Analyze >
Rich Bennett0172ec22017-11-16 07:52:35 -0500146Detect -> Publish -> Respond:
147
Eric Debeau37fde6e2017-11-20 22:23:08 +0000148 - Data Collection, Analytics and Events (DCAE) collects events, performance,
149 usage and publishes information to policy that executes the rules to perform
150 closed loop actions.
Rich Bennett0172ec22017-11-16 07:52:35 -0500151
Eric Debeau37fde6e2017-11-20 22:23:08 +0000152 - Holmes provides alarm correlation and analysis for Telecom cloud
153 infrastructure and services, including servers, cloud infrastructure,
154 VNFs and Network Services.
Rich Bennett0172ec22017-11-16 07:52:35 -0500155
156 - Common Services - operational services for all ONAP components including
157 activity logging, reporting, common data layer, access control, resiliency,
Rich Bennett52b5c092018-09-01 09:48:13 -0400158 multisite state coordination, credential/secret management and
159 software lifecycle management.
160
161**Microservices Support**
162
Scott Seabolt9b7934c2019-01-29 09:20:38 -0500163 - ONAP Operation Manager (OOM) use Kubernetes and Helm to manage ONAP components.
Rich Bennett52b5c092018-09-01 09:48:13 -0400164 - Microservices Bus (MSB) provides service registration/discovery,
165 external API gateway, internal API gateway, client software development kit
166 (SDK), and Swagger SDK.
Rich Bennett6dd9b672017-11-03 15:27:24 -0400167
168Project Specific Release Notes
Rich Bennett52b5c092018-09-01 09:48:13 -0400169==============================
Scott Seabolt576c2b52019-02-27 13:07:16 -0500170ONAP 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>`.
Rich Bennett52b5c092018-09-01 09:48:13 -0400171
Rich Bennett84424f02018-12-06 16:01:34 -0500172.. toctree::
173 :hidden:
174
Scott Seabolt576c2b52019-02-27 13:07:16 -0500175 release-manifest-docker.rst
Rich Bennett84424f02018-12-06 16:01:34 -0500176 release-manifest.rst
177
Rich Bennett80455a52017-11-08 05:17:00 -0500178Each project provides detailed :ref:`release notes<doc-releaserepos>`
179and prepends to these if/when any updated versions the project team believes
180are compatible with a major release are made available.
Rich Bennett6dd9b672017-11-03 15:27:24 -0400181
Eric Debeauab6162b2017-11-17 19:30:47 +0000182.. index:: Download
183
Rich Bennett52b5c092018-09-01 09:48:13 -0400184Installation
185============
Scott Seabolt9b7934c2019-01-29 09:20:38 -0500186ONAP is installed using :ref:`ONAP Operations Manager (OOM) over Kubernetes<installing-onap>`
Eric Debeauab6162b2017-11-17 19:30:47 +0000187
Rich Bennett6dd9b672017-11-03 15:27:24 -0400188Documentation
Rich Bennett52b5c092018-09-01 09:48:13 -0400189=============
Gildas Lanilis9be906b2018-11-02 17:47:42 -0700190ONAP Casablanca Release provides multiple documents including the following:
Rich Bennett6dd9b672017-11-03 15:27:24 -0400191
Scott Seabolt576c2b52019-02-27 13:07:16 -0500192 * A high level :ref:`architecture view<doc-architecture>` of how component
Rich Bennett0172ec22017-11-16 07:52:35 -0500193 relate to each other.
Rich Bennett6dd9b672017-11-03 15:27:24 -0400194
Rich Bennett0172ec22017-11-16 07:52:35 -0500195 * A collection of documentation provided
196 by :ref:`each project <doc_onap-developer_guide_projects>`.
Rich Bennett6dd9b672017-11-03 15:27:24 -0400197
Rich Bennett0172ec22017-11-16 07:52:35 -0500198 * Application Programming Interface
199 Reference :ref:`available here <doc-apiref>`.
Rich Bennett6dd9b672017-11-03 15:27:24 -0400200
Rich Bennett0172ec22017-11-16 07:52:35 -0500201 * The `developer wiki <http://wiki.onap.org>`_ remains a good source of
202 information on meeting plans and notes from committees, project teams and
203 community events.
Rich Bennett6dd9b672017-11-03 15:27:24 -0400204
Rich Bennettb921b992017-11-17 08:28:37 -0500205.. index:: Licensing
206
Rich Bennett52b5c092018-09-01 09:48:13 -0400207Security Notes
208==============
Scott Seabolt9b7934c2019-01-29 09:20:38 -0500209ONAP has adopted the `CII Best Practice Badge Program <https://bestpractices.coreinfrastructure.org/en>`_.
210The goal of the Casablanca release is for all ONAP projects to be close to achieving a CII Passing badge.
Rich Bennett52b5c092018-09-01 09:48:13 -0400211
212- `Badging Requirements <https://github.com/coreinfrastructure/best-practices-badge#core-infrastructure-initiative-best-practices-badge>`_
213- `Badging Status for all ONAP projects <https://bestpractices.coreinfrastructure.org/en/projects?q=onap>`_
214
Scott Seabolt9b7934c2019-01-29 09:20:38 -0500215Project specific details are in the :ref:`release notes<doc-releaserepos>` for each project.
Rich Bennett52b5c092018-09-01 09:48:13 -0400216
helenc87816e2b9b2018-11-30 07:29:09 -0800217.. index:: maturity
Scott Seabolt9b7934c2019-01-29 09:20:38 -0500218
helenc87816e2b9b2018-11-30 07:29:09 -0800219ONAP Maturity Testing Notes
220===========================
Scott Seabolt8a4bc532019-04-09 11:53:35 -0400221For the Casablanca release, ONAP continues to improve in multiple areas of Scalability, Security, Stability and Performance (S3P) metrics.
Scott Seabolt9b7934c2019-01-29 09:20:38 -0500222
223The Integration team ran the 72 hours stability testing (100% passing rateand full resilience testing (96.9% passing rate) at ONAP OpenLabs. More details in :ref:`ONAP Maturity Testing Notes <integration-s3p>`
helenc87816e2b9b2018-11-30 07:29:09 -0800224
Gildas Lanilis6a7de922017-11-13 15:35:00 -0800225Licenses
Rich Bennett52b5c092018-09-01 09:48:13 -0400226========
Scott Seabolt9b7934c2019-01-29 09:20:38 -0500227ONAP Source Code is licensed under the `Apache Version 2 License <http://www.apache.org/licenses/LICENSE-2.0>`_.
Eric Debeau58c20bf2018-03-20 20:33:44 +0000228ONAP Documentation is licensed under the `Creative Commons Attribution 4.0
229International License <http://creativecommons.org/licenses/by/4.0>`_.
Rich Bennett6dd9b672017-11-03 15:27:24 -0400230
Eric Debeauab6162b2017-11-17 19:30:47 +0000231Known Issues and Limitations
Rich Bennett52b5c092018-09-01 09:48:13 -0400232============================
Scott Seabolt9b7934c2019-01-29 09:20:38 -0500233Known Issues and limitations are documented in each :ref:`project Release Notes <doc-releaserepos>`.
Eric Debeauab6162b2017-11-17 19:30:47 +0000234
Rich Bennettb921b992017-11-17 08:28:37 -0500235.. index:: Reporting Bugs
236
Rich Bennett6dd9b672017-11-03 15:27:24 -0400237How to Report a Bug
Rich Bennett52b5c092018-09-01 09:48:13 -0400238===================
Gildas Lanilis95146dd2017-11-09 14:53:25 -0800239There are 2 ways to report a bug in ONAP.
240
Eric Debeau58c20bf2018-03-20 20:33:44 +0000241 * In case you are familiar within ONAP, you can directly report a bug by
242 creating a Jira issue at `ONAP Jira <https://jira.onap.org>`_.
Gildas Lanilis95146dd2017-11-09 14:53:25 -0800243
Eric Debeau58c20bf2018-03-20 20:33:44 +0000244 * If you don't know you are facing a bug or have a question, post your
Scott Seabolt9b7934c2019-01-29 09:20:38 -0500245 question into the `Ask question <https://wiki.onap.org/display/DW/questions/all>`_.
Eric Debeau58c20bf2018-03-20 20:33:44 +0000246 You will need a Linux Foundation ID to login and post your question.
Scott Seabolt9b7934c2019-01-29 09:20:38 -0500247 Get a Linux Foundation Identity using this `quick procedure <https://wiki.onap.org/display/DW/Joining+the+ONAP+Technical+Community#JoiningtheONAPTechnicalCommunity-WhereDoIStart?>`_.
Gildas Lanilis95146dd2017-11-09 14:53:25 -0800248
Rich Bennett52b5c092018-09-01 09:48:13 -0400249To 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.
Rich Bennett6dd9b672017-11-03 15:27:24 -0400250
Rich Bennettb921b992017-11-17 08:28:37 -0500251
252.. Include files referenced by link in the toctree as hidden
253
254.. toctree::
255 :hidden:
256
Rich Bennettb921b992017-11-17 08:28:37 -0500257 releaserepos.rst
258 repolist.rst