Update vfc-lcm version and release note
[vfc/nfvo/lcm.git] / docs / release-notes.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. _release_notes:
4
5
6 VF-C Release Notes
7 ==================
8
9 VF-C includes two main components, NFV-O and GVNFM, to implement life cycle
10 management and FCAPS of VNF and NS. VF-C takes part in end to end service
11 orchestration and close loop automation by working with SO, DCAE and Policy.
12 VF-C also provides standard southbound interface to VNFMs and can integrate
13 with multi vendor VNFMs via drivers.
14
15 Version: 1.4.6
16 --------------
17
18 :Release Date: 2022-04-13
19
20 **Bug Fixes**
21
22 - Fix tox test loop in mvn-phase-script.sh
23
24 Released components:
25
26 NFVO
27  - vfc-nfvo-lcm 1.4.6
28  - vfc-nfvo-driver-gvnfm-gvnfmadapter 1.4.4
29  - vfc-nfvo-driver-svnfm-ztedriver 1.4.1
30  - vfc-nfvo-driver-svnfm-huawei 1.4.1
31  - vfc-nfvo-db 1.3.5
32
33 GVNFM
34  - vfc-gvnfm-vnflcm 1.4.3
35  - vfc-gvnfm-vnfmgr 1.4.2
36  - vfc-gvnfm-vnfres 1.4.1
37
38 Version: 1.4.5
39 --------------
40
41 :Release Date: 2022-03-31
42
43 **New Features**
44
45 - update Django version to 3.1.4
46 - Update the vulnerable direct dependencies
47 - Update Docker image to fix CSIT Failure
48
49 Released components:
50
51 NFVO
52  - vfc-nfvo-lcm 1.4.5
53  - vfc-nfvo-driver-gvnfm-gvnfmadapter 1.4.4
54  - vfc-nfvo-driver-svnfm-ztedriver 1.4.1
55  - vfc-nfvo-driver-svnfm-huawei 1.4.1
56  - vfc-nfvo-db 1.3.5
57
58 GVNFM
59  - vfc-gvnfm-vnflcm 1.4.3
60  - vfc-gvnfm-vnfmgr 1.4.2
61  - vfc-gvnfm-vnfres 1.4.1
62
63 Version: 1.4.4
64 --------------
65
66 :Release Date: 2021-09-02
67
68 **New Features**
69
70 1. Packages upgrades in direct dependencies, such as PyYAML & httplib2
71 2. Remove Python 2.7 from docker image of huawei vnfm driver
72 3. Optimize the docker image of VFC db
73
74 Released components:
75
76 NFVO
77  - vfc-nfvo-lcm 1.4.4
78  - vfc-nfvo-driver-gvnfm-gvnfmadapter 1.4.2
79  - vfc-nfvo-driver-svnfm-ztedriver 1.4.1
80  - vfc-nfvo-driver-svnfm-huawei 1.4.1
81  - vfc-nfvo-db 1.3.5
82
83 GVNFM
84  - vfc-gvnfm-vnflcm 1.4.2
85  - vfc-gvnfm-vnfmgr 1.4.1
86  - vfc-gvnfm-vnfres 1.4.0
87
88
89 Version: 1.4.3
90 --------------
91
92 :Release Date: 2021-03-24
93
94 **New Features**
95
96 1. Refactor logging to remove dependency on onaplogging component
97 2. Update to Python 3.8
98 3. Update documents
99
100 Released components:
101
102 NFVO
103  - vfc-nfvo-lcm 1.4.2
104  - vfc-nfvo-driver-gvnfm-gvnfmadapter 1.4.1
105  - vfc-nfvo-driver-svnfm-ztedriver 1.4.0
106  - vfc-nfvo-driver-svnfm-huawei 1.3.9
107  - vfc-nfvo-db 1.3.4
108
109 GVNFM
110  - vfc-gvnfm-vnflcm 1.4.1
111  - vfc-gvnfm-vnfmgr 1.4.0
112  - vfc-gvnfm-vnfres 1.3.9
113
114
115 Version: 1.4.1
116 --------------
117
118 :Release Date: 2020-10-29
119
120 **New Features**
121
122 - Functional Enhancement:
123
124 1. Improve instance storage function
125 2. Remove components which are no longer used or maintained.
126
127 - Maturity Enhancement:
128
129 1. Update to Java 11
130 2. Optimize docker image
131 3. Update dependency lib
132 4. Increase code coverage
133
134
135 Released components:
136
137 NFVO
138  - vfc-nfvo-lcm 1.4.1
139  - vfc-nfvo-driver-gvnfm-gvnfmadapter 1.4.0
140  - vfc-nfvo-driver-svnfm-ztedriver 1.3.8
141  - vfc-nfvo-driver-svnfm-huawei 1.3.8
142  - vfc-nfvo-db 1.3.4
143
144 GVNFM
145  - vfc-gvnfm-vnflcm 1.4.0
146  - vfc-gvnfm-vnfmgr 1.3.9
147  - vfc-gvnfm-vnfres 1.3.8
148
149 **Known Issues**
150
151   Though VFC itself has migrated to python 3, however, the deployment of VFC still has python 2.7 pods since it uses public mariadb image. Please refer to: https://jira.onap.org/browse/VFC-1740 for details.
152
153
154 **Security Notes**
155     NA
156
157 Quick Links:
158
159 - `VFC project page <https://wiki.onap.org/display/DW/Virtual+Function+Controller+Project>`_
160 - `Passing Badge information for VFC <https://bestpractices.coreinfrastructure.org/en/projects/1608>`_
161
162 **Upgrade Notes**
163     NA
164
165 **Deprecation Notes**
166
167  The following components are not in the scope of the Guilin release since they are no longer used or maintained.
168
169  - vfc/nfvo/driver/ems
170  - vfc/nfvo/multivimproxy
171  - vfc/nfvo/driver/vnfm/gvnfm/juju
172  - vfc/nfvo/driver/vnfm/svnfm/nokia
173  - vfc/nfvo/wfengine
174  - vfc/nfvo/driver/sfc
175
176 **Other**
177     NA
178
179
180 Version: 1.3.9
181 --------------
182
183 :Release Date: 2020-03-17
184
185 **New Features**
186
187 - Functional Enhancement:
188
189 1. Migrate VF-C catalog to Modeling etsicatalog 
190 2. Using the common database (MariaDB) and encrypting the database password.
191 3. Remove the root permission and change the user of VFC project to ONAP.
192 4. Add the function of auto register MSB switch for startup project.
193 5. Increase the communication access form between components through the HTTPS encrypted access form of MSB.
194 6. SOL005 compliance NS instantiation, query and termination commands have been added to cli.
195
196
197 - Maturity Enhancement:
198
199 1. Enhance the security of database access
200 2. Enhance the stability of instantiation process and improve efficiency and productivity.
201 3. Improve the stability of instance termination process and deletion process, and improve the success rate of subscription record deletion.
202 4. Adapt to MSB https for microservice service registration and access.
203
204
205 Released components:
206
207 NFVO
208  - vfc-nfvo-lcm 1.3.9
209  - vfc-nfvo-resmanagement 1.3.1
210  - vfc-nfvo-driver-gvnfm-gvnfmadapter 1.3.9
211  - vfc-nfvo-driver-gvnfm-juju 1.3.9
212  - vfc-nfvo-driver-svnfm-ztedriver 1.3.6
213  - vfc-nfvo-driver-svnfm-huawei 1.3.6
214  - vfc-nfvo-driver-svnfm-Nokia2 1.3.6
215  - vfc-nfvo-db 1.3.3
216  - vfc-nfvo-sfc 1.3.1
217  - vfc-nfvo-ems 1.3.1
218  - vfc-nfvo-multivimproxy 1.3.1
219  - vfc-nfvo-wfengine-mgrservice 1.3.3
220  - vfc-nfvo-wfengine-activiti 1.3.3
221
222 GVNFM
223  - vfc-gvnfm-vnflcm 1.3.9
224  - vfc-gvnfm-vnfmgr 1.3.8
225  - vfc-gvnfm-vnfres 1.3.7
226
227 **Bug Fixes**
228
229  - Fix bug for duplication query and delete vserver and network in AAI resource during terminating ns.
230  - Fix terminate ns API is unstable.
231  - Fix bug for fail to delete subscription for vnfm during terminating ns.
232  - Fix the bug for fail parse contextArray, initial it to [].
233  - Fix the deduplication AAI resource issues.
234  - Fix the bug of vim_id data type error when creating vnfs.
235  - Fix the failure of parsing the acquired data format during SFC creation.
236  - Fix the failure of blocking due to multithreading during instantiation.
237
238 **Known Issues**
239
240
241 **Security Notes**
242     NA
243
244 Quick Links:
245
246 - `VFC project page <https://wiki.onap.org/display/DW/Virtual+Function+Controller+Project>`_
247 - `Passing Badge information for VFC <https://bestpractices.coreinfrastructure.org/en/projects/1608>`_
248 - `CLI command about VFC operation <https://onap.readthedocs.io/en/latest/submodules/vfc/nfvo/lcm.git/docs/platform/cli-userguide/index.html#vfc-part>`_
249
250 **Upgrade Notes**
251     NA
252
253 **Deprecation Notes**
254     NA
255
256 **Other**
257     NA
258
259
260
261
262 Version: 1.3.4
263 --------------
264
265 :Release Date: 2019-08-20
266
267 **New Features**
268
269 - Functional Enhancement:
270
271 1. Upgrade component environments from Python 2 to Python 3 and upgrade package dependencies to stable versions
272 2. Good connectivity and stability of information transmission between nslcm drivers and vnflcm
273 3. Solving Layer_protocol Protocol Protocol Supporting Uniformity and Increasing Compatibility
274
275 - Standard Alignment-SOL005 Alignment
276
277 - Maturity Enhancement:
278
279 1. Increase read and write stability of AAI interaction
280 2. Enhance the stability of vnflcm and nslcm message subscription notification function
281 3. Enhance the reliability of MSB registration information and message reading
282
283
284
285 Released components:
286
287 NFVO
288  - vfc-nfvo-lcm 1.3.4
289  - vfc-nfvo-catalog 1.3.4
290  - vfc-nfvo-driver-gvnfm-gvnfmadapter 1.3.5
291  - vfc-nfvo-driver-svnfm-ztedriver 1.3.3
292  - vfc-nfvo-db 1.3.1
293 GVNFM
294  - vfc-gvnfm-vnflcm 1.3.4
295  - vfc-gvnfm-vnfmgr 1.3.4
296  - vfc-gvnfm-vnfres 1.3.4
297
298 **Bug Fixes**
299
300  - Fix bug for failure in creating subscriptions for vnfm
301  - Fix network name conflict problem when creating network writing to AAI
302  - Fix bug for failure in creating ns vl to aai
303  - Fix the bug for table NFVO_NSINST field status update incorrect
304
305 **Known Issues**
306
307
308 **Security Notes**
309
310 VFC code has been formally scanned during build time using NexusIQ and all Critical
311 vulnerabilities have been addressed, items that remain open have been assessed
312 for risk and determined to be false positive. The VFC open Critical security
313 vulnerabilities and their risk assessment have been documented as part
314 of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=68542814>`_.
315
316 Quick Links:
317
318 - `VFC project page <https://wiki.onap.org/display/DW/Virtual+Function+Controller+Project>`_
319 - `Passing Badge information for VFC <https://bestpractices.coreinfrastructure.org/en/projects/1608>`_
320 - `Project Vulnerability Review Table for VFC <https://wiki.onap.org/pages/viewpage.action?pageId=68542814>`_
321
322 **Upgrade Notes**
323     NA
324
325 **Deprecation Notes**
326     NA
327
328 **Other**
329     NA
330
331
332
333
334 Version: 1.3.0
335 --------------
336
337 :Release Date: 2019-06-06
338
339 **New Features**
340
341 - Functional Enhancement: 
342
343 1. Upgrade Multicloud API to support consistent identification of cloud region functional requirement 
344 2. OOF Integration Optimization.Optimize the methodology for VNF(vdu) placement, add the process for placement with selected candidates(VIM)
345 3. Align VNFD SOL2.5.1 and model multi-version support
346
347 - Standard Alignment-SOL005 Alignment
348
349 - Maturity Enhancement:
350
351 1. Mysql  DB migrate to OOM shared MariaDB Galera Cluster
352 2. Configuration inject automatically
353 3. Add data persistent storage to avoid data loss due to pod restart
354
355
356
357 Released components:
358
359 NFVO
360  - vfc-nfvo-lcm 1.3.2
361  - vfc-nfvo-catalog 1.3.2
362  - vfc-nfvo-resmgr 1.3.0
363  - vfc-nfvo-driver-emsdriver 1.3.0
364  - vfc-nfvo-driver-gvnfm-gvnfmadapter 1.3.3
365  - vfc-nfvo-driver-gvnfm-jujudriver 1.3.1
366  - vfc-nfvo-driver-svnfm-ztedriver 1.3.1
367  - vfc-nfvo-driver-svnfm-huaweidriver 1.3.0
368  - vfc-nfvo-driver-svnfm-nokiav2driver 1.3.1
369  - vfc-nfvo-driver-sfc-ztesfcdriver 1.3.1
370  - vfc-nfvo-multivimproxy 1.3.0
371  - vfc-nfvo-db 1.3.0
372 GVNFM
373  - vfc-gvnfm-vnflcm 1.3.2
374  - vfc-gvnfm-vnfmgr 1.3.2
375  - vfc-gvnfm-vnfres 1.3.2
376 Workflow
377  - workflow-engine-mgr-service 1.3.0
378  - activiti-extension 1.3.0
379
380 **Bug Fixes**
381
382 **Known Issues**
383
384  - `VFC-1402 <https://jira.onap.org/browse/VFC-1402>`_ Lost connection to Mariadb server during query in vnflcm.
385  - `VFC-1411 <https://jira.onap.org/browse/VFC-1411>`_ The network can not be deleted in ns terminate.
386
387 **Security Notes**
388
389 VFC code has been formally scanned during build time using NexusIQ and all Critical
390 vulnerabilities have been addressed, items that remain open have been assessed
391 for risk and determined to be false positive. The VFC open Critical security
392 vulnerabilities and their risk assessment have been documented as part
393 of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=51282550>`_.
394
395 Quick Links:
396
397 - `VFC project page <https://wiki.onap.org/display/DW/Virtual+Function+Controller+Project>`_
398 - `Passing Badge information for VFC <https://bestpractices.coreinfrastructure.org/en/projects/1608>`_
399 - `Project Vulnerability Review Table for VFC <https://wiki.onap.org/pages/viewpage.action?pageId=51282550>`_
400
401 **Upgrade Notes**
402         NA
403
404 **Deprecation Notes**
405         NA
406
407 **Other**
408         NA
409
410 Version: 1.2.0
411 --------------
412
413 :Release Date: 2018-11-30
414
415 **New Features**
416
417 - NS Orchestration supports PNF:1.NSLCM supports NSD, composed of VNF, PNF, and VL;2.Catalog supports PNFD and updates NSD DM
418 - Hardware Platform Awareness (HPA) Support:1.integrate with OOF;2.VF-C can parse R2+ TOSCA MODEL which includes HPA feature
419 - Standard Alignment:SOL003 Alignment in GVNFM and Catalog
420 - Standalone DB Microservice
421
422 Released components:
423
424 NFVO
425  - vfc-nfvo-lcm 1.2.2
426  - vfc-nfvo-catalog 1.2.2
427  - vfc-nfvo-resmgr 1.2.1
428  - vfc-nfvo-driver-emsdriver 1.2.1
429  - vfc-nfvo-driver-gvnfm-gvnfmadapter 1.2.2
430  - vfc-nfvo-driver-gvnfm-jujudriver 1.2.1
431  - vfc-nfvo-driver-svnfm-ztedriver 1.2.1
432  - vfc-nfvo-driver-svnfm-huaweidriver 1.2.1
433  - vfc-nfvo-driver-svnfm-nokiav2driver 1.2.1
434  - vfc-nfvo-driver-sfc-ztesfcdriver 1.2.0
435  - vfc-nfvo-multivimproxy 1.2.1
436  - vfc-nfvo-db 1.2.2
437 GVNFM
438  - vfc-gvnfm-vnflcm 1.2.2
439  - vfc-gvnfm-vnfmgr 1.2.1
440  - vfc-gvnfm-vnfres 1.2.1
441 Workflow
442  - workflow-engine-mgr-service
443  - activiti-extension
444
445 **Bug Fixes**
446
447 **Known Issues**
448
449  - `VFC-896 <https://jira.onap.org/browse/VFC-896>`_  vim-id in AAI is handled as a mandatory parameter
450  - `VFC-890 <https://jira.onap.org/browse/VFC-890>`_  The hard coded SDC user and password in catalog & LCM is not present in SDC
451  - `VFC-891 <https://jira.onap.org/browse/VFC-891>`_  The AAI credentials is hard coded in LCM
452  - SDC-1897 - Parser exported CSAR with error OPEN (Will be fixed at Dublin),VFC could ignore that error. To ignore that error, we need either apply the patch at https://jira.opnfv.org/browse/PARSER-187 locally in nfv-toscaparser which VFC uses or wait for nfv-toscaparser got that fixed.
453
454 **Security Notes**
455
456 VFC code has been formally scanned during build time using NexusIQ and all Critical
457 vulnerabilities have been addressed, items that remain open have been assessed
458 for risk and determined to be false positive. The VFC open Critical security
459 vulnerabilities and their risk assessment have been documented as part
460 of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=45298878>`_.
461
462 Quick Links:
463
464 - `VFC project page <https://wiki.onap.org/display/DW/Virtual+Function+Controller+Project>`_
465 - `Passing Badge information for VFC <https://bestpractices.coreinfrastructure.org/en/projects/1608>`_
466 - `Project Vulnerability Review Table for VFC <https://wiki.onap.org/pages/viewpage.action?pageId=45298878>`_
467
468 **Upgrade Notes**
469         NA
470
471 **Deprecation Notes**
472         NA
473
474 **Other**
475         NA
476
477 Version: 1.1.0
478 --------------
479
480 :Release Date: 2018-06-07
481
482 **New Features**
483
484 - NS/VNF manual scaling supporting for VoLTE use case
485 - VNF Integration, integration with VNF via GVNFM
486 - S3P improvement
487
488 Released components:
489
490 NFVO
491  - vfc-nfvo-lcm
492  - vfc-nfvo-catalog
493  - vfc-nfvo-resmgr
494  - vfc-nfvo-driver-emsdriver
495  - vfc-nfvo-driver-gvnfm-gvnfmadapter
496  - vfc-nfvo-driver-gvnfm-jujudriver
497  - vfc-nfvo-driver-svnfm-ztedriver
498  - vfc-nfvo-driver-svnfm-huaweidriver
499  - vfc-nfvo-driver-svnfm-nokiadriver
500  - vfc-nfvo-driver-svnfm-nokiav2driver
501  - vfc-nfvo-driver-sfc-ztesfcdriver
502  - vfc-nfvo-multivimproxy
503 GVNFM
504  - vfc-gvnfm-vnflcm
505  - vfc-gvnfm-vnfmgr
506  - vfc-gvnfm-vnfres
507 Workflow
508  - workflow-engine-mgr-service
509  - activiti-extension
510
511 **Bug Fixes**
512
513 This is the initial release
514
515 **Known Issues**
516
517  - `VFC-896 <https://jira.onap.org/browse/VFC-896>`_  vim-id in AAI is handled as a mandatory parameter
518  - `VFC-890 <https://jira.onap.org/browse/VFC-890>`_  The hard coded SDC user and password in catalog & LCM is not present in SDC
519  - `VFC-891 <https://jira.onap.org/browse/VFC-891>`_  The AAI credentials is hard coded in LCM
520
521 **Security Notes**
522
523 VFC code has been formally scanned during build time using NexusIQ and all Critical
524 vulnerabilities have been addressed, items that remain open have been assessed
525 for risk and determined to be false positive. The VFC open Critical security
526 vulnerabilities and their risk assessment have been documented as part
527 of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=25437810>`_.
528
529 Quick Links:
530
531 - `VFC project page <https://wiki.onap.org/display/DW/Virtual+Function+Controller+Project>`_
532 - `Passing Badge information for VFC <https://bestpractices.coreinfrastructure.org/en/projects/1608>`_
533 - `Project Vulnerability Review Table for VFC <https://wiki.onap.org/pages/viewpage.action?pageId=25437810>`_
534
535 **Upgrade Notes**
536         NA
537
538 **Deprecation Notes**
539         NA
540
541 **Other**
542         NA
543
544 Version: 1.0.0
545 --------------
546
547 :Release Date: 2017-11-16
548
549 **New Features**
550
551 - NS lifecycle management, including NS instance creation, termination and healing
552 - VNF lifecycle management, including VNF instance creation, termination and healing
553 - VNF FCAPS, collecting FCAPS data from vendor EMS
554 - VNFM Integration, integration with specific VNFMs of vendors to deploy commercial VNFs
555 - VNF Integration, integration with VNF via GVNFM
556
557 Released components:
558
559 NFVO
560  - vfc-nfvo-lcm
561  - vfc-nfvo-catalog
562  - vfc-nfvo-resmgr
563  - vfc-nfvo-driver-emsdriver
564  - vfc-nfvo-driver-gvnfm-gvnfmadapter
565  - vfc-nfvo-driver-gvnfm-jujudriver
566  - vfc-nfvo-driver-svnfm-ztedriver
567  - vfc-nfvo-driver-svnfm-huaweidriver
568  - vfc-nfvo-driver-svnfm-nokiadriver
569  - vfc-nfvo-driver-sfc-ztesfcdriver
570 GVNFM
571  - vfc-gvnfm-vnflcm
572  - vfc-gvnfm-vnfmgr
573  - vfc-gvnfm-vnfres
574 Workflow
575  - workflow-engine-mgr-service
576  - activiti-extension
577
578 **Bug Fixes**
579
580 This is the initial release
581
582 **Known Issues**
583
584 None
585
586 **Security Issues**
587
588 None
589
590 **Upgrade Notes**
591
592 This is the initial release
593
594 **Deprecation Notes**
595
596 This is the initial release
597
598 **Other**
599         NA
600
601 ===========
602
603 End of Release Notes