aboutsummaryrefslogtreecommitdiffstats
path: root/docs/sections/release-notes.rst
blob: 4c67ae3943e3017d67e488dfc24116efaf652682 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
..
 This work is licensed under a Creative Commons Attribution 4.0
 International License.
.. _release_notes:

=============
Release Notes
=============

..      ===========================
..      * * *   HONOLULU  * * *
..      ===========================

Abstract
========

This document provides the release notes for the Honolulu release.

Summary
=======


Release Data
============


+--------------------------------------+--------------------------------------+
| **OOF Project**                      |                                      |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Docker images**                    |   optf-osdf 3.0.4                    |
|                                      |                                      |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Release designation**              | 8.0.0 honolulu                       |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Release date**                     | 04/08/2021 (TBD)                     |
|                                      |                                      |
+--------------------------------------+--------------------------------------+


New features
------------

- Add NST selection feature with AAI & SDC
- Configuration management with consul KV store

Bug Fixes
---------

- OPTFRA-906  Update slice/service profile attributes
- OPTFRA-871  Bug Fix in ML SON - convert cell_id before sending it to Minizinc


Known Limitations, Issues and Workarounds
=========================================

System Limitations
------------------


Known Vulnerabilities
---------------------


Workarounds
-----------


Security Notes
--------------


References
==========

For more information on the ONAP Honolulu release, please see:

#. `ONAP Home Page`_
#. `ONAP Documentation`_
#. `ONAP Release Downloads`_
#. `ONAP Wiki Page`_


.. _`ONAP Home Page`: https://www.onap.org
.. _`ONAP Wiki Page`: https://wiki.onap.org
.. _`ONAP Documentation`: https://docs.onap.org
.. _`ONAP Release Downloads`: https://git.onap.org

Quick Links:
    - `OOF project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
    - `Passing Badge information for OOF <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_

..      ===========================
..      * * *   GUILIN   * * *
..      ===========================

Abstract
========

This document provides the release notes for the Guilin release.

Summary
=======


Release Data
============


+--------------------------------------+--------------------------------------+
| **OOF Project**                      |                                      |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Docker images**                    |   optf-osdf 3.0.2                    |
|                                      |                                      |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Release designation**              | 7.0.0 guilin                         |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Release date**                     | 2020-11-19 (TBD)                     |
|                                      |                                      |
+--------------------------------------+--------------------------------------+


New features
------------

- NSI selection enhancements
- Support for NSSI selection
- Support for NSI/NSSI Termination
- Support for Inter domain route optimization
- Support for ML based SON optimization
- Upgrade python version to 3.8

Bug Fixes
---------

- OPTFRA-839  Remove python 2.7 from OSDF docker image
- OPTFRA-855  Fix slice selection API
- OPTFRA-852  Callback implementation for NST selection

Known Limitations, Issues and Workarounds
=========================================

System Limitations
------------------


Known Vulnerabilities
---------------------


Workarounds
-----------


Security Notes
--------------


References
==========

For more information on the ONAP Guilin release, please see:

#. `ONAP Home Page`_
#. `ONAP Documentation`_
#. `ONAP Release Downloads`_
#. `ONAP Wiki Page`_


.. _`ONAP Home Page`: https://www.onap.org
.. _`ONAP Wiki Page`: https://wiki.onap.org
.. _`ONAP Documentation`: https://docs.onap.org
.. _`ONAP Release Downloads`: https://git.onap.org

Quick Links:
    - `OOF project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
    - `Passing Badge information for OOF <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_

..      ===========================
..      * * *    FRANKFURT    * * *
..      ===========================

Abstract
========

This document provides the release notes for the Frankfurt release.

Summary
=======


Release Data
============


+--------------------------------------+--------------------------------------+
| **OOF Project**                      |                                      |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Docker images**                    |   optf-osdf 2.0.4                    |
|                                      |                                      |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Release designation**              | 6.0.0 frankfurt                      |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Release date**                     | 2020-05-07 (TBD)                     |
|                                      |                                      |
+--------------------------------------+--------------------------------------+


New features
------------

- Project is restructured into apps and libs.
- A Generic optimizing engine is implemented.
- New optimizer model for route optimization is added.
- Policy apis are migrated from legacy apis to new decision api.
- The Conductor adapter is moved from placement to adapters.
- NST and NSI selection function has been implemented for Network
  Slicing use case.
- PCI optimization is enhanced to support fixed cells field.

Bug Fixes
---------

- OPTFRA-482 The field "unique" should be defined in vnf policy.
- OPTFRA-729 OSDF fails to start in the k8s environment.
- OPTFRA-731 OSDF Policy interface is not working
- OPTFRA-754 Return slice profile when service profile indicates the
  resource sharing level as not shared
- OPTFRA-755 OOF Policy filtering does not work.

Known Limitations, Issues and Workarounds
=========================================

System Limitations
------------------


Known Vulnerabilities
---------------------


Workarounds
-----------


Security Notes
--------------


References
==========

For more information on the ONAP Frankfurt release, please see:

#. `ONAP Home Page`_
#. `ONAP Documentation`_
#. `ONAP Release Downloads`_
#. `ONAP Wiki Page`_


.. _`ONAP Home Page`: https://www.onap.org
.. _`ONAP Wiki Page`: https://wiki.onap.org
.. _`ONAP Documentation`: https://docs.onap.org
.. _`ONAP Release Downloads`: https://git.onap.org

Quick Links:
    - `OOF project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
    - `Passing Badge information for OOF <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_


Version: 5.0.1
--------------

:Release Date: 2019-09-30 (El Alto Release)

The El Alto release is the fourth release for ONAP Optimization Framework (OOF).

Artifacts released:

optf-has:1.3.3
optf-osdf:1.3.4
optf-cmso:2.1.1

**New Features**

While no new features were added in the release, the following Stories were delivered as enhancements.

    * [OPTFRA-415] Automation on policy model uploading
    * [OPTFRA-427] CMSO - Schedule a workflow in SO and track status to completion

* Platform Maturity Level 1
    * ~65.1+ unit test coverage


**Bug Fixes**

The El Alto release for OOF fixed the following Bugs.

    * [OPTFRA-579] Json error in homing solution
    * [OPTFRA-521] oof-has-api exposes plain text HTTP endpoint using port 30275
    * [OPTFRA-522] oof-osdf exposes plain text HTTP endpoint using port 30248
    * [OPTFRA-577] Need for "ReadWriteMany" access on storage when deploying on Kubernetes?
    * [OPTFRA-517] Clean up optf/cmso in integration/csit for Dublin
    * [OPTFRA-486] Support "identifiers" field as a list of values
    * [OPTFRA-403] OOF CMSO Service kubernetes resources allocation is not done
    * [OPTFRA-526] OOF pods not running
    * [OPTFRA-409] Template example : purpose to be explained
    * [OPTFRA-593] OOF-CSMO healthcheck is failing in Master


**Known Issues**

    * [OPTFRA-576] optf-has-master-csit-has is testing Dublin image
    * [OPTFRA-596] CMSO - Sonar and CSIT jobs failing
    * [OPTFRA-608] Error in Homing with multiple policies

**Security Notes**

*Fixed Security Issues*

    * [OJSI-122] In default deployment OPTFRA (oof-osdf) exposes HTTP port 30248 outside of cluster.
    * [OPTFRA-521] oof-has-api exposes plain text HTTP endpoint using port 30275
    * [OPTFRA-522] oof-osdf exposes plain text HTTP endpoint using port 30248
    * [OPTFRA-455] CMSO - Mitigate License Threat tomcat-embed-core

*Known Security Issues*

    * [OPTFRA-481] Fix Vulnerability with spring-data-jpa package
    * [OPTFRA-431] Fix Vulnerability with spring-security-web package

*Known Vulnerabilities in Used Modules*

**Upgrade Notes**


**Deprecation Notes**


**Other**


Version: 4.0.0
--------------

:Release Date: 2019-06-06 (Dublin Release)

**New Features**

The Dublin release is the third release for ONAP Optimization Framework (OOF).

A summary of features includes

* Support SON (PCI/ANR) optimization using OSDF
* Implement encryption for OSDF internal and external communication

* Platform Maturity Level 1
    * ~65.1+ unit test coverage

The Dublin release for OOF delivered the following Epics.

    * [OPTFRA-426]	Track the changes to CMSO to support change management schedule optimization
    * [OPTFRA-424]	Extend OOF to support traffic distribution optimization
    * [OPTFRA-422]	Move OOF projects' CSIT to run on OOM
    * [OPTFRA-276]	Implementing a POC for 5G SON Optimization
    * [OPTFRA-270]	This epic captures stories related to maintaining current S3P levels of the project as new functional requirements are supported


**Bug Fixes**

* The full list of implemented user stories and epics is available on `DUBLIN RELEASE <https://jira.onap.org/projects/OPTFRA/versions/10463>`_

**Known Issues**



**Security Notes**

*Fixed Security Issues*

*Known Security Issues*

    * [`OJSI-122 <https://jira.onap.org/browse/OJSI-122>`_] In default deployment OPTFRA (oof-osdf) exposes HTTP port 30248 outside of cluster.

*Known Vulnerabilities in Used Modules*

OPTFRA osdf code has been formally scanned during build time using NexusIQ and no Critical vulnerability was found.
The OPTF open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=64005463>`_.

Quick Links:
    - `OPTFRA project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
    - `Passing Badge information for OPTFRA <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
    - `Project Vulnerability Review Table for OPTF <https://wiki.onap.org/pages/viewpage.action?pageId=64005463>`_

**Upgrade Notes**

None.

**Deprecation Notes**

None.

**Other**

None

Version: 3.0.1
--------------

:Release Date: 2019-01-31 (Casablanca Maintenance Release)

The following items were deployed with the Casablanca Maintenance Release:


**New Features**

None.

**Bug Fixes**

* [OPTFRA-401] - 	Need flavor id while launching vm.



Version: 3.0.0
--------------

:Release Date: 2018-11-30 (Casablanca Release)

**New Features**

The Casablanca release is the second release for ONAP Optimization Framework (OOF).

A summary of features includes

* Homing enhancements for improving service deployability
    * Discovering and reusing shared resources when processing multiple homing requests in parallel
    * Considering Latency Reduction (in addition to geographical distances) for homing optimization
    * Enhanced capacity checks during VNF homing
    * Asynchronous communication between HAS components
* OOF Casablanca S3P Usability enhancement
    * Adherence to ONAP API Common Versioning Strategy (CVS) Proposal
    * Move all internal and external facing APIs to Swagger 2.0
* OOF Casablanca S3P Performance enhancements
    * Creating a plan for performance improvements based on the baseline measured metrics
* OOF development platform hardening
    * Deployment scripts
    * Fix Build Docker image script for supporting multiple versions
    * Fix OOM, HEAT deployment scripts (versioning)
    * CSIT functional tests for each repo
    * CI Jobs for different streams (Beijing, master etc)
    * Clean up nexus binaries and maven versioning
* Integrate OOF with Certificate and Secret Management Service (CSM)
* Support SON (PCI) optimization using OSDF

* Platform Maturity Level 1
    * ~65.1+ unit test coverage

The Casablanca release for OOF delivered the following Epics.

    * [OPTFRA-273] - Epic Name: OOF Casablanca S3P Manageability enhancement
    * [OPTFRA-270] - Maintain current S3P levels
    * [OPTFRA-271] - OOF Casablanca S3P Security enhancement
    * [OPTFRA-267] - OOF - HPA Enhancements
    * [OPTFRA-276] - Implementing a POC for 5G SON Optimization


**Bug Fixes**

* The full list of implemented user stories and epics is available on `CASABLANCA RELEASE <https://jira.onap.org/projects/OPTFRA/versions/10445>`_

**Known Issues**

  * [OPTFRA-223] - 	On boarding and testing AAF certificates for OSDF.
  * [OPTFRA-293] - 	Implement encryption for all OSDF internal and external communication
  * [OPTFRA-329] - 	role based access control for OSDF-Policy interface

**Security Notes**

OPTFRA osdf code has been formally scanned during build time using NexusIQ and no Critical vulnerability was found.
The OPTF open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=43385924>`_.

Quick Links:
    - `OPTFRA project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
    - `Passing Badge information for OPTFRA <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
    - `Project Vulnerability Review Table for OPTF <https://wiki.onap.org/pages/viewpage.action?pageId=43385924>`_

**Upgrade Notes**

None.

**Deprecation Notes**

None.

**Other**

None

Version: 2.0.0
--------------

:Release Date: 2018-06-07

**New Features**


The ONAP Optimization Framework (OOF) is new in Beijing. A summary of features includes:

* Baseline HAS functionality
    * support for VCPE use case
    * support for HPA (Hardware Platform Awareness)
* Integration with OOF OSDF, SO, Policy, AAI, and Multi-Cloud
* Platform Maturity Level 1
    * ~50%+ unit test coverage

The Beijing release for OOF delivered the following Epics.

    * [OPTFRA-2] - On-boarding and Stabilization of the OOF seed code
    * [OPTFRA-6] - Integrate OOF with other ONAP components
    * [OPTFRA-7] - Integration with R2 Use Cases [HPA, Change Management, Scaling]
    * [OPTFRA-20] - OOF Adapters for Retrieving and Resolving Policies
    * [OPTFRA-21] - OOF Packaging
    * [OPTFRA-28] - OOF Adapters for Beijing Release (Policy, SDC, A&AI, Multi Cloud, etc.)
    * [OPTFRA-29] - Policies and Specifications for Initial Applications [Change Management, HPA]
    * [OPTFRA-32] - Platform Maturity Requirements for Beijing release
    * [OPTFRA-33] - OOF Support for HPA
    * [OPTFRA-105] - All Documentation Related User Stories and Tasks


**Bug Fixes**

None. Initial release R2 Beijing. No previous versions

**Known Issues**

None.

**Security Notes**

OPTFRA code has been formally scanned during build time using NexusIQ and no Critical vulnerability was found.

Quick Links:
    - `OPTFRA project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
    - `Passing Badge information for OPTFRA <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_

**Upgrade Notes**

None. Initial release R2 Beijing. No previous versions

**Deprecation Notes**

None. Initial release R2 Beijing. No previous versions

**Other**

None