Skip to content

Commit 2a43d4a

Browse files
NickLarsenNZNickLarsenNZ
committed
restructure the headings, remove unordered lists with only single items
1 parent 08aa45a commit 2a43d4a

File tree

1 file changed

+59
-44
lines changed

1 file changed

+59
-44
lines changed

‎modules/ROOT/pages/release-notes.adoc‎

Lines changed: 59 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,11 @@ Here are the headings you can use for the next release. Saves time checking inde
1010

1111
== Release YY.M
1212

13-
=== New / extended platform features
13+
=== New platform features
14+
15+
=== Platform improvements
16+
17+
=== Platform deprecations
1418

1519
=== Product versions
1620

@@ -36,72 +40,41 @@ Here are the headings you can use for the next release. Saves time checking inde
3640

3741
==== Known upgrade issues
3842

39-
===== All operators
40-
4143
////
4244
4345
== Release 24.11
4446
45-
=== New / extended platform features
46-
47-
Vulnerabilities::
48-
49-
* More than 142 CVEs were fixed in the Stackable product images.
50-
This includes 11 critical and 55 high-severity CVEs.
47+
=== New platform features
5148
52-
Improved Authentication::
49+
Authentication::
5350
5451
In this release we introduced several authentication mechanisms in different products:
5552
5653
* Apache Airflow: https://github.com/stackabletech/airflow-operator/issues/337[OIDC support]
5754
* Apache Kafka: https://github.com/stackabletech/kafka-operator/issues/655[Kerberos support]
5855
* Apache NiFi: https://github.com/stackabletech/nifi-operator/issues/633[OIDC support]
5956
60-
Improved Authorization::
61-
62-
* The performance of the https://docs.stackable.tech/home/stable/hdfs/usage-guide/security.html#\_authorization[OPA Authorizer] has been greatly improved.
63-
This _can_ be a breaking change so please make sure to read the hdfs-utils https://github.com/stackabletech/hdfs-utils/releases/tag/v0.4.0[release notes] for details.
64-
* The User Info Fetcher HTTP API has been replaced with a Rego library. Please see https://docs.stackable.tech/home/nightly/opa/usage-guide/user-info-fetcher#_user_info_fetcher_api[user-info-fetcher API] for more information.
65-
66-
Logging::
67-
68-
* Apache NiFi: The ephemeral EmptyDir Volumes used to store log files before being aggregated have their size increased from a default of 33 MiB to 500 MiB.
69-
Additionally the interval in which Logback checks if the maximum log file size has been reached was lowered from 60 seconds to 5 seconds.
70-
71-
Monitoring::
72-
73-
* https://github.com/prometheus/jmx_exporter[JMX Exporter] is a tool which allows us to expose JMX metrics as Prometheus metrics.
74-
It is used by the following products: Hadoop, HBase, Hive, Kafka, Spark, Trino and ZooKeeper.
75-
In the previous SDP release (24.7) we upgraded JMX Exporter from 0.20 to 1.0.1.
76-
Unfortunately version 1.0.1 has a severe performance degradation which has been https://github.com/prometheus/jmx_exporter/pull/1009[fixed upstream] but is not yet released.
77-
This SDP release (24.11) contains a fixed version bringing performance back to normal levels.
78-
7957
Security::
8058
8159
* The Stackable Data Platform now supports provisioning TLS certificates using https://cert-manager.io/[cert-manager].
8260
* Added support for customizing `sAMAccountName` generation in secret operator.
8361
* The Stackable Secret Operator now requests permission to read Listeners, which is required to provision secrets for listener volumes with the `listeners.stackable.tech/listener-name` annotation.
8462
85-
Commons::
86-
87-
* Pod Enrichment is now deprecated, and will be removed in the next release. Once removed, the SDP will no longer set any `enrichment.stackable.tech/` annotations on Pods.
88-
8963
Listener::
9064
9165
* The Stackable Operator for Kafka now uses the Stackable Listener Operator, allowing connectivity to be customized.
92-
* The `ListenerClass.spec.serviceAnnotations` are now correctly propagated to created Service objects.
9366
* Listeners can now be configured to use either IP addresses or fully qualified domain names (FQDNs).
9467
9568
Dependencies::
9669
97-
* Apache HBase: The hadoop-azure module was added to the image and is contained in the classpath.
98-
This makes it possible to use the Azure Data Lake Storage Gen2 (ADLS) instead of HDFS.
99-
See the xref:hbase:usage-guide/adls.adoc[usage guide] for detailed information.
70+
Apache HBase: The hadoop-azure module was added to the image and is contained in the classpath.
71+
This makes it possible to use the Azure Data Lake Storage Gen2 (ADLS) instead of HDFS.
72+
See the xref:hbase:usage-guide/adls.adoc[usage guide] for detailed information.
10073
10174
Operations::
10275
103-
* The Stackable Operator for HDFS now supports upgrading existing HDFS installations.
104-
However, this process requires some manual intervention as described https://docs.stackable.tech/home/nightly/hdfs/usage-guide/upgrading/[here].
76+
The Stackable Operator for HDFS now supports upgrading existing HDFS installations.
77+
However, this process requires some manual intervention as described https://docs.stackable.tech/home/nightly/hdfs/usage-guide/upgrading/[here].
10578
10679
Misc::
10780
@@ -110,15 +83,50 @@ Misc::
11083
See documentation xref:nifi:usage_guide/security#host-header-check[here].
11184
* Apache Airflow: Allow custom arbitrary python code in `webserver_config.py`.
11285
* Apache Superset: Allow custom arbitrary python code in `superset_config.py`.
113-
* The size of the operator deployed CRDs was reduced significantly https://github.com/stackabletech/issues/issues/627[here].
11486
11587
Images::
11688
89+
Support the `restricted-v2` SecurityContextConstraint (SCC) in OpenShift.
90+
Stackable currently defaults to the `nonroot-v2` SCC but we plan on migrating to the `restricted-v2` SCC in the future.
91+
11792
* Our Docker images now exclusively make use of numeric user IDs in `USER` statements allowing the use of `securityContext.runAsNonRoot`
11893
* The group id of all files relevant to our products is now set to `0`.
11994
This allows the images to be run with an arbitrary user as every container user will always belong to the root group (`0`).
120-
This is required on OpenShift when migrating to the `restricted-v2` SecurityContextConstraint (SCC).
121-
Stackable currently defaults to the `nonroot-v2` SCC but we plan on migrating to the `restricted-v2` SCC in the future.
95+
This is required on OpenShift when migrating to the `restricted-v2` SCC.
96+
97+
=== Platform improvements
98+
99+
Vulnerabilities::
100+
101+
More than 142 CVEs were fixed in the Stackable product images.
102+
This includes 11 critical and 55 high-severity CVEs.
103+
104+
Authorization::
105+
106+
* The performance of the https://docs.stackable.tech/home/stable/hdfs/usage-guide/security.html#\_authorization[OPA Authorizer] has been greatly improved.
107+
This _can_ be a breaking change so please make sure to read the hdfs-utils https://github.com/stackabletech/hdfs-utils/releases/tag/v0.4.0[release notes] for details.
108+
* The User Info Fetcher HTTP API has been replaced with a Rego library. Please see https://docs.stackable.tech/home/nightly/opa/usage-guide/user-info-fetcher#_user_info_fetcher_api[user-info-fetcher API] for more information.
109+
110+
Logging::
111+
112+
Apache NiFi: The ephemeral EmptyDir Volumes used to store log files before being aggregated have their size increased from a default of 33 MiB to 500 MiB.
113+
Additionally the interval in which Logback checks if the maximum log file size has been reached was lowered from 60 seconds to 5 seconds.
114+
115+
Monitoring::
116+
117+
https://github.com/prometheus/jmx_exporter[JMX Exporter] is a tool which allows us to expose JMX metrics as Prometheus metrics.
118+
It is used by the following products: Hadoop, HBase, Hive, Kafka, Spark, Trino and ZooKeeper.
119+
In the previous SDP release (24.7) we upgraded JMX Exporter from 0.20 to 1.0.1.
120+
Unfortunately version 1.0.1 has a severe performance degradation which has been https://github.com/prometheus/jmx_exporter/pull/1009[fixed upstream] but is not yet released.
121+
This SDP release (24.11) contains a fixed version bringing performance back to normal levels.
122+
123+
Listener::
124+
125+
The `ListenerClass.spec.serviceAnnotations` are now correctly propagated to created Service objects.
126+
127+
Misc::
128+
129+
The size of the operator deployed CRDs was reduced significantly (see: https://github.com/stackabletech/issues/issues/627[stackabletech/issues#627]).
122130
123131
Bug fixes::
124132
@@ -134,6 +142,13 @@ Bug fixes::
134142
* Apache HBase: The operator now does not https://github.com/stackabletech/hbase-operator/pull/584[ignore the `hbaseRootdir` config property at role level].
135143
* Apache Kakfa: The bootstrap Kafka service is now included in https://github.com/stackabletech/kafka-operator/pull/741[certificate SANs].
136144
145+
=== Platform deprecations
146+
147+
Commons::
148+
149+
Pod Enrichment is now deprecated, and will be removed in the next release.
150+
Once removed, the SDP will no longer set any `enrichment.stackable.tech/` annotations on Pods.
151+
137152
=== Product versions
138153
139154
As with previous SDP releases, many product images have been updated to their latest versions.
@@ -211,8 +226,8 @@ These OpenShift versions are no longer supported:
211226
212227
==== Listener operator
213228
214-
* BREAKING: All ListenerClasses now default to using DNS hostnames, previously NodePort ListenerClasses (such as external-unstable) would use IP addresses.
215-
Hence, all Nodes must now have resolvable hostnames, or the NodePort ListenerClasses must be configured to set `.spec.preferredAddressType: IP`.
229+
BREAKING: All ListenerClasses now default to using DNS hostnames, previously NodePort ListenerClasses (such as external-unstable) would use IP addresses.
230+
Hence, all Nodes must now have resolvable hostnames, or the NodePort ListenerClasses must be configured to set `.spec.preferredAddressType: IP`.
216231
217232
=== Upgrade from 24.7
218233

0 commit comments

Comments
 (0)