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:`El Alto <release_notes_elalto>`
  15 - :ref:`Dublin <release_notes_dublin>`
  16 - :ref:`Casablanca <release_notes_casablanca>`
  17 - :ref:`Beijing <release_notes_beijing>`
  18 - :ref:`Amsterdam <release_notes_amsterdam>`
  19
  20 Abstract
  21 ========
  22
  23 This document provides the release notes for the Frankfurt Maintenance release
  24 1.
  25
  26 Summary
  27 =======
  28
  29 The focus of this release is to correct issues found on Frankfurt release of OOM
  30 installer.
  31
  32 Release Data
  33 ============
  34
  35 +--------------------------------------+--------------------------------------+
  36 | **Project**                          | OOM                                  |
  37 |                                      |                                      |
  38 +--------------------------------------+--------------------------------------+
  39 | **Docker images**                    | N/A                                  |
  40 |                                      |                                      |
  41 +--------------------------------------+--------------------------------------+
  42 | **Release designation**              | Frankfurt  Maintenance Release 1     |
  43 |                                      |                                      |
  44 +--------------------------------------+--------------------------------------+
  45 | **Release date**                     | 2020/07/24                           |
  46 |                                      |                                      |
  47 +--------------------------------------+--------------------------------------+
  48
  49 New features
  50 ------------
  51
  52 None
  53
  54 **Bug fixes**
  55
  56 - `OOM-2400 <https://jira.onap.org/browse/OOM-2400>`_ Fix SDNC DMAAP consumer
  57   properties in HELM charts
  58 - `INT-1633 <https://jira.onap.org/browse/INT-1633>`_ Revert "[COMMON] add pre
  59   upgrade script for mariadb-galera"
  60 - `OOM-2436 <https://jira.onap.org/browse/OOM-2436>`_ [COMMON] Allow to use ' in
  61   mariadb-init
  62
  63 **Known Issues**
  64
  65 Same as Frankfurt Release
  66
  67
  68 Abstract
  69 ========
  70
  71 This document provides the release notes for the Frankfurt release.
  72
  73 Summary
  74 =======
  75
  76 The focus of this release is to strengthen the foundation of OOM installer.
  77
  78 Release Data
  79 ============
  80
  81 +--------------------------------------+--------------------------------------+
  82 | **Project**                          | OOM                                  |
  83 |                                      |                                      |
  84 +--------------------------------------+--------------------------------------+
  85 | **Docker images**                    | N/A                                  |
  86 |                                      |                                      |
  87 +--------------------------------------+--------------------------------------+
  88 | **Release designation**              | Frankfurt                            |
  89 |                                      |                                      |
  90 +--------------------------------------+--------------------------------------+
  91 | **Release date**                     | 2020/06/15                           |
  92 |                                      |                                      |
  93 +--------------------------------------+--------------------------------------+
  94
  95 New features
  96 ------------
  97
  98 * Ingress deployment is getting more and more usable
  99 * Use of dynamic Persistent Volume is available
 100
 101 **Bug fixes**
 102
 103 A list of issues resolved in this release can be found here:
 104 https://jira.onap.org/projects/OOM/versions/10826
 105
 106 **Known Issues**
 107
 108 - `OOM-1237 <https://jira.onap.org/browse/OOM-1237>`_ Source Helm Charts from
 109   ONAP Repo. Having helm charts repo is not possible for Frankfurt release.
 110 - `OOM-1720 <https://jira.onap.org/browse/OOM-1237>`_ galera container is
 111   outdated. containers used for mariadb are outdated and not supported anymore.
 112 - `OOM-1817 <https://jira.onap.org/browse/OOM-1817>`_ Use of global.repository
 113   inconsistent across Helm Charts. it's then may be hard to retrieve some
 114   containers when deploying in constrained environment.
 115 - `OOM-2075 <https://jira.onap.org/browse/OOM-2075>`_ Invalid MTU for Canal CNI
 116   interfaces
 117 - `OOM-2227 <https://jira.onap.org/browse/OOM-2227>`_ Cassandra Backup Mechanism
 118   works only on "static PV" mode.
 119 - `OOM-2230 <https://jira.onap.org/browse/OOM-2230>`_ Missing requests/limits
 120   for some PODS. This can lead to "memory bombing" so cautious monitoring of
 121   Kubernetes resources usage must be set up.
 122 - `OOM-2279 <https://jira.onap.org/browse/OOM-2279>`_ OOM El Alto and master
 123   clamp mariadb resources doesn't match chart.
 124 - `OOM-2285 <https://jira.onap.org/browse/OOM-2285>`_ deploy.sh does not work
 125   for mariadb-galera. deploy script doesn't behave well with "-" in the
 126   component name.
 127 - `OOM-2369 <https://jira.onap.org/browse/OOM-2369>`_ DMAAP Helm install takes
 128   too long and often fails.
 129 - `OOM-2418 <https://jira.onap.org/browse/OOM-2418>`_ Readiness-check 2.0.2 not
 130   working properly for stateful set.
 131 - `OOM-2421 <https://jira.onap.org/browse/OOM-2421>`_ OOM NBI chart deployment
 132   error. In some case, NBI deployment fails.
 133 - `OOM-2422 <https://jira.onap.org/browse/OOM-2422>`_ Portal App is unreachable
 134   when deploying without HTTPs
 135
 136
 137 Deliverables
 138 ------------
 139
 140 Software Deliverables
 141 ~~~~~~~~~~~~~~~~~~~~~
 142
 143 OOM provides `Helm charts <https://git.onap.org/oom/>`_ that needs to be
 144 "compiled" into Helm package. see step 6 in
 145 :doc:`quickstart guide <oom_quickstart_guide>`.
 146
 147 Documentation Deliverables
 148 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 149
 150 - :doc:`Project Description <oom_project_description>`
 151 - :doc:`Cloud Setup Guide <oom_cloud_setup_guide>`
 152 - :doc:`Quick Start Guide <oom_quickstart_guide>`
 153 - :doc:`Setup Ingress Controller <oom_setup_ingress_controller>`
 154 - :doc:`Developer Guide <oom_developer_guide>`
 155 - :doc:`Hardcoded Certificates <oom_hardcoded_certificates>`
 156
 157 Known Limitations, Issues and Workarounds
 158 =========================================
 159
 160 Known Vulnerabilities
 161 ---------------------
 162
 163 - Hard coded password used for all OOM deployments
 164   [`OJSI-188 <https://jira.onap.org/browse/OJSI-188>`_]
 165 - :doc:`Hard coded certificates <oom_hardcoded_certificates>` in Helm packages
 166
 167 Workarounds
 168 -----------
 169
 170 - `OOM-1237 <https://jira.onap.org/browse/OOM-1237>`_ Workaround is to generate
 171   them as explained in documentation.
 172 - `OOM-1817 <https://jira.onap.org/browse/OOM-1817>`_ Workaround is to use
 173   offline installer if needed.
 174 - `OOM-2227 <https://jira.onap.org/browse/OOM-2227>`_ Workaround is to stick to
 175   "static PV" (so, not using storage class) if backup is needed.
 176 - `OOM-2285 <https://jira.onap.org/browse/OOM-2285>`_ Workaround is to use
 177   directly helm upgrade if needed.
 178 - `OOM-2369 <https://jira.onap.org/browse/OOM-2369>`_ Workaround is to play
 179   postinstall jobs by hand.
 180 - `OOM-2418 <https://jira.onap.org/browse/OOM-2418>`_ Workaround is to use
 181   version 2.2.2 in global part of override file if the new check is needed.
 182 - `OOM-2421 <https://jira.onap.org/browse/OOM-2421>`_ Workaround is to
 183   undeploy/redeploy NBI.
 184 - `OOM-2422 <https://jira.onap.org/browse/OOM-2421>`_ Workaround is to create
 185   first portal app service with service type Cluster IP then changing it to
 186   NodePort or LoadBalancer so all the port are available.
 187
 188 Security Notes
 189 --------------
 190
 191 **Fixed Security Issues**
 192
 193 - In default deployment OOM (consul-server-ui) exposes HTTP port 30270 outside
 194   of cluster. [`OJSI-134 <https://jira.onap.org/browse/OJSI-134>`_]
 195 - CVE-2019-12127 - OOM exposes unprotected API/UI on port 30270
 196   [`OJSI-202 <https://jira.onap.org/browse/OJSI-202>`_]
 197
 198 References
 199 ==========
 200
 201 For more information on the ONAP Frankfurt release, please see:
 202
 203 #. `ONAP Home Page`_
 204 #. `ONAP Documentation`_
 205 #. `ONAP Release Downloads`_
 206 #. `ONAP Wiki Page`_
 207
 208
 209 .. _`ONAP Home Page`: https://www.onap.org
 210 .. _`ONAP Wiki Page`: https://wiki.onap.org
 211 .. _`ONAP Documentation`: https://docs.onap.org
 212 .. _`ONAP Release Downloads`: https://git.onap.org