Merge "[OOF] Update configuration for TN-FH in NxI termination app"
[oom.git] / docs / release_notes / release-notes-guilin.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_guilin:
6
7 :orphan:
8
9 *************************************
10 ONAP Operations Manager Release Notes
11 *************************************
12
13 Previous Release Notes
14 ======================
15
16 - :ref:`Frankfurt <release_notes_frankfurt>`
17 - :ref:`El Alto <release_notes_elalto>`
18 - :ref:`Dublin <release_notes_dublin>`
19 - :ref:`Casablanca <release_notes_casablanca>`
20 - :ref:`Beijing <release_notes_beijing>`
21 - :ref:`Amsterdam <release_notes_amsterdam>`
22
23 Abstract
24 ========
25
26 This document provides the release notes for the Guilin release.
27
28 Summary
29 =======
30
31 The focus of this release is to strengthen the foundation of OOM installer.
32
33 Release Data
34 ============
35
36 +--------------------------------------+--------------------------------------+
37 | **Project**                          | OOM                                  |
38 |                                      |                                      |
39 +--------------------------------------+--------------------------------------+
40 | **Docker images**                    | N/A                                  |
41 |                                      |                                      |
42 +--------------------------------------+--------------------------------------+
43 | **Release designation**              | Guilin                               |
44 |                                      |                                      |
45 +--------------------------------------+--------------------------------------+
46 | **Release date**                     | 2020/12/03                           |
47 |                                      |                                      |
48 +--------------------------------------+--------------------------------------+
49
50 New features
51 ------------
52
53 * Kubernetes support for version up to 1.19
54 * Helm (experimental) support for version up to 3.3
55 * Limits are set for most of the components
56
57 **Bug fixes**
58
59 A list of issues resolved in this release can be found here:
60 https://jira.onap.org/projects/OOM/versions/10826
61
62 **Known Issues**
63
64 - `OOM-1237 <https://jira.onap.org/browse/OOM-1237>`_ Source Helm Charts from
65   ONAP Repo. Having helm charts repo is not possible for Frankfurt release.
66 - `OOM-1720 <https://jira.onap.org/browse/OOM-1237>`_ galera container is
67   outdated. containers used for mariadb are outdated and not supported anymore.
68 - `OOM-1817 <https://jira.onap.org/browse/OOM-1817>`_ Use of global.repository
69   inconsistent across Helm Charts. it's then may be hard to retrieve some
70   containers when deploying in constrained environment.
71 - `OOM-2227 <https://jira.onap.org/browse/OOM-2227>`_ Cassandra Backup Mechanism
72   works only on "static PV" mode.
73 - `OOM-2285 <https://jira.onap.org/browse/OOM-2285>`_ deploy.sh does not work
74   for mariadb-galera. deploy script doesn't behave well with "-" in the
75   component name.
76 - `OOM-2421 <https://jira.onap.org/browse/OOM-2421>`_ OOM nbi chart deployment
77   error
78 - `OOM-2534 <https://jira.onap.org/browse/OOM-2534>`_ Cert-Service leverages
79   runtime external dependency
80 - `OOM-2554 <https://jira.onap.org/browse/OOM-2554>`_ Common pods have java 8
81 - `OOM-2588 <https://jira.onap.org/browse/OOM-2588>`_ Various subcharts not
82   installing due to helm size issues
83 - `OOM-2629 <https://jira.onap.org/browse/OOM-2629>`_ NetBox demo entry setup
84   not complete
85
86
87 Deliverables
88 ------------
89
90 Software Deliverables
91 ~~~~~~~~~~~~~~~~~~~~~
92
93 OOM provides `Helm charts <https://git.onap.org/oom/>`_ that needs to be
94 "compiled" into Helm package. see step 6 in
95 :doc:`quickstart guide <../oom_quickstart_guide>`.
96
97 Documentation Deliverables
98 ~~~~~~~~~~~~~~~~~~~~~~~~~~
99
100 - :doc:`Project Description <../oom_project_description>`
101 - :doc:`Cloud Setup Guide <../oom_cloud_setup_guide>`
102 - :doc:`Quick Start Guide <../oom_quickstart_guide>`
103 - :doc:`Setup Ingress Controller <../oom_setup_ingress_controller>`
104 - :doc:`Developer Guide <../oom_developer_guide>`
105 - :doc:`Hardcoded Certificates <../oom_hardcoded_certificates>`
106
107 Known Limitations, Issues and Workarounds
108 =========================================
109
110 Known Vulnerabilities
111 ---------------------
112
113 - Hard coded password used for all OOM deployments
114   [`OJSI-188 <https://jira.onap.org/browse/OJSI-188>`_]
115 - :doc:`Hard coded certificates <../oom_hardcoded_certificates>` in Helm packages
116
117 Workarounds
118 -----------
119
120 - `OOM-1237 <https://jira.onap.org/browse/OOM-1237>`_ Workaround is to generate
121   them as explained in documentation.
122 - `OOM-1817 <https://jira.onap.org/browse/OOM-1817>`_ Workaround is to use
123   offline installer if needed.
124 - `OOM-2227 <https://jira.onap.org/browse/OOM-2227>`_ Workaround is to stick to
125   "static PV" (so, not using storage class) if backup is needed.
126 - `OOM-2285 <https://jira.onap.org/browse/OOM-2285>`_ Workaround is to use
127   directly helm upgrade if needed.
128 - `OOM-2534 <https://jira.onap.org/browse/OOM-2534>`_ Workaround is to download
129   in advance docker.io/openjdk:11-jre-slim where you will generate the charts
130
131 Security Notes
132 --------------
133
134 **Fixed Security Issues**
135
136 References
137 ==========
138
139 For more information on the ONAP Frankfurt release, please see:
140
141 #. `ONAP Home Page`_
142 #. `ONAP Documentation`_
143 #. `ONAP Release Downloads`_
144 #. `ONAP Wiki Page`_
145
146
147 .. _`ONAP Home Page`: https://www.onap.org
148 .. _`ONAP Wiki Page`: https://wiki.onap.org
149 .. _`ONAP Documentation`: https://docs.onap.org
150 .. _`ONAP Release Downloads`: https://git.onap.org