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`` 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
  21 Release Data
  22 ============
  23
  24 +---------------------------+-------------------------------------------------+
  25 | **Project**               | MultiCloud                                      |
  26 |                           |                                                 |
  27 +---------------------------+-------------------------------------------------+
  28 | **Docker images**         | onap/multicloud-framework:1.6.0                 |
  29 |                           | onap/multicloud-framework-artifactbroker:1.6.0  |
  30 |                           | onap/multicloud-openstack-starlingx:1.5.5       |
  31 |                           | onap/multicloud-openstack-windriver:1.5.5       |
  32 |                           | onap/multicloud-openstack-fcaps:1.5.5           |
  33 |                           | onap/multicloud-openstack-pike:1.5.5            |
  34 |                           | onap/multicloud-k8s:0.8.0                       |
  35 +---------------------------+-------------------------------------------------+
  36 | **Release designation**   | honolulu 8.0.0                                  |
  37 |                           |                                                 |
  38 +---------------------------+-------------------------------------------------+
  39
  40
  41 New features
  42 ------------
  43
  44 New features in k8s Plugin:
  45 - 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.
  46
  47 - 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.
  48
  49 - 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
  50
  51 **Bug fixes**
  52
  53 N/A
  54
  55 **Known Issues**
  56
  57 - `MULTICLOUD-359 <https://jira.onap.org/browse/MULTICLOUD-359>`_
  58   MultiCloud OpenStack: image creating API cannot handle large image file
  59
  60 - `MULTICLOUD-421 <https://jira.onap.org/browse/MULTICLOUD-421>`_
  61   MultiCloud OpenStack: API request to multicloud with authorization header will be rejected
  62
  63 - `MULTICLOUD-601 <https://jira.onap.org/browse/MULTICLOUD-601>`_
  64   MultiCloud k8s: move to sigs yaml from ghodss
  65
  66 - `MULTICLOUD-661 <https://jira.onap.org/browse/MULTICLOUD-661>`_
  67   MultiCloud k8s: OVN Installation issues
  68
  69 - `MULTICLOUD-661 <https://jira.onap.org/browse/MULTICLOUD-661>`_
  70   MultiCloud k8s: OVN Installation issues
  71
  72 - `MULTICLOUD-1269 <https://jira.onap.org/browse/MULTICLOUD-1269>`_
  73   MultiCloud k8s: K8s Plugins keeps failed RB Instance
  74
  75 - `MULTICLOUD-1295 <https://jira.onap.org/browse/MULTICLOUD-1295>`_
  76   MultiCloud k8s: Bug in Multicloud K8S Plugin Detemplating
  77
  78 - `MULTICLOUD-1307 <https://jira.onap.org/browse/MULTICLOUD-1307>`_
  79   MultiCloud k8s: Query API issues
  80
  81 - `MULTICLOUD-1308 <https://jira.onap.org/browse/MULTICLOUD-1308>`_
  82   MultiCloud k8s: Healthcheck API Exception
  83
  84 - `MULTICLOUD-1311 <https://jira.onap.org/browse/MULTICLOUD-1311>`_
  85   MultiCloud k8s: Creation of Config from CDS fails
  86
  87 - `MULTICLOUD-1312 <https://jira.onap.org/browse/MULTICLOUD-1312>`_
  88   MultiCloud k8s: Query API returns 500 instead of 404
  89
  90
  91 Deliverables
  92 ------------
  93
  94 Software Deliverables
  95 ~~~~~~~~~~~~~~~~~~~~~
  96
  97
  98 Documentation Deliverables
  99 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 100
 101
 102 Known Limitations, Issues and Workarounds
 103 =========================================
 104
 105 System Limitations
 106 ------------------
 107
 108 N/A
 109
 110
 111 Known Vulnerabilities
 112 ---------------------
 113
 114
 115 MULTICLOUD code has been formally scanned during build time using NexusIQ and
 116 all Critical vulnerabilities have been addressed, items that remain open have
 117 been assessed for risk and determined to be false positive.
 118
 119 The MULTICLOUD open Critical security vulnerabilities and their risk
 120 assessment have been documented as part of the
 121 `project
 122 <https://wiki.onap.org/pages/viewpage.action?pageId=68541501>`_.
 123
 124
 125 Workarounds
 126 -----------
 127
 128 N/A
 129
 130
 131 Security Notes
 132 --------------
 133
 134 **Fixed Security Issues**
 135
 136 N/A
 137
 138 **Known Security Issues**
 139
 140 N/A
 141
 142 Test Results
 143 ============
 144
 145 N/A
 146
 147 References
 148 ==========
 149
 150 For more information on the ONAP ``guilin`` release, please see:
 151
 152 #. `ONAP Home Page`_
 153 #. `ONAP Documentation`_
 154 #. `ONAP Release Downloads`_
 155 #. `ONAP Wiki Page`_
 156
 157
 158 .. _`ONAP Home Page`: https://www.onap.org
 159 .. _`ONAP Wiki Page`: https://wiki.onap.org
 160 .. _`ONAP Documentation`: https://docs.onap.org
 161 .. _`ONAP Release Downloads`: https://git.onap.org
 162
 163
 164 Quick Links
 165 ===========
 166
 167   - `MULTICLOUD project page <https://wiki.onap.org/pages/viewpage.action?pageId=6592841>`_
 168
 169   - `Passing Badge information for MULTICLOUD <https://bestpractices.coreinfrastructure.org/en/projects/1706>`_
 170
 171   - `Project Vulnerability Review Table for Multicloud <https://wiki.onap.org/pages/viewpage.action?pageId=68541501>`_
 172
 173   - `Multicloud K8s Plugin Service APIs <https://wiki.onap.org/display/DW/MultiCloud+K8s-Plugin-service+API's>`_