update composite release notes: fix version number
[doc.git] / 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 .. _onap-release-notes:
6
7 Istanbul Release Notes
8 ^^^^^^^^^^^^^^^^^^^^^^
9
10 This page provides the release notes for the ONAP Istanbul release. This
11 includes details of software versions, known limitations, and outstanding
12 trouble reports.
13
14 Release notes are cumulative for the release, meaning this release note will
15 have an entry for each Major, Minor, and Maintenance release, if applicable.
16
17 Each component within the ONAP solution maintains their own component level
18 release notes and links to those release notes are provided below.
19 Details on the specific items delivered in each release by each component is
20 maintained in the component specific release notes.
21
22 Istanbul Maintenance Release 9.0.1
23 ==================================
24
25 +--------------------------------------+--------------------------------------+
26 | **Project**                          | Open Network Automation Platform     |
27 |                                      | (ONAP)                               |
28 +--------------------------------------+--------------------------------------+
29 | **Release name**                     | Istanbul                             |
30 |                                      |                                      |
31 +--------------------------------------+--------------------------------------+
32 | **Release version**                  | 9.0.1                                |
33 |                                      |                                      |
34 +--------------------------------------+--------------------------------------+
35 | **Release date**                     | February 17th, 2022                  |
36 |                                      |                                      |
37 +--------------------------------------+--------------------------------------+
38
39 Features
40 --------
41 ONAP Istanbul Maintenance Release 1 focusses on:
42
43 - fixing log4j vulnerabilities in AAI, CPS, DCAEGEN2, DMAAP, POLICY, SDNC
44   and VNFSDK 
45
46 Istanbul Major Release 9.0.0
47 ============================
48
49 +--------------------------------------+--------------------------------------+
50 | **Project**                          | Open Network Automation Platform     |
51 |                                      | (ONAP)                               |
52 +--------------------------------------+--------------------------------------+
53 | **Release name**                     | Istanbul                             |
54 |                                      |                                      |
55 +--------------------------------------+--------------------------------------+
56 | **Release version**                  | 9.0.0                                |
57 |                                      |                                      |
58 +--------------------------------------+--------------------------------------+
59 | **Release date**                     | November 15th, 2021                  |
60 |                                      |                                      |
61 +--------------------------------------+--------------------------------------+
62
63 Features
64 --------
65 ONAP Istanbul focusses on:
66
67 - Intent based networking (IBN) simplifies interaction and network
68   configuration by Control-Loop and Smart AI.
69 - Alignment with O-RAN Strategy to enable new RAN use cases
70 - Continued Cloud Native evolution with a rich feature set for CNF
71   orchestration capabilities
72 - Next level of functionality for 5G use cases including Network Slicing,
73   Performance management, SON, and CCVPN
74 - A second generation of control loop automation architecture
75 - New Network Function lifecycle management features based on real-life use
76   cases
77 - New functionality for complex network configuration management
78 - Flexibility in resource onboarding with choice of modeling including SDC AID,
79   ETSI SOL001
80 - Software quality and security improvements based on deployment experience
81
82 Functional Requirements
83 -----------------------
84
85 Increased Cloud Native Functionality
86 ....................................
87 Information about created CNF resources in k8s cluster are now available. This
88 information can be utilized later on i.e. in closed-loop context. CNF
89 Healthcheck Workflow in SO will let to monitor the status of CNF deployed into
90 k8s cluster and whether it is healthy or not. Further changes in k8splugin
91 related to Helm specification support allow for the better and more reliable
92 deployment of complex CNFs defined as a Helm package. ONAP now supports
93 Helm 3.5 package specification.
94
95 E2E Network Slicing
96 ...................
97
98 - Support for NSMF (Network Slice Management Function) based TN
99   (Transport Network) slices in which NSMF is responsible for TN-FH (FrontHaul)
100   and TN-MH (MidHaul) allocation
101 - RAN NSSMF (Network Slice Subnet Management Function) integration with CPS
102   (Configuration Persistence Service) and handled closed loop impacts
103 - POC on A1-interface for closed loop updates
104 - KPI Monitoring enhancements
105
106 Intent-based networking
107 .......................
108 The Intent Based Networking (IBN) use case includes the development of an
109 intent framework that contains intent modeling, intent translation, intent
110 execution and intent decision making. The intent UI is implemented in UUI
111 and the components of the intent framework interact with many components of
112 ONAP including SO, A&AI, Policy, DCAE, and CDS.
113
114 Control Loop evolutions
115 .......................
116
117 - CLAMP functionality is merged into Policy Framework project
118 - Control Loops can be defined and described in Metadata using TOSCA. Control
119   loops can run on the fly on any component that implements  a *participant*
120   API. Control Loops can be commissioned into Policy/CLAMP, they can be
121   parameterized, initiated on arbitrary participants, activated and monitored
122 - Policy Handling Improvements: Support delta policies in PDPs
123 - CLAMP Client Policy and TOSCA Handling
124 - Policy Handling Improvements
125 - System Attribute Improvements
126
127 Fault management
128 ................
129
130 - Updates in fault management reporting and fault handling to be in line with
131   VES 7.2, 3GPP and smoother future alignment with O1 for OOF-SON
132 - Performance Management data collection control provides 5G network operators
133   with a dynamic and more efficient way to configure performance measurement
134   collection on a selected subset of PNFs/VNFs in the network and complements
135   the existing PM data collection and processing capabilities in ONAP/DCAE
136 - Simplified deployment for DCAE services via Helm
137 - Reduction on ONAP/DCAE footprint under transformation initiative by
138   deprecating Cloudify based platform components and Consul
139 - VES 7.2.1 integration for HV_VES enables ONAP, 3GPP, ORAN alignment
140 - Enhancements for Network Slicing, Bulk PM, OOF-SON usecases
141
142 Extended O-RAN Integration
143 ..........................
144
145 - Improvements for managing A1 Policies and terminating the A1 interface for
146   A1 Policies
147 - A1 Adapter and A1 Policy Managements Enhancements
148
149 Controllers
150 ...........
151
152 - SDN-C is based on OpenDaylight major release upgrade (Silicon)
153 - Enhancements to CCVPN, Network Slicing, and ONAP A1 Interface
154
155 Service Design
156 ..............
157
158 - SDC can be used for onboarding resources and designing services with models
159   other than SDC AID
160
161 Inventory
162 .........
163
164 - Model updates as part of CCVPN Transport Slicing Feature
165 - Model updates as part of Smart Intent Guarantee based on IBN Feature
166 - Model updates as part of CNF Orchestration Feature
167
168 ONAP Operations Manager
169 .......................
170
171 - IPv4 / IPv6 dual stack support in ONAP: support for Kubernetes 1.20+
172   DualStack networking properties in ONAP K8S Service spec properties.
173   Upgraded EJBCA CMP v2 server to version 7.x
174 - CMPv2 enhancements: certificate update implemented using Key Update Request
175   (KUR) and Certificate Request (CR) CMPv2 messages
176
177 Non-Functional Requirements
178 ---------------------------
179
180 The following 'non-functional' requirements are followed in the
181 Istanbul Release:
182
183 Best Practice
184 .............
185
186 - ONAP shall use STDOUT for logs collection
187 - IPv4/IPv6 dual stack support in ONAP
188 - Containers must crash properly when a failure occurs
189 - Containers must have no more than one main process
190 - Application config should be fully prepared before starting the
191   application container
192 - No root (superuser) access to database from application container
193
194 Code Quality
195 ............
196
197 - Each ONAP project shall improve its CII Badging score by improving input
198   validation and documenting it in their CII Badging site
199 - Each ONAP project shall define code coverage improvements and achieve at
200   least 55% code coverage
201
202 Security
203 ........
204
205 - Python language 3.8
206 - Java language v11
207 - All containers must run as non-root user
208 - Continue hardcoded passwords removal
209 - Flow management must be activated for ONAP
210 - Each project will update the vulnerable direct dependencies in their code
211   base
212
213 Documentation
214 .............
215
216 - Interactive architecture map including short description and link to detailed
217   documentation for every architecture building block
218 - Changes in the Sphinx configuration for all contributing projects
219 - Guide to set up a documentation development environment with preview function
220
221 Tests
222 .....
223
224 - New E2E tests: basic_cnf
225 - New tests: CPS healthcheck
226 - Stability tests: basic_vm and basic_onboard
227
228 .. important::
229    Some non-functional requirements are not fully finalized. Please, check details
230    on the :ref:`Integration<onap-integration:release_non_functional_requirements>`
231
232 Project Specific Release Notes
233 ==============================
234 ONAP releases are specified by a list of project artifact versions in the
235 project repositories and docker container image versions listed in the OOM
236 Helm charts.
237
238 Each project provides detailed :ref:`release notes<doc-releaserepos>`
239 and prepends to these if/when any updated versions the project team believes
240 are compatible with a major release are made available.
241
242 Documentation
243 =============
244 ONAP Istanbul Release provides a set selection of documents,
245 see :ref:`ONAP Documentation<master_index>`.
246
247 The `developer wiki <http://wiki.onap.org>`_ remains a good source of
248 information on meeting plans and notes from committees, project teams and
249 community events.
250
251 Security Notes
252 ==============
253 Details about discovered and mitigated vulnerabilities are in
254 :ref:`ONAP Security <onap-osa:onap-security>`
255
256 ONAP has adopted the `CII Best Practice Badge Program <https://bestpractices.coreinfrastructure.org/en>`_.
257
258 - `Badging Requirements <https://github.com/coreinfrastructure/best-practices-badge>`_
259 - `Badging Status for all ONAP projects <https://bestpractices.coreinfrastructure.org/en/projects?q=onap>`_
260
261 In the Istanbul release,
262
263 - 100% projects passed 90% of the CII badge
264 - 85% projects passed the CII badge
265 - 11% projects passed the CII Silver badge
266
267 Project specific details are in the :ref:`release notes<doc-releaserepos>` for
268 each project.
269
270 .. index:: maturity
271
272 ONAP Maturity Testing Notes
273 ===========================
274 For the Istanbul release, ONAP continues to improve in multiple areas of
275 Scalability, Security, Stability and Performance (S3P) metrics.
276
277 In Istanbul the Integration team focussed in
278
279 - Automating ONAP Testing to improve the overall quality
280 - Adding security and E2E tests
281
282 More details in :ref:`ONAP Integration Project<onap-integration:master_index>`
283
284 Known Issues and Limitations
285 ============================
286 Known Issues and limitations are documented in each
287 :ref:`project Release Notes <doc-releaserepos>`.