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:`Honolulu <release_notes_honolulu>`
  15 - :ref:`Guilin <release_notes_guilin>`
  16 - :ref:`Frankfurt <release_notes_frankfurt>`
  17 - :ref:`El Alto <release_notes_elalto>`
  18 - :ref:`Dublin <release_notes_dublin>`
  19 - :ref:`Casablanca <release_notes_casablanca>`
  20 - :ref:`Beijing <release_notes_beijing>`
  21 - :ref:`Amsterdam <release_notes_amsterdam>`
  22
  23 Abstract
  24 ========
  25
  26 This document provides the release notes for the Istanbul release.
  27
  28 Summary
  29 =======
  30
  31
  32
  33 Release Data
  34 ============
  35
  36 +--------------------------------------+--------------------------------------+
  37 | **Project**                          | OOM                                  |
  38 |                                      |                                      |
  39 +--------------------------------------+--------------------------------------+
  40 | **Docker images**                    | N/A                                  |
  41 |                                      |                                      |
  42 +--------------------------------------+--------------------------------------+
  43 | **Release designation**              | Istanbul                             |
  44 |                                      |                                      |
  45 +--------------------------------------+--------------------------------------+
  46 | **Release date**                     |                                      |
  47 |                                      |                                      |
  48 +--------------------------------------+--------------------------------------+
  49
  50 New features
  51 ------------
  52
  53
  54 **Bug fixes**
  55
  56 A list of issues resolved in this release can be found here:
  57 https://jira.onap.org/projects/OOM/versions/11074
  58
  59
  60 **Known Issues**
  61
  62
  63 Deliverables
  64 ------------
  65
  66 Software Deliverables
  67 ~~~~~~~~~~~~~~~~~~~~~
  68
  69 OOM provides `Helm charts <https://git.onap.org/oom/>`_ that needs to be
  70 "compiled" into Helm package. see step 6 in
  71 :doc:`quickstart guide <oom_quickstart_guide>`.
  72
  73 Documentation Deliverables
  74 ~~~~~~~~~~~~~~~~~~~~~~~~~~
  75
  76 - :doc:`Project Description <oom_project_description>`
  77 - :doc:`Cloud Setup Guide <oom_cloud_setup_guide>`
  78 - :doc:`Quick Start Guide <oom_quickstart_guide>`
  79 - :doc:`Setup Ingress Controller <oom_setup_ingress_controller>`
  80 - :doc:`Developer Guide <oom_developer_guide>`
  81 - :doc:`Hardcoded Certificates <oom_hardcoded_certificates>`
  82
  83 Known Limitations, Issues and Workarounds
  84 =========================================
  85
  86 Known Vulnerabilities
  87 ---------------------
  88
  89
  90 Workarounds
  91 -----------
  92
  93 - `OOM-2754 <https://jira.onap.org/browse/OOM-2754>`_
  94   Because of *updateEndpoint* property added to *cmpv2issuer* CRD
  95   it is impossible to upgrade platform component from Honolulu to Istanbul
  96   release without manual steps. Actions that should be performed:
  97
  98   #. Update the CRD definition::
  99
 100      > kubectl -n onap apply -f oom/kubernetes/platform/components/cmpv2-cert-provider/crds/cmpv2issuer.yaml
 101   #. Upgrade the component::
 102
 103      > helm -n onap upgrade dev-platform oom/kubernetes/platform
 104   #. Make sure that *cmpv2issuer* contains correct value for
 105      *spec.updateEndpoint*. The value should be: *v1/certificate-update*.
 106      If it's not, edit the resource::
 107
 108      > kubectl -n onap edit cmpv2issuer cmpv2-issuer-onap
 109
 110
 111 Security Notes
 112 --------------
 113
 114 **Fixed Security Issues**
 115
 116 References
 117 ==========
 118
 119 For more information on the ONAP Istanbul release, please see:
 120
 121 #. `ONAP Home Page`_
 122 #. `ONAP Documentation`_
 123 #. `ONAP Release Downloads`_
 124 #. `ONAP Wiki Page`_
 125
 126
 127 .. _`ONAP Home Page`: https://www.onap.org
 128 .. _`ONAP Wiki Page`: https://wiki.onap.org
 129 .. _`ONAP Documentation`: https://docs.onap.org
 130 .. _`ONAP Release Downloads`: https://git.onap.org