Skip to content

chore(tracking): Release Notes for SDP 24.11.1 #704

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Jan 28, 2025
Merged

chore(tracking): Release Notes for SDP 24.11.1 #704

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
b03c967
chore: Release notes for 24.11.1
NickLarsenNZ Jan 27, 2025
78a5510
chore: add release-note about secret-operator migration jobs
NickLarsenNZ Jan 27, 2025
767c8d4
chore: add patch upgrade instructions
NickLarsenNZ Jan 28, 2025
2543887
docs: Fix typo
Techassi Jan 28, 2025
8662da7
docs: Fix fragment links
Techassi Jan 28, 2025
f00700c
docs: Add inline code
Techassi Jan 28, 2025
4194231
Update versions in getting-started
NickLarsenNZ Jan 28, 2025
e704c17
Merge branch 'main' into docs/release-notes-24.11.1
NickLarsenNZ Jan 28, 2025
7a467f2
Apply suggestions from code review
NickLarsenNZ Jan 28, 2025
7d9f4a8
Revert to standard upgrade procedure
NickLarsenNZ Jan 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions modules/ROOT/pages/getting-started.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,12 +55,12 @@ Install the operators:

[source,bash]
----
helm install zookeeper-operator stackable-stable/zookeeper-operator --version=24.11.0
helm install kafka-operator stackable-stable/kafka-operator --version=24.11.0
helm install secret-operator stackable-stable/secret-operator --version=24.11.0
helm install listener-operator stackable-stable/listener-operator --version=24.11.0
helm install commons-operator stackable-stable/commons-operator --version=24.11.0
helm install nifi-operator stackable-stable/nifi-operator --version=24.11.0
helm install zookeeper-operator stackable-stable/zookeeper-operator --version=24.11.1
helm install kafka-operator stackable-stable/kafka-operator --version=24.11.1
helm install secret-operator stackable-stable/secret-operator --version=24.11.1
helm install listener-operator stackable-stable/listener-operator --version=24.11.1
helm install commons-operator stackable-stable/commons-operator --version=24.11.1
helm install nifi-operator stackable-stable/nifi-operator --version=24.11.1
----
====

Expand All @@ -69,12 +69,12 @@ You can check which operators are installed using `stackablectl operator install
[source,console]
----
OPERATOR VERSION NAMESPACE STATUS LAST UPDATED
commons 24.11.0 default deployed 2024-11-30 17:58:32.916032854 +0100 CET
kafka 24.11.0 default deployed 2024-11-30 17:58:55.036115353 +0100 CET
listener 24.11.0 default deployed 2024-11-30 17:59:18.136775259 +0100 CET
nifi 24.11.0 default deployed 2024-11-30 17:59:51.927081648 +0100 CET
secret 24.11.0 default deployed 2024-11-30 18:00:05.060241771 +0100 CET
zookeeper 24.11.0 default deployed 2024-11-30 18:00:08.425686918 +0100 CET
commons 24.11.1 default deployed 2024-11-30 17:58:32.916032854 +0100 CET
kafka 24.11.1 default deployed 2024-11-30 17:58:55.036115353 +0100 CET
listener 24.11.1 default deployed 2024-11-30 17:59:18.136775259 +0100 CET
nifi 24.11.1 default deployed 2024-11-30 17:59:51.927081648 +0100 CET
secret 24.11.1 default deployed 2024-11-30 18:00:05.060241771 +0100 CET
zookeeper 24.11.1 default deployed 2024-11-30 18:00:08.425686918 +0100 CET
----

== Deploying Stackable Services
Expand Down
155 changes: 153 additions & 2 deletions modules/ROOT/partials/release-notes/release-24.11.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,163 @@

=== 24.11.1

Released on 2024-01-20.
This patch release fixes two issues that were discovered since the <<_24_11_0>> release.

==== Breaking Changes

Distinct ServiceAccounts are now used for the Stacklets so that multiple Stacklets of the same product can be deployed in one namespace.
Existing Stacklets will use the newly created ServiceAccounts after restart.

WARNING: Manually adapted ServiceAccounts must be updated.

==== Other fixes

* Secret Operator Helm chart: The secret migration job required for upgrading from SDP 24.3 to 24.7 can now be omitted by setting the Helm value `secretMigrationJob.enabled` to false.
* The following operators have been fixed to work correctly with OpenID Connect rootPaths with and without trailing slashes:
** Nifi Operator
** Trino Operator
** Druid Operator
** Airflow Operator
** Superset Operator

==== Upgrade to the 24.11.1 patch release

[NOTE]
====
These instructions apply to upgrades from `24.7.0` and `24.11.0`.
In the examples below, we will show an upgrade from `24.11.0`.
====

===== Using stackablectl

Uninstall the `24.11` release

[source,console]
----
$ stackablectl release uninstall 24.11

Uninstalled release '24.11'

Use "stackablectl release list" to list available releases.
# ...
----

Afterwards you will need to upgrade the CustomResourceDefinitions (CRDs) installed by the Stackable Platform.
The reason for this is that helm will uninstall the operators but not the CRDs.
This can be done using `kubectl replace`.

[source]
----
kubectl replace -f https://raw.githubusercontent.com/stackabletech/airflow-operator/24.11.1/deploy/helm/airflow-operator/crds/crds.yaml
kubectl replace -f https://raw.githubusercontent.com/stackabletech/commons-operator/24.11.1/deploy/helm/commons-operator/crds/crds.yaml
kubectl replace -f https://raw.githubusercontent.com/stackabletech/druid-operator/24.11.1/deploy/helm/druid-operator/crds/crds.yaml
kubectl replace -f https://raw.githubusercontent.com/stackabletech/hbase-operator/24.11.1/deploy/helm/hbase-operator/crds/crds.yaml
kubectl replace -f https://raw.githubusercontent.com/stackabletech/hdfs-operator/24.11.1/deploy/helm/hdfs-operator/crds/crds.yaml
kubectl replace -f https://raw.githubusercontent.com/stackabletech/hive-operator/24.11.1/deploy/helm/hive-operator/crds/crds.yaml
kubectl replace -f https://raw.githubusercontent.com/stackabletech/kafka-operator/24.11.1/deploy/helm/kafka-operator/crds/crds.yaml
kubectl replace -f https://raw.githubusercontent.com/stackabletech/listener-operator/24.11.1/deploy/helm/listener-operator/crds/crds.yaml
kubectl replace -f https://raw.githubusercontent.com/stackabletech/nifi-operator/24.11.1/deploy/helm/nifi-operator/crds/crds.yaml
kubectl replace -f https://raw.githubusercontent.com/stackabletech/opa-operator/24.11.1/deploy/helm/opa-operator/crds/crds.yaml
kubectl replace -f https://raw.githubusercontent.com/stackabletech/secret-operator/24.11.1/deploy/helm/secret-operator/crds/crds.yaml
kubectl replace -f https://raw.githubusercontent.com/stackabletech/spark-k8s-operator/24.11.1/deploy/helm/spark-k8s-operator/crds/crds.yaml
kubectl replace -f https://raw.githubusercontent.com/stackabletech/superset-operator/24.11.1/deploy/helm/superset-operator/crds/crds.yaml
kubectl replace -f https://raw.githubusercontent.com/stackabletech/trino-operator/24.11.1/deploy/helm/trino-operator/crds/crds.yaml
kubectl replace -f https://raw.githubusercontent.com/stackabletech/zookeeper-operator/24.11.1/deploy/helm/zookeeper-operator/crds/crds.yaml
----

[source,console]
----
customresourcedefinition.apiextensions.k8s.io "airflowclusters.airflow.stackable.tech" replaced
customresourcedefinition.apiextensions.k8s.io "airflowdbs.airflow.stackable.tech" replaced
customresourcedefinition.apiextensions.k8s.io "authenticationclasses.authentication.stackable.tech" replaced
customresourcedefinition.apiextensions.k8s.io "s3connections.s3.stackable.tech" replaced
...
----

Install the `24.11` release

[source,console]
----
$ stackablectl release install 24.11

Installed release '24.11'

Use "stackablectl operator installed" to list installed operators.
----

===== Using Helm

Use `helm list` to list the currently installed operators.

You can use the following command to uninstall all operators that are part of the `24.11` release:

[source,console]
----
$ 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
release "airflow-operator" uninstalled
release "commons-operator" uninstalled
...
----

Afterward you will need to upgrade the CustomResourceDefinitions (CRDs) installed by the Stackable Platform.
The reason for this is that helm will uninstall the operators but not the CRDs. This can be done using `kubectl replace`:

[source]
----
kubectl replace -f https://raw.githubusercontent.com/stackabletech/airflow-operator/24.11.1/deploy/helm/airflow-operator/crds/crds.yaml
kubectl replace -f https://raw.githubusercontent.com/stackabletech/commons-operator/24.11.1/deploy/helm/commons-operator/crds/crds.yaml
kubectl replace -f https://raw.githubusercontent.com/stackabletech/druid-operator/24.11.1/deploy/helm/druid-operator/crds/crds.yaml
kubectl replace -f https://raw.githubusercontent.com/stackabletech/hbase-operator/24.11.1/deploy/helm/hbase-operator/crds/crds.yaml
kubectl replace -f https://raw.githubusercontent.com/stackabletech/hdfs-operator/24.11.1/deploy/helm/hdfs-operator/crds/crds.yaml
kubectl replace -f https://raw.githubusercontent.com/stackabletech/hive-operator/24.11.1/deploy/helm/hive-operator/crds/crds.yaml
kubectl replace -f https://raw.githubusercontent.com/stackabletech/kafka-operator/24.11.1/deploy/helm/kafka-operator/crds/crds.yaml
kubectl replace -f https://raw.githubusercontent.com/stackabletech/listener-operator/24.11.1/deploy/helm/listener-operator/crds/crds.yaml
kubectl replace -f https://raw.githubusercontent.com/stackabletech/nifi-operator/24.11.1/deploy/helm/nifi-operator/crds/crds.yaml
kubectl replace -f https://raw.githubusercontent.com/stackabletech/opa-operator/24.11.1/deploy/helm/opa-operator/crds/crds.yaml
kubectl replace -f https://raw.githubusercontent.com/stackabletech/secret-operator/24.11.1/deploy/helm/secret-operator/crds/crds.yaml
kubectl replace -f https://raw.githubusercontent.com/stackabletech/spark-k8s-operator/24.11.1/deploy/helm/spark-k8s-operator/crds/crds.yaml
kubectl replace -f https://raw.githubusercontent.com/stackabletech/superset-operator/24.11.1/deploy/helm/superset-operator/crds/crds.yaml
kubectl replace -f https://raw.githubusercontent.com/stackabletech/trino-operator/24.11.1/deploy/helm/trino-operator/crds/crds.yaml
kubectl replace -f https://raw.githubusercontent.com/stackabletech/zookeeper-operator/24.11.1/deploy/helm/zookeeper-operator/crds/crds.yaml
----

[source,console]
----
customresourcedefinition.apiextensions.k8s.io "airflowclusters.airflow.stackable.tech" replaced
customresourcedefinition.apiextensions.k8s.io "airflowdbs.airflow.stackable.tech" replaced
customresourcedefinition.apiextensions.k8s.io "authenticationclasses.authentication.stackable.tech" replaced
customresourcedefinition.apiextensions.k8s.io "s3connections.s3.stackable.tech" replaced
...
----

Install the `24.11` release

[source,console]
----
helm repo add stackable-stable https://repo.stackable.tech/repository/helm-stable/
helm repo update stackable-stable
helm install --wait airflow-operator stackable-stable/airflow-operator --version 24.11.1
helm install --wait commons-operator stackable-stable/commons-operator --version 24.11.1
helm install --wait druid-operator stackable-stable/druid-operator --version 24.11.1
helm install --wait hbase-operator stackable-stable/hbase-operator --version 24.11.1
helm install --wait hdfs-operator stackable-stable/hdfs-operator --version 24.11.1
helm install --wait hive-operator stackable-stable/hive-operator --version 24.11.1
helm install --wait kafka-operator stackable-stable/kafka-operator --version 24.11.1
helm install --wait listener-operator stackable-stable/listener-operator --version 24.11.1
helm install --wait nifi-operator stackable-stable/nifi-operator --version 24.11.1
helm install --wait opa-operator stackable-stable/opa-operator --version 24.11.1
helm install --wait secret-operator stackable-stable/secret-operator --version 24.11.1
helm install --wait spark-k8s-operator stackable-stable/spark-k8s-operator --version 24.11.1
helm install --wait superset-operator stackable-stable/superset-operator --version 24.11.1
helm install --wait trino-operator stackable-stable/trino-operator --version 24.11.1
helm install --wait zookeeper-operator stackable-stable/zookeeper-operator --version 24.11.1
----

=== 24.11.0

Released on 2024-11-28.
Also consult the release notes for the 24.11.1 patch release above.
Also consult the release notes for the <<_24_11_1>> patch release above.

==== New platform features

Expand Down Expand Up @@ -301,7 +452,7 @@ Use "stackablectl operator installed" to list installed operators.

Use `helm list` to list the currently installed operators.

You can use the following command to uninstall all operators that are part of the `24.3` release:
You can use the following command to uninstall all operators that are part of the `24.7` release:

[source,console]
----
Expand Down
Loading