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