docs/release-notes.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0
   2    International License.
   3 .. http://creativecommons.org/licenses/by/4.0
   4 .. (c) ONAP Project and its contributors
   5 .. _release_notes:
   6
   7 ************************
   8 MultiCloud Release Notes
   9 ************************
  10
  11 Abstract
  12 ========
  13
  14 This document provides the release notes for the ``honolulu`` maintenance release.
  15
  16 Summary
  17 =======
  18
  19 This release introduces new features into k8s plugin that enhance Day 2 configuration support for k8s resources and brings features for monitoring of CNF health.
  20 Maintenance Release provided additional changes compared to Honolulu release in k8splugin (see Bug fixes and Docker images sections).
  21
  22 Release Data
  23 ============
  24
  25 +---------------------------+-------------------------------------------------+
  26 | **Project**               | MultiCloud                                      |
  27 |                           |                                                 |
  28 +---------------------------+-------------------------------------------------+
  29 | **Docker images**         | onap/multicloud-framework:1.6.0                 |
  30 |                           | onap/multicloud-framework-artifactbroker:1.6.0  |
  31 |                           | onap/multicloud-openstack-starlingx:1.5.5       |
  32 |                           | onap/multicloud-openstack-windriver:1.5.5       |
  33 |                           | onap/multicloud-openstack-fcaps:1.5.5           |
  34 |                           | onap/multicloud-openstack-pike:1.5.5            |
  35 |                           | **onap/multicloud-k8s:0.8.2**                   |
  36 +---------------------------+-------------------------------------------------+
  37 | **Release designation**   | honolulu 8.1.0                                  |
  38 |                           |                                                 |
  39 +---------------------------+-------------------------------------------------+
  40
  41
  42 New features
  43 ------------
  44
  45 New features in k8s Plugin:
  46 - Refined Configuration API allows for flexible modification of the CNF configuration. Configuration API allows to create, modify and delete k8s resource templates and it allows their parameterization base on dedicated or inherited from the CNF instance input parameters.
  47
  48 - Query API allows for the gathering of the filtered out the status of CNF what can be helpful to get precise information for particular resources belonging to the CNF. Query API produces results in the same format as Status API that offers the full set of information about CNF status.
  49
  50 - HealthCheck API allows for the execution of dedicated healthcheck jobs (similar to helm test operation) that can verify on demand the current status of the CNF. The API can be used also to retrieved the results of healthcheck job execution, which can be extended with Status/Query API
  51
  52 All new the features of k8splugin are explained and showcased as a part of `vFW CNF Use Case <https://docs.onap.org/projects/onap-integration/en/honolulu/docs_vFW_CNF_CDS.html>` and in the k8s API documentation.
  53
  54 **Bug fixes**
  55
  56 - `MULTICLOUD-1295 <https://jira.onap.org/browse/MULTICLOUD-1295>`_
  57   MultiCloud k8s: Bug in Multicloud K8S Plugin Detemplating
  58
  59 - `MULTICLOUD-1338 <https://jira.onap.org/browse/MULTICLOUD-1338>`_
  60   MultiCloud k8s: Foreground delete policy prevents deletion of the pods
  61
  62 - `MULTICLOUD-1348 <https://jira.onap.org/browse/MULTICLOUD-1348>`_
  63   MultiCloud k8s: Regression in Multicloud-k8s
  64
  65 **Known Issues**
  66
  67 - `MULTICLOUD-359 <https://jira.onap.org/browse/MULTICLOUD-359>`_
  68   MultiCloud OpenStack: image creating API cannot handle large image file
  69
  70 - `MULTICLOUD-421 <https://jira.onap.org/browse/MULTICLOUD-421>`_
  71   MultiCloud OpenStack: API request to multicloud with authorization header will be rejected
  72
  73 - `MULTICLOUD-601 <https://jira.onap.org/browse/MULTICLOUD-601>`_
  74   MultiCloud k8s: move to sigs yaml from ghodss
  75
  76 - `MULTICLOUD-661 <https://jira.onap.org/browse/MULTICLOUD-661>`_
  77   MultiCloud k8s: OVN Installation issues
  78
  79 - `MULTICLOUD-1269 <https://jira.onap.org/browse/MULTICLOUD-1269>`_
  80   MultiCloud k8s: K8s Plugins keeps failed RB Instance
  81
  82 - `MULTICLOUD-1312 <https://jira.onap.org/browse/MULTICLOUD-1312>`_
  83   MultiCloud k8s: Query API returns 500 instead of 404
  84
  85 - `MULTICLOUD-1329 <https://jira.onap.org/browse/MULTICLOUD-1329>`_
  86   MultiCloud k8s: Redundant data in MongoDB created
  87
  88 - `MULTICLOUD-1330 <https://jira.onap.org/browse/MULTICLOUD-1330>`_
  89   MultiCloud k8s: Consul operation interface problems
  90
  91 - `MULTICLOUD-1331 <https://jira.onap.org/browse/MULTICLOUD-1331>`_
  92   MultiCloud k8s: Instance status update failure
  93
  94 Deliverables
  95 ------------
  96
  97 Software Deliverables
  98 ~~~~~~~~~~~~~~~~~~~~~
  99
 100
 101 Documentation Deliverables
 102 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 103
 104
 105 Known Limitations, Issues and Workarounds
 106 =========================================
 107
 108 System Limitations
 109 ------------------
 110
 111 N/A
 112
 113 Known Vulnerabilities
 114 ---------------------
 115
 116 MULTICLOUD code has been formally scanned during build time using NexusIQ and
 117 all Critical vulnerabilities have been addressed, items that remain open have
 118 been assessed for risk and determined to be false positive.
 119
 120 The MULTICLOUD open Critical security vulnerabilities and their risk
 121 assessment have been documented as part of the
 122 `project
 123 <https://wiki.onap.org/pages/viewpage.action?pageId=68541501>`_.
 124
 125 Workarounds
 126 -----------
 127
 128 N/A
 129
 130 Security Notes
 131 --------------
 132
 133 **Fixed Security Issues**
 134
 135 N/A
 136
 137 **Known Security Issues**
 138
 139 N/A
 140
 141 Test Results
 142 ============
 143
 144 N/A
 145
 146 References
 147 ==========
 148
 149 For more information on the ONAP ``guilin`` release, please see:
 150
 151 #. `ONAP Home Page`_
 152 #. `ONAP Documentation`_
 153 #. `ONAP Release Downloads`_
 154 #. `ONAP Wiki Page`_
 155
 156
 157 .. _`ONAP Home Page`: https://www.onap.org
 158 .. _`ONAP Wiki Page`: https://wiki.onap.org
 159 .. _`ONAP Documentation`: https://docs.onap.org
 160 .. _`ONAP Release Downloads`: https://git.onap.org
 161
 162
 163 Quick Links
 164 ===========
 165
 166   - `MULTICLOUD project page <https://wiki.onap.org/pages/viewpage.action?pageId=6592841>`_
 167
 168   - `Passing Badge information for MULTICLOUD <https://bestpractices.coreinfrastructure.org/en/projects/1706>`_
 169
 170   - `Project Vulnerability Review Table for Multicloud <https://wiki.onap.org/pages/viewpage.action?pageId=68541501>`_
 171
 172   - `Multicloud K8s Plugin Service APIs <https://wiki.onap.org/display/DW/MultiCloud+K8s-Plugin-service+API's>`_