Skip to content

Commit 68a8c17

Browse files
committed
docs: Add skeleton 25.7.0 release notes
1 parent 7412b28 commit 68a8c17

File tree

2 files changed

+218
-0
lines changed

2 files changed

+218
-0
lines changed

modules/ROOT/pages/release-notes.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ The Stackable Data Platform consists of multiple operators that work together.
77
Periodically a platform release is made, including all components of the platform at a specific version.
88

99
// WARNING: Please keep the empty newlines, otherwise headings are broken.
10+
include::partial$release-notes/release-25.7.adoc[]
11+
1012
include::partial$release-notes/release-25.3.adoc[]
1113

1214
include::partial$release-notes/release-24.11.adoc[]
Lines changed: 216 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,216 @@
1+
// Here are the headings you can use for the next release. Saves time checking indentation levels.
2+
// Take a look at release 24.11 to see how to structure patch releases.
3+
4+
== Release 25.7
5+
6+
=== 25.7.0
7+
8+
Released on YYYY-MM-DD.
9+
(Optional description / introduction)
10+
11+
==== New platform features
12+
13+
==== Platform improvements
14+
15+
==== Platform deprecations
16+
17+
==== Product versions
18+
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].
21+
22+
Refer to the xref:operators:supported_versions.adoc[supported versions] documentation for a complete overview including LTS versions or deprecations.
23+
24+
===== New versions
25+
26+
The following new product versions are now supported:
27+
28+
* ...
29+
30+
===== Deprecated versions
31+
32+
The following product versions are deprecated and will be removed in a later release:
33+
34+
* ...
35+
36+
===== Removed versions
37+
38+
The following product versions are no longer supported (although images for released product versions remain available https://oci.stackable.tech/[here,window=_blank]. Information on how to browse the registry can be found xref:contributor:project-overview.adoc#docker-images[here,window=_blank].):
39+
40+
* ...
41+
42+
==== stackablectl
43+
44+
==== Supported Kubernetes versions
45+
46+
This release supports the following Kubernetes versions:
47+
48+
* `1.XX`
49+
50+
These Kubernetes versions are no longer supported:
51+
52+
* `1.XX`
53+
54+
==== Supported OpenShift versions
55+
56+
This release is available in the RedHat Certified Operator Catalog for the following OpenShift versions:
57+
58+
* `4.XX`
59+
60+
These OpenShift versions are no longer supported:
61+
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+
====
79+
80+
==== Upgrade from 25.3
81+
82+
===== Using stackablectl
83+
84+
====== Upgrade with a single command
85+
86+
Starting with stackablectl Release 1.0.0 the multiple consecutive commands described below can be shortened to just one command, which executes exactly those steps on its own.
87+
88+
[source,console]
89+
----
90+
$ stackablectl release upgrade 25.7
91+
----
92+
93+
====== Upgrade with multiple consecutive commands
94+
95+
Uninstall the `25.3` release
96+
97+
[source,console]
98+
----
99+
$ stackablectl release uninstall 25.3
100+
101+
Uninstalled release '25.3'
102+
103+
Use "stackablectl release list" to list available releases.
104+
# ...
105+
----
106+
107+
Afterwards you will need to upgrade the CustomResourceDefinitions (CRDs) installed by the Stackable Platform.
108+
The reason for this is that helm will uninstall the operators but not the CRDs.
109+
This can be done using `kubectl replace`.
110+
111+
[source]
112+
----
113+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/airflow-operator/25.7.0/deploy/helm/airflow-operator/crds/crds.yaml
114+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/commons-operator/25.7.0/deploy/helm/commons-operator/crds/crds.yaml
115+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/druid-operator/25.7.0/deploy/helm/druid-operator/crds/crds.yaml
116+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/hbase-operator/25.7.0/deploy/helm/hbase-operator/crds/crds.yaml
117+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/hdfs-operator/25.7.0/deploy/helm/hdfs-operator/crds/crds.yaml
118+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/hive-operator/25.7.0/deploy/helm/hive-operator/crds/crds.yaml
119+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/kafka-operator/25.7.0/deploy/helm/kafka-operator/crds/crds.yaml
120+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/listener-operator/25.7.0/deploy/helm/listener-operator/crds/crds.yaml
121+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/nifi-operator/25.7.0/deploy/helm/nifi-operator/crds/crds.yaml
122+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/opa-operator/25.7.0/deploy/helm/opa-operator/crds/crds.yaml
123+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/secret-operator/25.7.0/deploy/helm/secret-operator/crds/crds.yaml
124+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/spark-k8s-operator/25.7.0/deploy/helm/spark-k8s-operator/crds/crds.yaml
125+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/superset-operator/25.7.0/deploy/helm/superset-operator/crds/crds.yaml
126+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/trino-operator/25.7.0/deploy/helm/trino-operator/crds/crds.yaml
127+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/zookeeper-operator/25.7.0/deploy/helm/zookeeper-operator/crds/crds.yaml
128+
----
129+
130+
[source,console]
131+
----
132+
customresourcedefinition.apiextensions.k8s.io "airflowclusters.airflow.stackable.tech" replaced
133+
customresourcedefinition.apiextensions.k8s.io "authenticationclasses.authentication.stackable.tech" replaced
134+
customresourcedefinition.apiextensions.k8s.io "s3connections.s3.stackable.tech" replaced
135+
...
136+
----
137+
138+
Install the `25.7` release
139+
140+
[source,console]
141+
----
142+
$ stackablectl release install 25.7
143+
144+
Installed release '25.7'
145+
146+
Use "stackablectl operator installed" to list installed operators.
147+
----
148+
149+
===== Using Helm
150+
151+
Use `helm list` to list the currently installed operators.
152+
153+
You can use the following command to uninstall all operators that are part of the `25.3` release:
154+
155+
[source,console]
156+
----
157+
$ helm uninstall airflow-operator commons-operator druid-operator hbase-operator hdfs-operator hive-operator kafka-operator listener-operator nifi-operator opa-operator secret-operator spark-k8s-operator superset-operator trino-operator zookeeper-operator
158+
release "airflow-operator" uninstalled
159+
release "commons-operator" uninstalled
160+
...
161+
----
162+
163+
Afterward you will need to upgrade the CustomResourceDefinitions (CRDs) installed by the Stackable Platform.
164+
The reason for this is that helm will uninstall the operators but not the CRDs. This can be done using `kubectl replace`:
165+
166+
[source]
167+
----
168+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/airflow-operator/25.7.0/deploy/helm/airflow-operator/crds/crds.yaml
169+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/commons-operator/25.7.0/deploy/helm/commons-operator/crds/crds.yaml
170+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/druid-operator/25.7.0/deploy/helm/druid-operator/crds/crds.yaml
171+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/hbase-operator/25.7.0/deploy/helm/hbase-operator/crds/crds.yaml
172+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/hdfs-operator/25.7.0/deploy/helm/hdfs-operator/crds/crds.yaml
173+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/hive-operator/25.7.0/deploy/helm/hive-operator/crds/crds.yaml
174+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/kafka-operator/25.7.0/deploy/helm/kafka-operator/crds/crds.yaml
175+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/listener-operator/25.7.0/deploy/helm/listener-operator/crds/crds.yaml
176+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/nifi-operator/25.7.0/deploy/helm/nifi-operator/crds/crds.yaml
177+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/opa-operator/25.7.0/deploy/helm/opa-operator/crds/crds.yaml
178+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/secret-operator/25.7.0/deploy/helm/secret-operator/crds/crds.yaml
179+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/spark-k8s-operator/25.7.0/deploy/helm/spark-k8s-operator/crds/crds.yaml
180+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/superset-operator/25.7.0/deploy/helm/superset-operator/crds/crds.yaml
181+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/trino-operator/25.7.0/deploy/helm/trino-operator/crds/crds.yaml
182+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/zookeeper-operator/25.7.0/deploy/helm/zookeeper-operator/crds/crds.yaml
183+
----
184+
185+
[source,console]
186+
----
187+
customresourcedefinition.apiextensions.k8s.io "airflowclusters.airflow.stackable.tech" replaced
188+
customresourcedefinition.apiextensions.k8s.io "authenticationclasses.authentication.stackable.tech" replaced
189+
customresourcedefinition.apiextensions.k8s.io "s3connections.s3.stackable.tech" replaced
190+
...
191+
----
192+
193+
Install the `25.7` release
194+
195+
NOTE: `helm repo` subcommands are not supported for OCI registries. The operators are installed directly, without adding the Helm Chart repository first.
196+
197+
[source,console]
198+
----
199+
helm install --wait airflow-operator oci://oci.stackable.tech/sdp-charts/airflow-operator --version 25.7.0
200+
helm install --wait commons-operator oci://oci.stackable.tech/sdp-charts/commons-operator --version 25.7.0
201+
helm install --wait druid-operator oci://oci.stackable.tech/sdp-charts/druid-operator --version 25.7.0
202+
helm install --wait hbase-operator oci://oci.stackable.tech/sdp-charts/hbase-operator --version 25.7.0
203+
helm install --wait hdfs-operator oci://oci.stackable.tech/sdp-charts/hdfs-operator --version 25.7.0
204+
helm install --wait hive-operator oci://oci.stackable.tech/sdp-charts/hive-operator --version 25.7.0
205+
helm install --wait kafka-operator oci://oci.stackable.tech/sdp-charts/kafka-operator --version 25.7.0
206+
helm install --wait listener-operator oci://oci.stackable.tech/sdp-charts/listener-operator --version 25.7.0
207+
helm install --wait nifi-operator oci://oci.stackable.tech/sdp-charts/nifi-operator --version 25.7.0
208+
helm install --wait opa-operator oci://oci.stackable.tech/sdp-charts/opa-operator --version 25.7.0
209+
helm install --wait secret-operator oci://oci.stackable.tech/sdp-charts/secret-operator --version 25.7.0
210+
helm install --wait spark-k8s-operator oci://oci.stackable.tech/sdp-charts/spark-k8s-operator --version 25.7.0
211+
helm install --wait superset-operator oci://oci.stackable.tech/sdp-charts/superset-operator --version 25.7.0
212+
helm install --wait trino-operator oci://oci.stackable.tech/sdp-charts/trino-operator --version 25.7.0
213+
helm install --wait zookeeper-operator oci://oci.stackable.tech/sdp-charts/zookeeper-operator --version 25.7.0
214+
----
215+
216+
==== Known issues

0 commit comments

Comments
 (0)