[DOCS] Update J release notes for cert-service
[oom/platform/cert-service.git] / docs / sections / release-notes.rst
index 7d32480..803ba05 100644 (file)
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. http://creativecommons.org/licenses/by/4.0
-.. Copyright 2020 NOKIA
+.. Copyright 2020-2021 NOKIA
+.. _release_notes:
 
+***************************************
+OOM Certification Service Release Notes
+***************************************
 
-Release Notes
+.. contents::
+    :depth: 2
+..
+
+Version: 2.5.0
 ==============
 
-Version: 1.1.0
---------------
+Abstract
+--------
+
+This document provides the release notes for the Jakarta release.
 
-:Release Date: 2020-06-29
+Summary
+-------
 
-**New Features**
+Vulnerability Fix
 
-        - Added property to CertService Client to allow selection of output certificates type (One of: PEM, JKS, P12).
+Release Data
+------------
 
-**Bug Fixes**
++--------------------------------------+---------------------------------------------------------------------------------------+
+| **Project**                          | OOM                                                                                   |
+|                                      |                                                                                       |
++--------------------------------------+---------------------------------------------------------------------------------------+
+| **Docker images**                    |  * onap/org.onap.oom.platform.cert-service.oom-certservice-api:2.5.0                  |
+|                                      |  * onap/org.onap.oom.platform.cert-service.oom-certservice-post-processor:2.5.0       |
+|                                      |  * onap/org.onap.oom.platform.cert-service.oom-certservice-k8s-external-provider:2.5.0|
+|                                      |                                                                                       |
++--------------------------------------+---------------------------------------------------------------------------------------+
+| **Release designation**              | Jakarta                                                                               |
+|                                      |                                                                                       |
++--------------------------------------+---------------------------------------------------------------------------------------+
 
-        - Resolved issue where created PKCS12 certificates had jks extension.
+
+New features
+------------
+
+**Bug fixes**
 
 **Known Issues**
 
-        N/A
+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.
+The required actions are described in :ref:`Troubleshooting section <troubleshooting>`
+
+Deliverables
+------------
 
-**Security Notes**
+Software Deliverables
+~~~~~~~~~~~~~~~~~~~~~
+Docker images mentioned in Release Date section.
 
-        N/A
+Documentation Deliverables
+~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-*Fixed Security Issues*
+- :ref:`CMPv2 certificate provider description <cmpv2_cert_provider>`
 
-        N/A
+Known Limitations, Issues and Workarounds
+-----------------------------------------
 
-*Known Security Issues*
+System Limitations
+~~~~~~~~~~~~~~~~~~
 
-        N/A
+Any known system limitations.
 
-*Known Vulnerabilities in Used Modules*
 
-        N/A
+Known Vulnerabilities
+~~~~~~~~~~~~~~~~~~~~~
 
-**Upgrade Notes**
+Any known vulnerabilities.
 
-**Deprecation Notes**
 
-**Other**
+Workarounds
+~~~~~~~~~~~
 
-===========
+Any known workarounds.
 
-Version: 1.0.1
+
+Security Notes
 --------------
 
-:Release Date: 2020-05-22
+**Fixed Security Issues**
 
-**New Features**
+- `OOM-2903 <https://jira.onap.org/browse/OOM-2903>`_ Fix Apache Vulnerability [CVE-2021-44228] in CertService
 
-The Frankfurt Release is the first release of the Certification Service.
+**Known Security Issues**
 
+None
 
-**Bug Fixes**
 
-        - `AAF-1132 <https://jira.onap.org/browse/AAF-1132>`_ - CertService Client returns exit status 5 when TLS configuration fails
+Test Results
+------------
+Not applicable
 
-**Known Issues**
 
-        - PKCS12 certificates have jks extension
+References
+----------
 
-**Security Notes**
+For more information on the ONAP Istanbul release, please see:
 
-        N/A
+#. `ONAP Home Page`_
+#. `ONAP Documentation`_
+#. `ONAP Release Downloads`_
+#. `ONAP Wiki Page`_
 
-*Fixed Security Issues*
+Version: 2.4.0
+==============
 
-        N/A
+Abstract
+--------
 
-*Known Security Issues*
+This document provides the release notes for the Istanbul release.
 
-        N/A
+Summary
+-------
 
-*Known Vulnerabilities in Used Modules*
+Certificate update use case is now available. For details go to:
+:ref:`How to use instructions<how_to_use_certificate_update>`
 
-        N/A
+Release Data
+------------
 
-**Upgrade Notes**
++--------------------------------------+---------------------------------------------------------------------------------------+
+| **Project**                          | OOM                                                                                   |
+|                                      |                                                                                       |
++--------------------------------------+---------------------------------------------------------------------------------------+
+| **Docker images**                    |  * onap/org.onap.oom.platform.cert-service.oom-certservice-api:2.4.0                  |
+|                                      |  * onap/org.onap.oom.platform.cert-service.oom-certservice-post-processor:2.4.0       |
+|                                      |  * onap/org.onap.oom.platform.cert-service.oom-certservice-k8s-external-provider:2.4.0|
+|                                      |                                                                                       |
++--------------------------------------+---------------------------------------------------------------------------------------+
+| **Release designation**              | Istanbul                                                                              |
+|                                      |                                                                                       |
++--------------------------------------+---------------------------------------------------------------------------------------+
 
-**Deprecation Notes**
 
-**Other**
+New features
+------------
 
-===========
+- `OOM-2754 <https://jira.onap.org/browse/OOM-2754>`_ Implement certificate update in CMPv2 external issuer
 
-Version: 1.0.0
---------------
+- `OOM-2753 <https://jira.onap.org/browse/OOM-2753>`_ Implement certificate update in CMPv2 CertService
 
-:Release Date: 2020-04-16
+- `OOM-2744 <https://jira.onap.org/browse/OOM-2744>`_ Remove CertService Client mechanism from ONAP
 
-**New Features**
+- `OOM-2649 <https://jira.onap.org/browse/OOM-2649>`_ Update contrib/ejbca to 7.x
 
-The Frankfurt Release is the first release of the Certification Service.
+**Bug fixes**
 
-**Bug Fixes**
+- `OOM-2771 <https://jira.onap.org/browse/OOM-2771>`_ Fix CertificateRequest resource was not found issue in CMPv2 external issuer
 
-        - No new fixes were implemented for this release
+- `OOM-2764 <https://jira.onap.org/browse/OOM-2764>`_ Fix sonar issues in CertService
 
 **Known Issues**
 
-        - `AAF-1132 <https://jira.onap.org/browse/AAF-1132>`_ - CertService Client returns exit status 5 when TLS configuration fails
+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.
+The required actions are described in :ref:`Troubleshooting section <troubleshooting>`
+
+Deliverables
+------------
+
+Software Deliverables
+~~~~~~~~~~~~~~~~~~~~~
+Docker images mentioned in Release Date section.
 
-        - PKCS12 certificates have jks extension
+Documentation Deliverables
+~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-**Security Notes**
+- :ref:`CMPv2 certificate provider description <cmpv2_cert_provider>`
 
-        N/A
+Known Limitations, Issues and Workarounds
+-----------------------------------------
+
+System Limitations
+~~~~~~~~~~~~~~~~~~
+
+Any known system limitations.
+
+
+Known Vulnerabilities
+~~~~~~~~~~~~~~~~~~~~~
+
+Any known vulnerabilities.
+
+
+Workarounds
+~~~~~~~~~~~
+
+Any known workarounds.
+
+
+Security Notes
+--------------
 
-*Fixed Security Issues*
+**Fixed Security Issues**
 
-        N/A
+None
 
-*Known Security Issues*
+**Known Security Issues**
 
-        N/A
+None
 
-*Known Vulnerabilities in Used Modules*
 
-        N/A
+Test Results
+------------
+Not applicable
 
-**Upgrade Notes**
 
-**Deprecation Notes**
+References
+----------
 
-**Other**
+For more information on the ONAP Istanbul release, please see:
 
-===========
+#. `ONAP Home Page`_
+#. `ONAP Documentation`_
+#. `ONAP Release Downloads`_
+#. `ONAP Wiki Page`_
 
-End of Release Notes
+.. _`ONAP Home Page`: https://www.onap.org
+.. _`ONAP Wiki Page`: https://wiki.onap.org
+.. _`ONAP Documentation`: https://docs.onap.org
+.. _`ONAP Release Downloads`: https://git.onap.org
\ No newline at end of file