docs/release-notes-frankfurt.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_frankfurt:
   6
   7 :orphan:
   8
   9 *************************************
  10 ONAP Operations Manager Release Notes
  11 *************************************
  12
  13 Previous Release Notes
  14 ======================
  15
  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 Frankfurt 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**              | Frankfurt                            |
  43 |                                      |                                      |
  44 +--------------------------------------+--------------------------------------+
  45 | **Release date**                     | 2020/06/15                           |
  46 |                                      |                                      |
  47 +--------------------------------------+--------------------------------------+
  48
  49 New features
  50 ------------
  51
  52 * Ingress deployment is getting more and more usable
  53 * Use of dynamic Persistent Volume is available
  54
  55 **Bug fixes**
  56
  57 A list of issues resolved in this release can be found here:
  58 https://jira.onap.org/projects/OOM/versions/10826
  59
  60 **Known Issues**
  61
  62 - `OOM-1237 <https://jira.onap.org/browse/OOM-1237>`_ Source Helm Charts from
  63   ONAP Repo. Having helm charts repo is not possible for Frankfurt release.
  64 - `OOM-1720 <https://jira.onap.org/browse/OOM-1237>`_ galera container is
  65   outdated. containers used for mariadb are outdated and not supported anymore.
  66 - `OOM-1817 <https://jira.onap.org/browse/OOM-1817>`_ Use of global.repository
  67   inconsistent across Helm Charts. it's then may be hard to retrieve some
  68   containers when deploying in constrained environment.
  69 - `OOM-2075 <https://jira.onap.org/browse/OOM-2075>`_ Invalid MTU for Canal CNI
  70   interfaces
  71 - `OOM-2227 <https://jira.onap.org/browse/OOM-2227>`_ Cassandra Backup Mechanism
  72   works only on "static PV" mode.
  73 - `OOM-2230 <https://jira.onap.org/browse/OOM-2230>`_ Missing requests/limits
  74   for some PODS. This can lead to "memory bombing" so cautious monitoring of
  75   Kubernetes resources usage must be set up.
  76 - `OOM-2279 <https://jira.onap.org/browse/OOM-2279>`_ OOM El Alto and master
  77   clamp mariadb resources doesn't match chart.
  78 - `OOM-2285 <https://jira.onap.org/browse/OOM-2285>`_ deploy.sh does not work
  79   for mariadb-galera. deploy script doesn't behave well with "-" in the
  80   component name.
  81 - `OOM-2369 <https://jira.onap.org/browse/OOM-2369>`_ DMAAP Helm install takes
  82   too long and often fails.
  83 - `OOM-2418 <https://jira.onap.org/browse/OOM-2418>`_ Readiness-check 2.0.2 not
  84   working properly for stateful set.
  85 - `OOM-2421 <https://jira.onap.org/browse/OOM-2421>`_ OOM NBI chart deployment
  86   error. In some case, NBI deployment fails.
  87 - `OOM-2422 <https://jira.onap.org/browse/OOM-2422>`_ Portal App is unreachable
  88   when deploying without HTTPs
  89
  90
  91 Deliverables
  92 ------------
  93
  94 Software Deliverables
  95 ~~~~~~~~~~~~~~~~~~~~~
  96
  97 OOM provides `Helm charts <https://git.onap.org/oom/>`_ that needs to be
  98 "compiled" into Helm package. see step 6 in
  99 :doc:`quickstart guide <oom_quickstart_guide>`.
 100
 101 Documentation Deliverables
 102 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 103
 104 - :doc:`Project Description <oom_project_description>`
 105 - :doc:`Cloud Setup Guide <oom_cloud_setup_guide>`
 106 - :doc:`Quick Start Guide <oom_quickstart_guide>`
 107 - :doc:`Setup Ingress Controller <oom_setup_ingress_controller>`
 108 - :doc:`Developer Guide <oom_developer_guide>`
 109 - :doc:`Hardcoded Certificates <oom_hardcoded_certificates>`
 110
 111 Known Limitations, Issues and Workarounds
 112 =========================================
 113
 114 Known Vulnerabilities
 115 ---------------------
 116
 117 - Hard coded password used for all OOM deployments
 118   [`OJSI-188 <https://jira.onap.org/browse/OJSI-188>`_]
 119 - :doc:`Hard coded certificates <oom_hardcoded_certificates>` in Helm packages
 120
 121 Workarounds
 122 -----------
 123
 124 - `OOM-1237 <https://jira.onap.org/browse/OOM-1237>`_ Workaround is to generate
 125   them as explained in documentation.
 126 - `OOM-1817 <https://jira.onap.org/browse/OOM-1817>`_ Workaround is to use
 127   offline installer if needed.
 128 - `OOM-2227 <https://jira.onap.org/browse/OOM-2227>`_ Workaround is to stick to
 129   "static PV" (so, not using storage class) if backup is needed.
 130 - `OOM-2285 <https://jira.onap.org/browse/OOM-2285>`_ Workaround is to use
 131   directly helm upgrade if needed.
 132 - `OOM-2369 <https://jira.onap.org/browse/OOM-2369>`_ Workaround is to play
 133   postinstall jobs by hand.
 134 - `OOM-2418 <https://jira.onap.org/browse/OOM-2418>`_ Workaround is to use
 135   version 2.2.2 in global part of override file if the new check is needed.
 136 - `OOM-2421 <https://jira.onap.org/browse/OOM-2421>`_ Workaround is to
 137   undeploy/redeploy NBI.
 138 - `OOM-2422 <https://jira.onap.org/browse/OOM-2422>`_ Workaround is to create
 139   first portal app service with service type Cluster IP then changing it to
 140   NodePort or LoadBalancer so all the port are available.
 141
 142 Security Notes
 143 --------------
 144
 145 **Fixed Security Issues**
 146
 147 - In default deployment OOM (consul-server-ui) exposes HTTP port 30270 outside
 148   of cluster. [`OJSI-134 <https://jira.onap.org/browse/OJSI-134>`_]
 149 - CVE-2019-12127 - OOM exposes unprotected API/UI on port 30270
 150   [`OJSI-202 <https://jira.onap.org/browse/OJSI-202>`_]
 151
 152 References
 153 ==========
 154
 155 For more information on the ONAP Frankfurt release, please see:
 156
 157 #. `ONAP Home Page`_
 158 #. `ONAP Documentation`_
 159 #. `ONAP Release Downloads`_
 160 #. `ONAP Wiki Page`_
 161
 162
 163 .. _`ONAP Home Page`: https://www.onap.org
 164 .. _`ONAP Wiki Page`: https://wiki.onap.org
 165 .. _`ONAP Documentation`: https://docs.onap.org
 166 .. _`ONAP Release Downloads`: https://git.onap.org