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