[RDT] Refactoring RTD
[oom.git] / docs / sections / 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:`Jakarta <release_notes_jakarta>`
15 - :ref:`Istanbul <release_notes_istanbul>`
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 Jakarta 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**              | Jakarta                              |
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/11498
60
61
62 **Known Issues**
63
64
65 Deliverables
66 ------------
67
68 Software Deliverables
69 ~~~~~~~~~~~~~~~~~~~~~
70
71 OOM provides `Helm charts <https://nexus3.onap.org/service/rest/repository/browse/onap-helm-release/>`_
72
73 Documentation Deliverables
74 ~~~~~~~~~~~~~~~~~~~~~~~~~~
75
76 - :ref:`Project Description <oom_project_description>` - a guide for developers of OOM
77 - :ref:`oom_dev_guide` - a guide for developers of OOM
78 - :ref:`oom_infra_setup_guide` - a guide for those setting up the environments that OOM will use
79 - :ref:`oom_deploy_guide` - a guide for those deploying OOM on an existing cloud
80 - :ref:`oom_user_guide` - a guide for operators of an OOM instance
81 - :ref:`oom_access_info_guide` - a guide for operators who require access to OOM applications
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 Istanbul to Jakarta
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