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.1                       |
  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 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.
  52
  53 **Bug fixes**
  54
  55 N/A
  56
  57 **Known Issues**
  58
  59 - `MULTICLOUD-359 <https://jira.onap.org/browse/MULTICLOUD-359>`_
  60   MultiCloud OpenStack: image creating API cannot handle large image file
  61
  62 - `MULTICLOUD-421 <https://jira.onap.org/browse/MULTICLOUD-421>`_
  63   MultiCloud OpenStack: API request to multicloud with authorization header will be rejected
  64
  65 - `MULTICLOUD-601 <https://jira.onap.org/browse/MULTICLOUD-601>`_
  66   MultiCloud k8s: move to sigs yaml from ghodss
  67
  68 - `MULTICLOUD-661 <https://jira.onap.org/browse/MULTICLOUD-661>`_
  69   MultiCloud k8s: OVN Installation issues
  70
  71 - `MULTICLOUD-1269 <https://jira.onap.org/browse/MULTICLOUD-1269>`_
  72   MultiCloud k8s: K8s Plugins keeps failed RB Instance
  73
  74 - `MULTICLOUD-1295 <https://jira.onap.org/browse/MULTICLOUD-1295>`_
  75   MultiCloud k8s: Bug in Multicloud K8S Plugin Detemplating
  76
  77 - `MULTICLOUD-1312 <https://jira.onap.org/browse/MULTICLOUD-1312>`_
  78   MultiCloud k8s: Query API returns 500 instead of 404
  79
  80 - `MULTICLOUD-1329 <https://jira.onap.org/browse/MULTICLOUD-1329>`_
  81   MultiCloud k8s: Redundant data in MongoDB created
  82
  83 - `MULTICLOUD-1330 <https://jira.onap.org/browse/MULTICLOUD-1330>`_
  84   MultiCloud k8s: Consul operation interface problems
  85
  86 - `MULTICLOUD-1331 <https://jira.onap.org/browse/MULTICLOUD-1331>`_
  87   MultiCloud k8s: Instance status update failure
  88
  89 Deliverables
  90 ------------
  91
  92 Software Deliverables
  93 ~~~~~~~~~~~~~~~~~~~~~
  94
  95
  96 Documentation Deliverables
  97 ~~~~~~~~~~~~~~~~~~~~~~~~~~
  98
  99
 100 Known Limitations, Issues and Workarounds
 101 =========================================
 102
 103 System Limitations
 104 ------------------
 105
 106 N/A
 107
 108
 109 Known Vulnerabilities
 110 ---------------------
 111
 112
 113 MULTICLOUD code has been formally scanned during build time using NexusIQ and
 114 all Critical vulnerabilities have been addressed, items that remain open have
 115 been assessed for risk and determined to be false positive.
 116
 117 The MULTICLOUD open Critical security vulnerabilities and their risk
 118 assessment have been documented as part of the
 119 `project
 120 <https://wiki.onap.org/pages/viewpage.action?pageId=68541501>`_.
 121
 122
 123 Workarounds
 124 -----------
 125
 126 N/A
 127
 128
 129 Security Notes
 130 --------------
 131
 132 **Fixed Security Issues**
 133
 134 N/A
 135
 136 **Known Security Issues**
 137
 138 N/A
 139
 140 Test Results
 141 ============
 142
 143 N/A
 144
 145 References
 146 ==========
 147
 148 For more information on the ONAP ``guilin`` release, please see:
 149
 150 #. `ONAP Home Page`_
 151 #. `ONAP Documentation`_
 152 #. `ONAP Release Downloads`_
 153 #. `ONAP Wiki Page`_
 154
 155
 156 .. _`ONAP Home Page`: https://www.onap.org
 157 .. _`ONAP Wiki Page`: https://wiki.onap.org
 158 .. _`ONAP Documentation`: https://docs.onap.org
 159 .. _`ONAP Release Downloads`: https://git.onap.org
 160
 161
 162 Quick Links
 163 ===========
 164
 165   - `MULTICLOUD project page <https://wiki.onap.org/pages/viewpage.action?pageId=6592841>`_
 166
 167   - `Passing Badge information for MULTICLOUD <https://bestpractices.coreinfrastructure.org/en/projects/1706>`_
 168
 169   - `Project Vulnerability Review Table for Multicloud <https://wiki.onap.org/pages/viewpage.action?pageId=68541501>`_
 170
 171   - `Multicloud K8s Plugin Service APIs <https://wiki.onap.org/display/DW/MultiCloud+K8s-Plugin-service+API's>`_