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.
  26
  27 Summary
  28 =======
  29
  30 The focus of this release is to strengthen the foundation of OOM installer.
  31
  32 Release Data
  33 ============
  34
  35 +--------------------------------------+--------------------------------------+
  36 | **Project**                          | OOM                                  |
  37 |                                      |                                      |
  38 +--------------------------------------+--------------------------------------+
  39 | **Docker images**                    | N/A                                  |
  40 |                                      |                                      |
  41 +--------------------------------------+--------------------------------------+
  42 | **Release designation**              | Honolulu                             |
  43 |                                      |                                      |
  44 +--------------------------------------+--------------------------------------+
  45 | **Release date**                     | 2021/04/29                           |
  46 |                                      |                                      |
  47 +--------------------------------------+--------------------------------------+
  48
  49 New features
  50 ------------
  51
  52 * Kubernetes support for version up to 1.20
  53 * Helm support for version up to 3.5
  54 * Limits are set for most of the components
  55 * Portal-Cassandra image updated to Bitnami, supporting IPv4/IPv6 Dual Stack
  56 * CMPv2 external issuer implemented which extends Cert-Manager with ability  to
  57   enroll X.509 certificates from CMPv2 servers
  58 * New version for mariadb galera using Bitnami image, supporting IPv4/IPv6 Dual
  59   Stack
  60 * Bump version of common PostgreSQL and ElasticSearch
  61 * Move to automatic certificates retrieval for 80% of the components
  62 * Consistent retrieval of docker images, with ability to configure proxy for
  63   the 4 repositories used by ONAP
  64
  65 **Bug fixes**
  66
  67 A list of issues resolved in this release can be found here:
  68 https://jira.onap.org/projects/OOM/versions/11073
  69
  70 major issues solved:
  71
  72 * Better handling of persistence on PostgreSQL
  73 * Better Ingress templating
  74 * Better Service templating
  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 Deliverables
 104 ------------
 105
 106 Software Deliverables
 107 ~~~~~~~~~~~~~~~~~~~~~
 108
 109 OOM provides `Helm charts <https://git.onap.org/oom/>`_ that needs to be
 110 "compiled" into Helm package. see step 6 in
 111 :doc:`quickstart guide <oom_quickstart_guide>`.
 112
 113 Documentation Deliverables
 114 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 115
 116 - :doc:`Project Description <oom_project_description>`
 117 - :doc:`Cloud Setup Guide <oom_cloud_setup_guide>`
 118 - :doc:`Quick Start Guide <oom_quickstart_guide>`
 119 - :doc:`Setup Ingress Controller <oom_setup_ingress_controller>`
 120 - :doc:`Developer Guide <oom_developer_guide>`
 121 - :doc:`Hardcoded Certificates <oom_hardcoded_certificates>`
 122
 123 Known Limitations, Issues and Workarounds
 124 =========================================
 125
 126 Known Vulnerabilities
 127 ---------------------
 128
 129 - Hard coded password used for all OOM deployments
 130   [`OJSI-188 <https://jira.onap.org/browse/OJSI-188>`_]
 131 - :doc:`Hard coded certificates <oom_hardcoded_certificates>` in Helm packages
 132
 133 Workarounds
 134 -----------
 135
 136 - `<https://github.com/bitnami/bitnami-docker-mariadb-galera/issues/35>`_
 137   Workaround is to generate a password with "short" strenght or pregenerate
 138   passwords without single quote in it. Default deployment is using "short"
 139   password generation for mariadb.
 140
 141 Security Notes
 142 --------------
 143
 144 **Fixed Security Issues**
 145
 146 References
 147 ==========
 148
 149 For more information on the ONAP Frankfurt 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