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