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