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:`Frankfurt <release_notes_frankfurt>`
  15 - :ref:`El Alto <release_notes_elalto>`
  16 - :ref:`Dublin <release_notes_dublin>`
  17 - :ref:`Casablanca <release_notes_casablanca>`
  18 - :ref:`Beijing <release_notes_beijing>`
  19 - :ref:`Amsterdam <release_notes_amsterdam>`
  20
  21 Abstract
  22 ========
  23
  24 This document provides the release notes for the Frankfurt release.
  25
  26 Summary
  27 =======
  28
  29 The focus of this release is to strengthen the foundation of OOM installer.
  30
  31 Release Data
  32 ============
  33
  34 +--------------------------------------+--------------------------------------+
  35 | **Project**                          | OOM                                  |
  36 |                                      |                                      |
  37 +--------------------------------------+--------------------------------------+
  38 | **Docker images**                    | N/A                                  |
  39 |                                      |                                      |
  40 +--------------------------------------+--------------------------------------+
  41 | **Release designation**              | Guilin                               |
  42 |                                      |                                      |
  43 +--------------------------------------+--------------------------------------+
  44 | **Release date**                     | 2020/12/03                           |
  45 |                                      |                                      |
  46 +--------------------------------------+--------------------------------------+
  47
  48 New features
  49 ------------
  50
  51 * Kubernetes support for version up to 1.19
  52 * Helm (experimental) support for version up to 3.3
  53 * Limits are set for most of the components
  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-2227 <https://jira.onap.org/browse/OOM-2227>`_ Cassandra Backup Mechanism
  70   works only on "static PV" mode.
  71 - `OOM-2285 <https://jira.onap.org/browse/OOM-2285>`_ deploy.sh does not work
  72   for mariadb-galera. deploy script doesn't behave well with "-" in the
  73   component name.
  74 - `OOM-2421 <https://jira.onap.org/browse/OOM-2421>`_ OOM nbi chart deployment
  75   error
  76 - `OOM-2534 <https://jira.onap.org/browse/OOM-2534>`_ Cert-Service leverages
  77   runtime external dependency
  78 - `OOM-2554 <https://jira.onap.org/browse/OOM-2554>`_ Common pods have java 8
  79 - `OOM-2588 <https://jira.onap.org/browse/OOM-2588>`_ Various subcharts not
  80   installing due to helm size issues
  81 - `OOM-2629 <https://jira.onap.org/browse/OOM-2629>`_ NetBox demo entry setup
  82   not complete
  83
  84
  85 Deliverables
  86 ------------
  87
  88 Software Deliverables
  89 ~~~~~~~~~~~~~~~~~~~~~
  90
  91 OOM provides `Helm charts <https://git.onap.org/oom/>`_ that needs to be
  92 "compiled" into Helm package. see step 6 in
  93 :doc:`quickstart guide <oom_quickstart_guide>`.
  94
  95 Documentation Deliverables
  96 ~~~~~~~~~~~~~~~~~~~~~~~~~~
  97
  98 - :doc:`Project Description <oom_project_description>`
  99 - :doc:`Cloud Setup Guide <oom_cloud_setup_guide>`
 100 - :doc:`Quick Start Guide <oom_quickstart_guide>`
 101 - :doc:`Setup Ingress Controller <oom_setup_ingress_controller>`
 102 - :doc:`Developer Guide <oom_developer_guide>`
 103 - :doc:`Hardcoded Certificates <oom_hardcoded_certificates>`
 104
 105 Known Limitations, Issues and Workarounds
 106 =========================================
 107
 108 Known Vulnerabilities
 109 ---------------------
 110
 111 - Hard coded password used for all OOM deployments
 112   [`OJSI-188 <https://jira.onap.org/browse/OJSI-188>`_]
 113 - :doc:`Hard coded certificates <oom_hardcoded_certificates>` in Helm packages
 114
 115 Workarounds
 116 -----------
 117
 118 - `OOM-1237 <https://jira.onap.org/browse/OOM-1237>`_ Workaround is to generate
 119   them as explained in documentation.
 120 - `OOM-1817 <https://jira.onap.org/browse/OOM-1817>`_ Workaround is to use
 121   offline installer if needed.
 122 - `OOM-2227 <https://jira.onap.org/browse/OOM-2227>`_ Workaround is to stick to
 123   "static PV" (so, not using storage class) if backup is needed.
 124 - `OOM-2285 <https://jira.onap.org/browse/OOM-2285>`_ Workaround is to use
 125   directly helm upgrade if needed.
 126 - `OOM-2534 <https://jira.onap.org/browse/OOM-2534>`_ Workaround is to download
 127   in advance docker.io/openjdk:11-jre-slim where you will generate the charts
 128
 129 Security Notes
 130 --------------
 131
 132 **Fixed Security Issues**
 133
 134 References
 135 ==========
 136
 137 For more information on the ONAP Frankfurt release, please see:
 138
 139 #. `ONAP Home Page`_
 140 #. `ONAP Documentation`_
 141 #. `ONAP Release Downloads`_
 142 #. `ONAP Wiki Page`_
 143
 144
 145 .. _`ONAP Home Page`: https://www.onap.org
 146 .. _`ONAP Wiki Page`: https://wiki.onap.org
 147 .. _`ONAP Documentation`: https://docs.onap.org
 148 .. _`ONAP Release Downloads`: https://git.onap.org