Skip to content

Commit 0fd5ae0

Browse files
TechassiTechassi
committed
docs: Update release notes template
1 parent 407279c commit 0fd5ae0

File tree

1 file changed

+111
-41
lines changed

1 file changed

+111
-41
lines changed

‎modules/ROOT/partials/release-notes/release-template.adoc‎

Lines changed: 111 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -8,74 +8,142 @@
88
Released on YYYY-MM-DD.
99
(Optional description / introduction)
1010

11+
[TIP,caption=Release highlights]
12+
====
13+
* Highlight 1
14+
* Highlight 2
15+
* Highlight 3
16+
====
17+
1118
==== New platform features
1219

20+
All subsections must follow this order:
21+
22+
* Apache Airflow
23+
* Apache Druid
24+
* Apache HBase
25+
* Apache Hadoop
26+
* Apache Hive
27+
* Apache Kafka
28+
* Apache NiFi
29+
* Apache Omid
30+
* Apache Phoenix
31+
* Apache Spark
32+
* Apache Superset
33+
* Apache ZooKeeper
34+
* OpenSearch
35+
* Open Policy Agent
36+
* Trino
37+
* Vector
38+
39+
Potential sub headers...
40+
41+
===== General
42+
43+
====== Security/Observability/Authorization/Miscellaneous
44+
45+
===== Apache Project and Stackable <CORE>-operator
46+
1347
==== Platform improvements
1448

49+
Mark any breaking changes with *Breaking:*.
50+
51+
===== General
52+
53+
====== Vulnerabilities
54+
55+
YYY CVEs were fixed in the Stackable product images.
56+
This includes X critical and XX high-severity CVEs.
57+
58+
====== Authorization/Miscellaneous
59+
60+
===== Apache Project and Stackable <CORE>-operator
61+
62+
==== Platform fixes
63+
64+
===== General
65+
66+
====== Security/Observability/Authorization/Miscellaneous
67+
68+
===== Apache Project and Stackable <CORE>-operator
69+
1570
==== Platform deprecations
1671

17-
==== Product versions
72+
===== Apache Project and Stackable <CORE>-operator
1873

19-
As with previous SDP releases, many product images have been updated to their latest versions.
20-
The LTS version has in many cases also been adjusted in line with our xref:ROOT:policies.adoc[support policy].
74+
==== Platform removals
75+
76+
Mark any breaking changes with *Breaking:*.
77+
78+
===== General
2179

80+
===== Apache Project and Stackable <CORE>-operator
81+
82+
==== Supported versions
83+
84+
===== Product versions
85+
86+
As with previous SDP releases, many product images have been updated to their latest versions.
2287
Refer to the xref:operators:supported_versions.adoc[supported versions] documentation for a complete overview including LTS versions or deprecations.
2388

24-
===== New versions
89+
====== New LTS versions
90+
91+
The following product versions were already available before but are now marked as the xref:compliance:policies.adoc#_product_lifecycle_policy[LTS] version:
92+
93+
* Product 1: https://example.org[1.2.3 (LTS)]
94+
* Product 2: https://example.org[1.2.3 (LTS)]
95+
96+
====== New versions
2597

2698
The following new product versions are now supported:
2799

28-
* ...
100+
* Product 1: https://example.org[1.2.3]
101+
* Product 2: https://example.org[1.2.3 (LTS)]
102+
* Product 2: https://example.org[1.2.3 (experimental)]
29103

30-
===== Deprecated versions
104+
====== Deprecated versions
31105

32106
The following product versions are deprecated and will be removed in a later release:
33107

34-
* ...
35-
36-
===== Removed versions
108+
* Product 1: https://example.org[1.2.3]
109+
* Product 2: https://example.org[1.2.3]
110+
* Product 2: https://example.org[1.2.3]
37111

38-
The following product versions are no longer supported (although images for released product versions remain available https://oci.stackable.tech/[here{external-link-icon}^]. Information on how to browse the registry can be found xref:contributor:project-overview.adoc#docker-images[here,window=_blank].):
112+
====== Removed versions
39113

40-
* ...
114+
The following product versions are no longer supported.
115+
These images for released product versions remain available https://oci.stackable.tech/[here,window=_blank].
116+
Information on how to browse the registry can be found xref:contributor:project-overview.adoc#docker-images[here,window=_blank].
41117

42-
==== stackablectl
118+
* Product 1: https://example.org[1.2.3]
119+
* Product 2: https://example.org[1.2.3]
120+
* Product 2: https://example.org[1.2.3]
43121

44-
==== Supported Kubernetes versions
122+
===== Kubernetes versions
45123

46124
This release supports the following Kubernetes versions:
47125

48-
* `1.XX`
126+
* `1.33`
127+
* `1.32`
128+
* `1.31`
129+
* `1.30`
49130

50131
These Kubernetes versions are no longer supported:
51132

52-
* `1.XX`
133+
* `1.29`
53134

54-
==== Supported OpenShift versions
135+
===== OpenShift versions
55136

56137
This release is available in the RedHat Certified Operator Catalog for the following OpenShift versions:
57138

58-
* `4.XX`
139+
* `4.18`
140+
* `4.17`
141+
* `4.16`
59142

60143
These OpenShift versions are no longer supported:
61144

62-
* `4.XX`
63-
64-
==== Breaking changes
65-
66-
Of the changes mentioned above, the following are breaking (or could lead to breaking behaviour), and you will need to adapt your existing CRDs accordingly:
67-
68-
===== Stackable Operator for Example Product
69-
70-
* Description of the change 1
71-
* Description of the change 2
72-
73-
.Breaking changes details
74-
[%collapsible]
75-
====
76-
* `spec.a`: This field has been removed.
77-
* `spec.b`: This field has been changed to a number.
78-
====
145+
* `4.15`
146+
* `4.14`
79147

80148
==== Upgrade from OO.M
81149

@@ -108,7 +176,7 @@ Afterwards you will need to upgrade the CustomResourceDefinitions (CRDs) install
108176
The reason for this is that helm will uninstall the operators but not the CRDs.
109177
This can be done using `kubectl replace`.
110178

111-
[source]
179+
[source,shell]
112180
----
113181
kubectl replace -f https://raw.githubusercontent.com/stackabletech/airflow-operator/YY.M.X/deploy/helm/airflow-operator/crds/crds.yaml
114182
kubectl replace -f https://raw.githubusercontent.com/stackabletech/commons-operator/YY.M.X/deploy/helm/commons-operator/crds/crds.yaml
@@ -120,14 +188,13 @@ kubectl replace -f https://raw.githubusercontent.com/stackabletech/kafka-operato
120188
kubectl replace -f https://raw.githubusercontent.com/stackabletech/listener-operator/YY.M.X/deploy/helm/listener-operator/crds/crds.yaml
121189
kubectl replace -f https://raw.githubusercontent.com/stackabletech/nifi-operator/YY.M.X/deploy/helm/nifi-operator/crds/crds.yaml
122190
kubectl replace -f https://raw.githubusercontent.com/stackabletech/opa-operator/YY.M.X/deploy/helm/opa-operator/crds/crds.yaml
123-
kubectl replace -f https://raw.githubusercontent.com/stackabletech/secret-operator/YY.M.X/deploy/helm/secret-operator/crds/crds.yaml
124191
kubectl replace -f https://raw.githubusercontent.com/stackabletech/spark-k8s-operator/YY.M.X/deploy/helm/spark-k8s-operator/crds/crds.yaml
125192
kubectl replace -f https://raw.githubusercontent.com/stackabletech/superset-operator/YY.M.X/deploy/helm/superset-operator/crds/crds.yaml
126193
kubectl replace -f https://raw.githubusercontent.com/stackabletech/trino-operator/YY.M.X/deploy/helm/trino-operator/crds/crds.yaml
127194
kubectl replace -f https://raw.githubusercontent.com/stackabletech/zookeeper-operator/YY.M.X/deploy/helm/zookeeper-operator/crds/crds.yaml
128195
----
129196

130-
[source,console]
197+
[source]
131198
----
132199
customresourcedefinition.apiextensions.k8s.io "airflowclusters.airflow.stackable.tech" replaced
133200
customresourcedefinition.apiextensions.k8s.io "authenticationclasses.authentication.stackable.tech" replaced
@@ -164,7 +231,7 @@ Afterward you will need to upgrade the CustomResourceDefinitions (CRDs) installe
164231
The reason for this is that helm will uninstall the operators but not the CRDs.
165232
This can be done using `kubectl replace`.
166233

167-
[source]
234+
[source,shell]
168235
----
169236
kubectl replace -f https://raw.githubusercontent.com/stackabletech/airflow-operator/YY.M.X/deploy/helm/airflow-operator/crds/crds.yaml
170237
kubectl replace -f https://raw.githubusercontent.com/stackabletech/commons-operator/YY.M.X/deploy/helm/commons-operator/crds/crds.yaml
@@ -176,14 +243,13 @@ kubectl replace -f https://raw.githubusercontent.com/stackabletech/kafka-operato
176243
kubectl replace -f https://raw.githubusercontent.com/stackabletech/listener-operator/YY.M.X/deploy/helm/listener-operator/crds/crds.yaml
177244
kubectl replace -f https://raw.githubusercontent.com/stackabletech/nifi-operator/YY.M.X/deploy/helm/nifi-operator/crds/crds.yaml
178245
kubectl replace -f https://raw.githubusercontent.com/stackabletech/opa-operator/YY.M.X/deploy/helm/opa-operator/crds/crds.yaml
179-
kubectl replace -f https://raw.githubusercontent.com/stackabletech/secret-operator/YY.M.X/deploy/helm/secret-operator/crds/crds.yaml
180246
kubectl replace -f https://raw.githubusercontent.com/stackabletech/spark-k8s-operator/YY.M.X/deploy/helm/spark-k8s-operator/crds/crds.yaml
181247
kubectl replace -f https://raw.githubusercontent.com/stackabletech/superset-operator/YY.M.X/deploy/helm/superset-operator/crds/crds.yaml
182248
kubectl replace -f https://raw.githubusercontent.com/stackabletech/trino-operator/YY.M.X/deploy/helm/trino-operator/crds/crds.yaml
183249
kubectl replace -f https://raw.githubusercontent.com/stackabletech/zookeeper-operator/YY.M.X/deploy/helm/zookeeper-operator/crds/crds.yaml
184250
----
185251

186-
[source,console]
252+
[source]
187253
----
188254
customresourcedefinition.apiextensions.k8s.io "airflowclusters.airflow.stackable.tech" replaced
189255
customresourcedefinition.apiextensions.k8s.io "authenticationclasses.authentication.stackable.tech" replaced
@@ -193,7 +259,8 @@ customresourcedefinition.apiextensions.k8s.io "s3connections.s3.stackable.tech"
193259

194260
Install the `YY.M` release
195261

196-
NOTE: `helm repo` subcommands are not supported for OCI registries. The operators are installed directly, without adding the Helm Chart repository first.
262+
NOTE: `helm repo` subcommands are not supported for OCI registries.
263+
The operators are installed directly, without adding the Helm Chart repository first.
197264

198265
[source,console]
199266
----
@@ -214,4 +281,7 @@ helm install --wait trino-operator oci://oci.stackable.tech/sdp-charts/trino-ope
214281
helm install --wait zookeeper-operator oci://oci.stackable.tech/sdp-charts/zookeeper-operator --version YY.M.X
215282
----
216283

284+
[#known-issues-YY_M_X]
217285
==== Known issues
286+
287+
Note down any potential known issues.

0 commit comments

Comments
 (0)