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 ONAP Operations Manager Release Notes
   9 *************************************
  10
  11 Previous Release Notes
  12 ======================
  13
  14 - :ref:`Guilin <release_notes_guilin>`
  15 - :ref:`Frankfurt <release_notes_frankfurt>`
  16 - :ref:`El Alto <release_notes_elalto>`
  17 - :ref:`Dublin <release_notes_dublin>`
  18 - :ref:`Casablanca <release_notes_casablanca>`
  19 - :ref:`Beijing <release_notes_beijing>`
  20 - :ref:`Amsterdam <release_notes_amsterdam>`
  21
  22 Abstract
  23 ========
  24
  25 This document provides the release notes for the Honolulu release Maintenance
  26 Release 1.
  27
  28 Summary
  29 =======
  30
  31 The focus of this release is to fix bugs found after Honolulu release.
  32
  33 Release Data
  34 ============
  35
  36 +--------------------------------------+--------------------------------------+
  37 | **Project**                          | OOM                                  |
  38 |                                      |                                      |
  39 +--------------------------------------+--------------------------------------+
  40 | **Docker images**                    | N/A                                  |
  41 |                                      |                                      |
  42 +--------------------------------------+--------------------------------------+
  43 | **Release designation**              | Honolulu Maintenace Release 1        |
  44 |                                      |                                      |
  45 +--------------------------------------+--------------------------------------+
  46 | **Release date**                     | 2021/10/07                           |
  47 |                                      |                                      |
  48 +--------------------------------------+--------------------------------------+
  49
  50 New features
  51 ------------
  52
  53 **components removal**
  54
  55 - `OOM-2778 <https://jira.onap.org/browse/OOM-2778>`_  [ONAP] Disable APPC default installation
  56
  57
  58 **Bug fixes**
  59
  60 - `POLICY-3232 <https://jira.onap.org/browse/POLICY-3232>`_ Change
  61   import-custom-cert from bash to sh
  62 - `OOM-2779 <https://jira.onap.org/browse/OOM-2779>`_ [DMAAP][DR] Set replica of
  63   Mariadb to 1
  64 - `OOM-2789 <https://jira.onap.org/browse/OOM-2789>`_ [COMMON] Added
  65   imagePullSecrets to common template files with some fix
  66 - `OOM-2762 <https://jira.onap.org/browse/OOM-2762>`_ Add missing DB service
  67   entry for local DB deployment
  68 - `OOM-2748 <https://jira.onap.org/browse/OOM-2748>`_ [SDNC] Fix SDNC charts to
  69   make it work with aaf disabled
  70 - `CCSDK-3275 <https://jira.onap.org/browse/CCSDK-3275>`_ [CDS] Add startup
  71   probe
  72 - `INT-1883 <https://jira.onap.org/browse/INT-1883>`_ [COMMON][MARIADB] Align
  73   conf with camunda needs
  74
  75
  76 **Known Issues**
  77
  78 - `OOM-2554 <https://jira.onap.org/browse/OOM-2554>`_ Common pods have java 8
  79 - `OOM-2435 <https://jira.onap.org/browse/OOM-2435>`_ SDNC karaf shell:
  80   log:list: Error executing command: Unrecognized configuration
  81 - `OOM-2629 <https://jira.onap.org/browse/OOM-2629>`_ NetBox demo entry setup
  82   not complete
  83 - `OOM-2706 <https://jira.onap.org/browse/OOM-2706>`_ CDS Blueprint Processor
  84   does not work with local DB
  85 - `OOM-2713 <https://jira.onap.org/browse/OOM-2713>`_ Problem on onboarding
  86   custom cert to SDNC ONAP during deployment
  87 - `OOM-2698 <https://jira.onap.org/browse/OOM-2698>`_ SO helm override fails in
  88   for value with multi-level replacement
  89 - `OOM-2697 <https://jira.onap.org/browse/OOM-2697>`_ SO with local MariaDB
  90   deployment fails
  91 - `OOM-2538 <https://jira.onap.org/browse/OOM-2538>`_ strange error with
  92   CertInitializer template
  93 - `OOM-2547 <https://jira.onap.org/browse/OOM-2547>`_ Health Check failures
  94   seen after bringing down/up control plane & worker node VM instances on which
  95   ONAP hosted
  96 - `OOM-2699 <https://jira.onap.org/browse/OOM-2699>`_ SO so-mariadb
  97   readinessCheck fails for local MariaDB instance
  98 - `OOM-2705 <https://jira.onap.org/browse/OOM-2705>`_ SDNC DB installation fails
  99   on local MariaDB instance
 100 - `OOM-2603 <https://jira.onap.org/browse/OOM-2603>`_ [SDNC] allign password for
 101   scaleoutUser/restconfUser/odlUser
 102
 103 Abstract
 104 ========
 105
 106 This document provides the release notes for the Honolulu release.
 107
 108 Summary
 109 =======
 110
 111 The focus of this release is to strengthen the foundation of OOM installer.
 112
 113 Release Data
 114 ============
 115
 116 +--------------------------------------+--------------------------------------+
 117 | **Project**                          | OOM                                  |
 118 |                                      |                                      |
 119 +--------------------------------------+--------------------------------------+
 120 | **Docker images**                    | N/A                                  |
 121 |                                      |                                      |
 122 +--------------------------------------+--------------------------------------+
 123 | **Release designation**              | Honolulu                             |
 124 |                                      |                                      |
 125 +--------------------------------------+--------------------------------------+
 126 | **Release date**                     | 2021/04/29                           |
 127 |                                      |                                      |
 128 +--------------------------------------+--------------------------------------+
 129
 130 New features
 131 ------------
 132
 133 * Kubernetes support for version up to 1.20
 134 * Helm support for version up to 3.5
 135 * Limits are set for most of the components
 136 * Portal-Cassandra image updated to Bitnami, supporting IPv4/IPv6 Dual Stack
 137 * CMPv2 external issuer implemented which extends Cert-Manager with ability  to
 138   enroll X.509 certificates from CMPv2 servers
 139 * New version for mariadb galera using Bitnami image, supporting IPv4/IPv6 Dual
 140   Stack
 141 * Bump version of common PostgreSQL and ElasticSearch
 142 * Move to automatic certificates retrieval for 80% of the components
 143 * Consistent retrieval of docker images, with ability to configure proxy for
 144   the 4 repositories used by ONAP
 145
 146 **Bug fixes**
 147
 148 A list of issues resolved in this release can be found here:
 149 https://jira.onap.org/projects/OOM/versions/11073
 150
 151 major issues solved:
 152
 153 * Better handling of persistence on PostgreSQL
 154 * Better Ingress templating
 155 * Better Service templating
 156
 157 **Known Issues**
 158
 159 - `OOM-2554 <https://jira.onap.org/browse/OOM-2554>`_ Common pods have java 8
 160 - `OOM-2435 <https://jira.onap.org/browse/OOM-2435>`_ SDNC karaf shell:
 161   log:list: Error executing command: Unrecognized configuration
 162 - `OOM-2629 <https://jira.onap.org/browse/OOM-2629>`_ NetBox demo entry setup
 163   not complete
 164 - `OOM-2706 <https://jira.onap.org/browse/OOM-2706>`_ CDS Blueprint Processor
 165   does not work with local DB
 166 - `OOM-2713 <https://jira.onap.org/browse/OOM-2713>`_ Problem on onboarding
 167   custom cert to SDNC ONAP during deployment
 168 - `OOM-2698 <https://jira.onap.org/browse/OOM-2698>`_ SO helm override fails in
 169   for value with multi-level replacement
 170 - `OOM-2697 <https://jira.onap.org/browse/OOM-2697>`_ SO with local MariaDB
 171   deployment fails
 172 - `OOM-2538 <https://jira.onap.org/browse/OOM-2538>`_ strange error with
 173   CertInitializer template
 174 - `OOM-2547 <https://jira.onap.org/browse/OOM-2547>`_ Health Check failures
 175   seen after bringing down/up control plane & worker node VM instances on which
 176   ONAP hosted
 177 - `OOM-2699 <https://jira.onap.org/browse/OOM-2699>`_ SO so-mariadb
 178   readinessCheck fails for local MariaDB instance
 179 - `OOM-2705 <https://jira.onap.org/browse/OOM-2705>`_ SDNC DB installation fails
 180   on local MariaDB instance
 181 - `OOM-2603 <https://jira.onap.org/browse/OOM-2603>`_ [SDNC] allign password for
 182   scaleoutUser/restconfUser/odlUser
 183
 184 Deliverables
 185 ------------
 186
 187 Software Deliverables
 188 ~~~~~~~~~~~~~~~~~~~~~
 189
 190 OOM provides `Helm charts <https://git.onap.org/oom/>`_ that needs to be
 191 "compiled" into Helm package. see step 6 in
 192 :doc:`quickstart guide <oom_quickstart_guide>`.
 193
 194 Documentation Deliverables
 195 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 196
 197 - :doc:`Project Description <oom_project_description>`
 198 - :doc:`Cloud Setup Guide <oom_cloud_setup_guide>`
 199 - :doc:`Quick Start Guide <oom_quickstart_guide>`
 200 - :doc:`Setup Ingress Controller <oom_setup_ingress_controller>`
 201 - :doc:`Developer Guide <oom_developer_guide>`
 202 - :doc:`Hardcoded Certificates <oom_hardcoded_certificates>`
 203
 204 Known Limitations, Issues and Workarounds
 205 =========================================
 206
 207 Known Vulnerabilities
 208 ---------------------
 209
 210 - Hard coded password used for all OOM deployments
 211   [`OJSI-188 <https://jira.onap.org/browse/OJSI-188>`_]
 212 - :doc:`Hard coded certificates <oom_hardcoded_certificates>` in Helm packages
 213
 214 Workarounds
 215 -----------
 216
 217 - `<https://github.com/bitnami/bitnami-docker-mariadb-galera/issues/35>`_
 218   Workaround is to generate a password with "short" strenght or pregenerate
 219   passwords without single quote in it. Default deployment is using "short"
 220   password generation for mariadb.
 221
 222 Security Notes
 223 --------------
 224
 225 **Fixed Security Issues**
 226
 227 References
 228 ==========
 229
 230 For more information on the ONAP Frankfurt release, please see:
 231
 232 #. `ONAP Home Page`_
 233 #. `ONAP Documentation`_
 234 #. `ONAP Release Downloads`_
 235 #. `ONAP Wiki Page`_
 236
 237
 238 .. _`ONAP Home Page`: https://www.onap.org
 239 .. _`ONAP Wiki Page`: https://wiki.onap.org
 240 .. _`ONAP Documentation`: https://docs.onap.org
 241 .. _`ONAP Release Downloads`: https://git.onap.org