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 Guilin Maintenance release
  25 1.
  26
  27 Summary
  28 =======
  29
  30 The focus of this release is to correct issues found on Guilin release of OOM
  31 installer.
  32 It has also a large number of certificates update in order to have valid ones
  33 for the next monthes
  34
  35 Release Data
  36 ============
  37
  38 +--------------------------------------+--------------------------------------+
  39 | **Project**                          | OOM                                  |
  40 |                                      |                                      |
  41 +--------------------------------------+--------------------------------------+
  42 | **Docker images**                    | N/A                                  |
  43 |                                      |                                      |
  44 +--------------------------------------+--------------------------------------+
  45 | **Release designation**              | Guilin Maintenance Release 1         |
  46 |                                      |                                      |
  47 +--------------------------------------+--------------------------------------+
  48 | **Release date**                     | 2021/04/26                           |
  49 |                                      |                                      |
  50 +--------------------------------------+--------------------------------------+
  51
  52 New features
  53 ------------
  54
  55 None
  56
  57 **Bug fixes**
  58
  59 - `OOM-2671 <https://jira.onap.org/browse/OOM-2671>`_ [DMAAP][DR] Fix bad
  60   templating
  61 - `OOM-2643 <https://jira.onap.org/browse/OOM-2643>`_ [COMMON] Add some python
  62   linters in tox.ini
  63 - `OOM-2668 <https://jira.onap.org/browse/OOM-2668>`_ [COMMON][ETCD] Skip
  64   startup self-discovery for etcd nodes
  65 - `OOM-2641 <https://jira.onap.org/browse/OOM-2641>`_ [COMMON] Configure paths
  66   for Ingress
  67 - `OOM-2648 <https://jira.onap.org/browse/OOM-2648>`_ [COMMON] Add doc linting
  68 - `OOM-2666 <https://jira.onap.org/browse/OOM-2666>`_ [COMMON][CERTS] Use sh to
  69   onboard custom certs
  70
  71 **Known Issues**
  72
  73 Same as Guilin Release
  74
  75 Abstract
  76 ========
  77
  78 This document provides the release notes for the Guilin release.
  79
  80 Summary
  81 =======
  82
  83 The focus of this release is to strengthen the foundation of OOM installer.
  84
  85 Release Data
  86 ============
  87
  88 +--------------------------------------+--------------------------------------+
  89 | **Project**                          | OOM                                  |
  90 |                                      |                                      |
  91 +--------------------------------------+--------------------------------------+
  92 | **Docker images**                    | N/A                                  |
  93 |                                      |                                      |
  94 +--------------------------------------+--------------------------------------+
  95 | **Release designation**              | Guilin                               |
  96 |                                      |                                      |
  97 +--------------------------------------+--------------------------------------+
  98 | **Release date**                     | 2020/12/03                           |
  99 |                                      |                                      |
 100 +--------------------------------------+--------------------------------------+
 101
 102 New features
 103 ------------
 104
 105 * Kubernetes support for version up to 1.19
 106 * Helm (experimental) support for version up to 3.3
 107 * Limits are set for most of the components
 108
 109 **Bug fixes**
 110
 111 A list of issues resolved in this release can be found here:
 112 https://jira.onap.org/projects/OOM/versions/10826
 113
 114 **Known Issues**
 115
 116 - `OOM-1237 <https://jira.onap.org/browse/OOM-1237>`_ Source Helm Charts from
 117   ONAP Repo. Having helm charts repo is not possible for Frankfurt release.
 118 - `OOM-1720 <https://jira.onap.org/browse/OOM-1237>`_ galera container is
 119   outdated. containers used for mariadb are outdated and not supported anymore.
 120 - `OOM-1817 <https://jira.onap.org/browse/OOM-1817>`_ Use of global.repository
 121   inconsistent across Helm Charts. it's then may be hard to retrieve some
 122   containers when deploying in constrained environment.
 123 - `OOM-2227 <https://jira.onap.org/browse/OOM-2227>`_ Cassandra Backup Mechanism
 124   works only on "static PV" mode.
 125 - `OOM-2285 <https://jira.onap.org/browse/OOM-2285>`_ deploy.sh does not work
 126   for mariadb-galera. deploy script doesn't behave well with "-" in the
 127   component name.
 128 - `OOM-2421 <https://jira.onap.org/browse/OOM-2421>`_ OOM nbi chart deployment
 129   error
 130 - `OOM-2534 <https://jira.onap.org/browse/OOM-2534>`_ Cert-Service leverages
 131   runtime external dependency
 132 - `OOM-2554 <https://jira.onap.org/browse/OOM-2554>`_ Common pods have java 8
 133 - `OOM-2588 <https://jira.onap.org/browse/OOM-2588>`_ Various subcharts not
 134   installing due to helm size issues
 135 - `OOM-2629 <https://jira.onap.org/browse/OOM-2629>`_ NetBox demo entry setup
 136   not complete
 137
 138
 139 Deliverables
 140 ------------
 141
 142 Software Deliverables
 143 ~~~~~~~~~~~~~~~~~~~~~
 144
 145 OOM provides `Helm charts <https://git.onap.org/oom/>`_ that needs to be
 146 "compiled" into Helm package. see step 6 in
 147 :doc:`quickstart guide <oom_quickstart_guide>`.
 148
 149 Documentation Deliverables
 150 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 151
 152 - :doc:`Project Description <oom_project_description>`
 153 - :doc:`Cloud Setup Guide <oom_cloud_setup_guide>`
 154 - :doc:`Quick Start Guide <oom_quickstart_guide>`
 155 - :doc:`Setup Ingress Controller <oom_setup_ingress_controller>`
 156 - :doc:`Developer Guide <oom_developer_guide>`
 157 - :doc:`Hardcoded Certificates <oom_hardcoded_certificates>`
 158
 159 Known Limitations, Issues and Workarounds
 160 =========================================
 161
 162 Known Vulnerabilities
 163 ---------------------
 164
 165 - Hard coded password used for all OOM deployments
 166   [`OJSI-188 <https://jira.onap.org/browse/OJSI-188>`_]
 167 - :doc:`Hard coded certificates <oom_hardcoded_certificates>` in Helm packages
 168
 169 Workarounds
 170 -----------
 171
 172 - `OOM-1237 <https://jira.onap.org/browse/OOM-1237>`_ Workaround is to generate
 173   them as explained in documentation.
 174 - `OOM-1817 <https://jira.onap.org/browse/OOM-1817>`_ Workaround is to use
 175   offline installer if needed.
 176 - `OOM-2227 <https://jira.onap.org/browse/OOM-2227>`_ Workaround is to stick to
 177   "static PV" (so, not using storage class) if backup is needed.
 178 - `OOM-2285 <https://jira.onap.org/browse/OOM-2285>`_ Workaround is to use
 179   directly helm upgrade if needed.
 180 - `OOM-2534 <https://jira.onap.org/browse/OOM-2534>`_ Workaround is to download
 181   in advance docker.io/openjdk:11-jre-slim where you will generate the charts
 182
 183 Security Notes
 184 --------------
 185
 186 **Fixed Security Issues**
 187
 188 References
 189 ==========
 190
 191 For more information on the ONAP Frankfurt release, please see:
 192
 193 #. `ONAP Home Page`_
 194 #. `ONAP Documentation`_
 195 #. `ONAP Release Downloads`_
 196 #. `ONAP Wiki Page`_
 197
 198
 199 .. _`ONAP Home Page`: https://www.onap.org
 200 .. _`ONAP Wiki Page`: https://wiki.onap.org
 201 .. _`ONAP Documentation`: https://docs.onap.org
 202 .. _`ONAP Release Downloads`: https://git.onap.org