[DOCS] Update J release notes for cert-service
[oom/platform/cert-service.git] / docs / sections / release-notes.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. Copyright 2020-2021 NOKIA
4 .. _release_notes:
5
6 ***************************************
7 OOM Certification Service Release Notes
8 ***************************************
9
10 .. contents::
11     :depth: 2
12 ..
13
14 Version: 2.5.0
15 ==============
16
17 Abstract
18 --------
19
20 This document provides the release notes for the Jakarta release.
21
22 Summary
23 -------
24
25 Vulnerability Fix
26
27 Release Data
28 ------------
29
30 +--------------------------------------+---------------------------------------------------------------------------------------+
31 | **Project**                          | OOM                                                                                   |
32 |                                      |                                                                                       |
33 +--------------------------------------+---------------------------------------------------------------------------------------+
34 | **Docker images**                    |  * onap/org.onap.oom.platform.cert-service.oom-certservice-api:2.5.0                  |
35 |                                      |  * onap/org.onap.oom.platform.cert-service.oom-certservice-post-processor:2.5.0       |
36 |                                      |  * onap/org.onap.oom.platform.cert-service.oom-certservice-k8s-external-provider:2.5.0|
37 |                                      |                                                                                       |
38 +--------------------------------------+---------------------------------------------------------------------------------------+
39 | **Release designation**              | Jakarta                                                                               |
40 |                                      |                                                                                       |
41 +--------------------------------------+---------------------------------------------------------------------------------------+
42
43
44 New features
45 ------------
46
47 **Bug fixes**
48
49 **Known Issues**
50
51 If Cert-Manager was down for some time and did not trigger certificate update on time, then updating an outdated certificate may require manual actions.
52 The required actions are described in :ref:`Troubleshooting section <troubleshooting>`
53
54 Deliverables
55 ------------
56
57 Software Deliverables
58 ~~~~~~~~~~~~~~~~~~~~~
59 Docker images mentioned in Release Date section.
60
61 Documentation Deliverables
62 ~~~~~~~~~~~~~~~~~~~~~~~~~~
63
64 - :ref:`CMPv2 certificate provider description <cmpv2_cert_provider>`
65
66 Known Limitations, Issues and Workarounds
67 -----------------------------------------
68
69 System Limitations
70 ~~~~~~~~~~~~~~~~~~
71
72 Any known system limitations.
73
74
75 Known Vulnerabilities
76 ~~~~~~~~~~~~~~~~~~~~~
77
78 Any known vulnerabilities.
79
80
81 Workarounds
82 ~~~~~~~~~~~
83
84 Any known workarounds.
85
86
87 Security Notes
88 --------------
89
90 **Fixed Security Issues**
91
92 - `OOM-2903 <https://jira.onap.org/browse/OOM-2903>`_ Fix Apache Vulnerability [CVE-2021-44228] in CertService
93
94 **Known Security Issues**
95
96 None
97
98
99 Test Results
100 ------------
101 Not applicable
102
103
104 References
105 ----------
106
107 For more information on the ONAP Istanbul release, please see:
108
109 #. `ONAP Home Page`_
110 #. `ONAP Documentation`_
111 #. `ONAP Release Downloads`_
112 #. `ONAP Wiki Page`_
113
114 Version: 2.4.0
115 ==============
116
117 Abstract
118 --------
119
120 This document provides the release notes for the Istanbul release.
121
122 Summary
123 -------
124
125 Certificate update use case is now available. For details go to:
126 :ref:`How to use instructions<how_to_use_certificate_update>`
127
128 Release Data
129 ------------
130
131 +--------------------------------------+---------------------------------------------------------------------------------------+
132 | **Project**                          | OOM                                                                                   |
133 |                                      |                                                                                       |
134 +--------------------------------------+---------------------------------------------------------------------------------------+
135 | **Docker images**                    |  * onap/org.onap.oom.platform.cert-service.oom-certservice-api:2.4.0                  |
136 |                                      |  * onap/org.onap.oom.platform.cert-service.oom-certservice-post-processor:2.4.0       |
137 |                                      |  * onap/org.onap.oom.platform.cert-service.oom-certservice-k8s-external-provider:2.4.0|
138 |                                      |                                                                                       |
139 +--------------------------------------+---------------------------------------------------------------------------------------+
140 | **Release designation**              | Istanbul                                                                              |
141 |                                      |                                                                                       |
142 +--------------------------------------+---------------------------------------------------------------------------------------+
143
144
145 New features
146 ------------
147
148 - `OOM-2754 <https://jira.onap.org/browse/OOM-2754>`_ Implement certificate update in CMPv2 external issuer
149
150 - `OOM-2753 <https://jira.onap.org/browse/OOM-2753>`_ Implement certificate update in CMPv2 CertService
151
152 - `OOM-2744 <https://jira.onap.org/browse/OOM-2744>`_ Remove CertService Client mechanism from ONAP
153
154 - `OOM-2649 <https://jira.onap.org/browse/OOM-2649>`_ Update contrib/ejbca to 7.x
155
156 **Bug fixes**
157
158 - `OOM-2771 <https://jira.onap.org/browse/OOM-2771>`_ Fix CertificateRequest resource was not found issue in CMPv2 external issuer
159
160 - `OOM-2764 <https://jira.onap.org/browse/OOM-2764>`_ Fix sonar issues in CertService
161
162 **Known Issues**
163
164 If Cert-Manager was down for some time and did not trigger certificate update on time, then updating an outdated certificate may require manual actions.
165 The required actions are described in :ref:`Troubleshooting section <troubleshooting>`
166
167 Deliverables
168 ------------
169
170 Software Deliverables
171 ~~~~~~~~~~~~~~~~~~~~~
172 Docker images mentioned in Release Date section.
173
174 Documentation Deliverables
175 ~~~~~~~~~~~~~~~~~~~~~~~~~~
176
177 - :ref:`CMPv2 certificate provider description <cmpv2_cert_provider>`
178
179 Known Limitations, Issues and Workarounds
180 -----------------------------------------
181
182 System Limitations
183 ~~~~~~~~~~~~~~~~~~
184
185 Any known system limitations.
186
187
188 Known Vulnerabilities
189 ~~~~~~~~~~~~~~~~~~~~~
190
191 Any known vulnerabilities.
192
193
194 Workarounds
195 ~~~~~~~~~~~
196
197 Any known workarounds.
198
199
200 Security Notes
201 --------------
202
203 **Fixed Security Issues**
204
205 None
206
207 **Known Security Issues**
208
209 None
210
211
212 Test Results
213 ------------
214 Not applicable
215
216
217 References
218 ----------
219
220 For more information on the ONAP Istanbul release, please see:
221
222 #. `ONAP Home Page`_
223 #. `ONAP Documentation`_
224 #. `ONAP Release Downloads`_
225 #. `ONAP Wiki Page`_
226
227 .. _`ONAP Home Page`: https://www.onap.org
228 .. _`ONAP Wiki Page`: https://wiki.onap.org
229 .. _`ONAP Documentation`: https://docs.onap.org
230 .. _`ONAP Release Downloads`: https://git.onap.org