Skip to content

release-template.adoc

Latest commit

 

History

History
298 lines (214 loc) · 10.7 KB

release-template.adoc

File metadata and controls

298 lines (214 loc) · 10.7 KB
Raw

Release YY.M

YY.M.X

Released on YYYY-MM-DD. (Optional description / introduction)

Release highlights

  • Highlight 1

  • Highlight 2

  • Highlight 3
Overview of breaking changes

The following components of the SDP contain breaking changes for this release:

  • Breaking change 1

  • Breaking change 2

New platform features

All subsections must follow this order:

  • Apache Airflow

  • Apache Druid

  • Apache HBase

  • Apache Hadoop

  • Apache Hive

  • Apache Kafka

  • Apache NiFi

  • Apache Omid

  • Apache Phoenix

  • Apache Spark

  • Apache Superset

  • Apache ZooKeeper

  • Open Policy Agent

  • OpenSearch

  • Trino

  • Vector

  • Stackable commons-operator

  • Stackable listener-operator

  • Stackable secret-operator

Potential sub headers…​

General
Security/Observability/Authorization/Miscellaneous
Apache Project and Stackable <CORE>-operator

Platform improvements

Mark any breaking changes with Breaking:.

General
Vulnerabilities

YYY CVEs were fixed in the Stackable product images. This includes X critical and XX high-severity CVEs.

Authorization/Miscellaneous
Apache Project and Stackable <CORE>-operator

Platform fixes

General
Security/Observability/Authorization/Miscellaneous
Apache Project and Stackable <CORE>-operator

Platform deprecations

Apache Project and Stackable <CORE>-operator

Platform removals

Mark any breaking changes with Breaking:.

General
Apache Project and Stackable <CORE>-operator

Supported versions

Product versions

As with previous SDP releases, many product images have been updated to their latest versions. Refer to the supported versions documentation for a complete overview including LTS versions or deprecations.

New LTS versions

The following product versions were already available before but are now marked as the LTS version:

New versions

The following new product versions are now supported:

Deprecated versions

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

Removed versions

The following product versions are no longer supported. These images for released product versions remain available here. Information on how to browse the registry can be found here.

Kubernetes versions

This release supports the following Kubernetes versions:

  • 1.33

  • 1.32

  • 1.31

  • 1.30

These Kubernetes versions are no longer supported:

  • 1.29

OpenShift versions

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

  • 4.18

  • 4.17

  • 4.16

These OpenShift versions are no longer supported:

  • 4.15

  • 4.14

Upgrade from OO.M

Using stackablectl
Upgrade with a single command

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.

$ stackablectl release upgrade YY.M
Upgrade with multiple consecutive commands

Uninstall the OO.M release

$ stackablectl release uninstall OO.M

Uninstalled release 'OO.M'

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.

kubectl replace -f https://raw.githubusercontent.com/stackabletech/airflow-operator/YY.M.X/extra/crds.yaml
kubectl replace -f https://raw.githubusercontent.com/stackabletech/commons-operator/YY.M.X/extra/crds.yaml
kubectl replace -f https://raw.githubusercontent.com/stackabletech/druid-operator/YY.M.X/extra/crds.yaml
kubectl replace -f https://raw.githubusercontent.com/stackabletech/hbase-operator/YY.M.X/extra/crds.yaml
kubectl replace -f https://raw.githubusercontent.com/stackabletech/hdfs-operator/YY.M.X/extra/crds.yaml
kubectl replace -f https://raw.githubusercontent.com/stackabletech/hive-operator/YY.M.X/extra/crds.yaml
kubectl replace -f https://raw.githubusercontent.com/stackabletech/kafka-operator/YY.M.X/extra/crds.yaml
kubectl replace -f https://raw.githubusercontent.com/stackabletech/listener-operator/YY.M.X/extra/crds.yaml
kubectl replace -f https://raw.githubusercontent.com/stackabletech/nifi-operator/YY.M.X/extra/crds.yaml
kubectl replace -f https://raw.githubusercontent.com/stackabletech/opa-operator/YY.M.X/extra/crds.yaml
kubectl replace -f https://raw.githubusercontent.com/stackabletech/spark-k8s-operator/YY.M.X/extra/crds.yaml
kubectl replace -f https://raw.githubusercontent.com/stackabletech/superset-operator/YY.M.X/extra/crds.yaml
kubectl replace -f https://raw.githubusercontent.com/stackabletech/trino-operator/YY.M.X/extra/crds.yaml
kubectl replace -f https://raw.githubusercontent.com/stackabletech/zookeeper-operator/YY.M.X/extra/crds.yaml
customresourcedefinition.apiextensions.k8s.io "airflowclusters.airflow.stackable.tech" replaced
customresourcedefinition.apiextensions.k8s.io "authenticationclasses.authentication.stackable.tech" replaced
customresourcedefinition.apiextensions.k8s.io "s3connections.s3.stackable.tech" replaced
...

Install the YY.M release

$ stackablectl release install YY.M

Installed release 'YY.M'

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 OO.M release:

$ 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.

kubectl replace -f https://raw.githubusercontent.com/stackabletech/airflow-operator/YY.M.X/extra/crds.yaml
kubectl replace -f https://raw.githubusercontent.com/stackabletech/commons-operator/YY.M.X/extra/crds.yaml
kubectl replace -f https://raw.githubusercontent.com/stackabletech/druid-operator/YY.M.X/extra/crds.yaml
kubectl replace -f https://raw.githubusercontent.com/stackabletech/hbase-operator/YY.M.X/extra/crds.yaml
kubectl replace -f https://raw.githubusercontent.com/stackabletech/hdfs-operator/YY.M.X/extra/crds.yaml
kubectl replace -f https://raw.githubusercontent.com/stackabletech/hive-operator/YY.M.X/extra/crds.yaml
kubectl replace -f https://raw.githubusercontent.com/stackabletech/kafka-operator/YY.M.X/extra/crds.yaml
kubectl replace -f https://raw.githubusercontent.com/stackabletech/listener-operator/YY.M.X/extra/crds.yaml
kubectl replace -f https://raw.githubusercontent.com/stackabletech/nifi-operator/YY.M.X/extra/crds.yaml
kubectl replace -f https://raw.githubusercontent.com/stackabletech/opa-operator/YY.M.X/extra/crds.yaml
kubectl replace -f https://raw.githubusercontent.com/stackabletech/spark-k8s-operator/YY.M.X/extra/crds.yaml
kubectl replace -f https://raw.githubusercontent.com/stackabletech/superset-operator/YY.M.X/extra/crds.yaml
kubectl replace -f https://raw.githubusercontent.com/stackabletech/trino-operator/YY.M.X/extra/crds.yaml
kubectl replace -f https://raw.githubusercontent.com/stackabletech/zookeeper-operator/YY.M.X/extra/crds.yaml
customresourcedefinition.apiextensions.k8s.io "airflowclusters.airflow.stackable.tech" replaced
customresourcedefinition.apiextensions.k8s.io "authenticationclasses.authentication.stackable.tech" replaced
customresourcedefinition.apiextensions.k8s.io "s3connections.s3.stackable.tech" replaced
...

Install the YY.M release

Note
 helm repo subcommands are not supported for OCI registries. The operators are installed directly, without adding the Helm Chart repository first. 
helm install --wait airflow-operator oci://oci.stackable.tech/sdp-charts/airflow-operator --version YY.M.X
helm install --wait commons-operator oci://oci.stackable.tech/sdp-charts/commons-operator --version YY.M.X
helm install --wait druid-operator oci://oci.stackable.tech/sdp-charts/druid-operator --version YY.M.X
helm install --wait hbase-operator oci://oci.stackable.tech/sdp-charts/hbase-operator --version YY.M.X
helm install --wait hdfs-operator oci://oci.stackable.tech/sdp-charts/hdfs-operator --version YY.M.X
helm install --wait hive-operator oci://oci.stackable.tech/sdp-charts/hive-operator --version YY.M.X
helm install --wait kafka-operator oci://oci.stackable.tech/sdp-charts/kafka-operator --version YY.M.X
helm install --wait listener-operator oci://oci.stackable.tech/sdp-charts/listener-operator --version YY.M.X
helm install --wait nifi-operator oci://oci.stackable.tech/sdp-charts/nifi-operator --version YY.M.X
helm install --wait opa-operator oci://oci.stackable.tech/sdp-charts/opa-operator --version YY.M.X
helm install --wait secret-operator oci://oci.stackable.tech/sdp-charts/secret-operator --version YY.M.X
helm install --wait spark-k8s-operator oci://oci.stackable.tech/sdp-charts/spark-k8s-operator --version YY.M.X
helm install --wait superset-operator oci://oci.stackable.tech/sdp-charts/superset-operator --version YY.M.X
helm install --wait trino-operator oci://oci.stackable.tech/sdp-charts/trino-operator --version YY.M.X
helm install --wait zookeeper-operator oci://oci.stackable.tech/sdp-charts/zookeeper-operator --version YY.M.X

Known issues

Note down any potential known issues.