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.4.0 [not released yet]
  15 =================================
  16
  17 Abstract
  18 --------
  19
  20 This document provides the release notes for the Istanbul release.
  21
  22 Summary
  23 -------
  24
  25 Certificate update use case is now available. For details go to:
  26 :ref:`How to use instructions<how_to_use_certificate_update>`
  27
  28 Release Data
  29 ------------
  30
  31 +--------------------------------------+---------------------------------------------------------------------------------------+
  32 | **Project**                          | OOM                                                                                   |
  33 |                                      |                                                                                       |
  34 +--------------------------------------+---------------------------------------------------------------------------------------+
  35 | **Docker images**                    |  * onap/org.onap.oom.platform.cert-service.oom-certservice-api:2.4.0                  |
  36 |                                      |  * onap/org.onap.oom.platform.cert-service.oom-certservice-post-processor:2.4.0       |
  37 |                                      |  * onap/org.onap.oom.platform.cert-service.oom-certservice-k8s-external-provider:2.4.0|
  38 |                                      |                                                                                       |
  39 +--------------------------------------+---------------------------------------------------------------------------------------+
  40 | **Release designation**              | Istanbul                                                                              |
  41 |                                      |                                                                                       |
  42 +--------------------------------------+---------------------------------------------------------------------------------------+
  43
  44
  45 New features
  46 ------------
  47
  48 - `OOM-2754 <https://jira.onap.org/browse/OOM-2754>`_ Implement certificate update in CMPv2 external issuer
  49
  50 - `OOM-2753 <https://jira.onap.org/browse/OOM-2753>`_ Implement certificate update in CMPv2 CertService
  51
  52 - `OOM-2744 <https://jira.onap.org/browse/OOM-2744>`_ Remove CertService Client mechanism from ONAP
  53
  54 - `OOM-2649 <https://jira.onap.org/browse/OOM-2649>`_ Update contrib/ejbca to 7.x
  55
  56 **Bug fixes**
  57
  58 - `OOM-2771 <https://jira.onap.org/browse/OOM-2771>`_ Fix CertificateRequest resource was not found issue in CMPv2 external issuer
  59
  60 - `OOM-2764 <https://jira.onap.org/browse/OOM-2764>`_ Fix sonar issues in CertService
  61
  62 **Known Issues**
  63
  64 None
  65
  66 Deliverables
  67 ------------
  68
  69 Software Deliverables
  70 ~~~~~~~~~~~~~~~~~~~~~
  71 Docker images mentioned in Release Date section.
  72
  73 Documentation Deliverables
  74 ~~~~~~~~~~~~~~~~~~~~~~~~~~
  75
  76 - :ref:`CMPv2 certificate provider description <cmpv2_cert_provider>`
  77
  78 Known Limitations, Issues and Workarounds
  79 -----------------------------------------
  80
  81 System Limitations
  82 ~~~~~~~~~~~~~~~~~~
  83
  84 Any known system limitations.
  85
  86
  87 Known Vulnerabilities
  88 ~~~~~~~~~~~~~~~~~~~~~
  89
  90 Any known vulnerabilities.
  91
  92
  93 Workarounds
  94 ~~~~~~~~~~~
  95
  96 Any known workarounds.
  97
  98
  99 Security Notes
 100 --------------
 101
 102 **Fixed Security Issues**
 103
 104 None
 105
 106 **Known Security Issues**
 107
 108 None
 109
 110
 111 Test Results
 112 ------------
 113 Not applicable
 114
 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 Version: 2.3.3
 127 ==============
 128
 129 Abstract
 130 --------
 131
 132 This document provides the release notes for the Honolulu release.
 133
 134 Summary
 135 -------
 136
 137 Certification Service provides certificates signed by external CMPv2 server - such certificates are further called operators certificates. Operators certificates are meant to secure external ONAP traffic - traffic between network functions (xNFs) and ONAP.
 138
 139 This project was moved from Application Authorization Framework (AAF), to check previous release notes see,  `AAF CertService release notes <https://docs.onap.org/projects/onap-aaf-certservice/en/frankfurt/sections/release-notes.html>`_ .
 140
 141
 142 Release Data
 143 ------------
 144
 145 +--------------------------------------+---------------------------------------------------------------------------------------+
 146 | **Project**                          | OOM                                                                                   |
 147 |                                      |                                                                                       |
 148 +--------------------------------------+---------------------------------------------------------------------------------------+
 149 | **Docker images**                    |  * onap/org.onap.oom.platform.cert-service.oom-certservice-api:2.3.3                  |
 150 |                                      |  * onap/org.onap.oom.platform.cert-service.oom-certservice-client:2.3.3               |
 151 |                                      |  * onap/org.onap.oom.platform.cert-service.oom-certservice-post-processor:2.3.3       |
 152 |                                      |  * onap/org.onap.oom.platform.cert-service.oom-certservice-k8s-external-provider:2.3.3|
 153 |                                      |                                                                                       |
 154 +--------------------------------------+---------------------------------------------------------------------------------------+
 155 | **Release designation**              | Honolulu                                                                              |
 156 |                                      |                                                                                       |
 157 +--------------------------------------+---------------------------------------------------------------------------------------+
 158
 159
 160 New features
 161 ------------
 162
 163 - `OOM-2560 <https://jira.onap.org/browse/OOM-2560>`_ Integrated CMPv2 certificate provider with Cert-Manager
 164
 165   An CMPv2 certificate provider is a part of PKI infrastructure. It consumes CertificateRequest custom resource from Cert-Manager and calls CertService API to enroll certificate from CMPv2 server.
 166   During ONAP deployment, the CMPv2 certificate provider is enabled when flags cmpv2Enabled, CMPv2CertManagerIntegration and platform.enabled equals true.
 167
 168   More information can be found on dedicated `wiki page <https://wiki.onap.org/display/DW/CertService+and+K8s+Cert-Manager+integration>`_
 169
 170 - `OOM-2632 <https://jira.onap.org/browse/OOM-2632>`_ Extended CertService API and clients to correctly support SANs parameters such as: e-mails, URIs and IP addresses.
 171
 172 **Bug fixes**
 173
 174 - `OOM-2656 <https://jira.onap.org/browse/OOM-2656>`_ Adjusted CertService API to RFC4210 - changed MAC protection algorithm and number of iteration for such algorithm.
 175
 176 - `OOM-2657 <https://jira.onap.org/browse/OOM-2657>`_ Enhanced CertServiceAPI response in order to include CMP server error messages.
 177
 178 - `OOM-2658 <https://jira.onap.org/browse/OOM-2658>`_ Fixed KeyUsage extension sent to CMPv2 server
 179
 180 **Known Issues**
 181
 182 None
 183
 184 Deliverables
 185 ------------
 186
 187 Software Deliverables
 188 ~~~~~~~~~~~~~~~~~~~~~
 189 Docker images mentioned in Release Date section.
 190
 191 Documentation Deliverables
 192 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 193
 194 - :ref:`CMPv2 certificate provider description <cmpv2_cert_provider>`
 195
 196 Known Limitations, Issues and Workarounds
 197 -----------------------------------------
 198
 199 System Limitations
 200 ------------------
 201
 202 Any known system limitations.
 203
 204
 205 Known Vulnerabilities
 206 ---------------------
 207
 208 Any known vulnerabilities.
 209
 210
 211 Workarounds
 212 -----------
 213
 214 Any known workarounds.
 215
 216
 217 Security Notes
 218 --------------
 219
 220 **Fixed Security Issues**
 221
 222 None
 223
 224 **Known Security Issues**
 225
 226 None
 227
 228
 229 Test Results
 230 ------------
 231 Not applicable
 232
 233
 234 References
 235 ----------
 236
 237 For more information on the ONAP Honolulu release, please see:
 238
 239 #. `ONAP Home Page`_
 240 #. `ONAP Documentation`_
 241 #. `ONAP Release Downloads`_
 242 #. `ONAP Wiki Page`_
 243
 244
 245 .. _`ONAP Home Page`: https://www.onap.org
 246 .. _`ONAP Wiki Page`: https://wiki.onap.org
 247 .. _`ONAP Documentation`: https://docs.onap.org
 248 .. _`ONAP Release Downloads`: https://git.onap.org