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