Merge branch 'main' into feat/note-about-source-code

Author: dervoeti

.github/workflows/build.yml

@@ -21,4 +21,4 @@ jobs:
           node-version: '20'
           cache: 'npm'
       - run: npm ci
-      - run: make ANTORAFLAGS=--fetch
+      - run: make ANTORAFLAGS=--fetch build-local

Makefile

@@ -1,5 +1,10 @@
 CURRENT_COMMIT := $(shell git rev-parse HEAD)
 
+# Build from local worktrees. Only one version is built: "latest".
+# Assumes all repos have the same parent directory.
+build-truly-local: build-ui
+	node_modules/.bin/antora generate truly-local-playbook.yml
+
 build-local: build-ui
 	node_modules/.bin/antora generate local-antora-playbook.yml
 

modules/ROOT/pages/getting-started.adoc

@@ -125,7 +125,7 @@ metadata:
   name: simple-kafka
 spec:
   image:
-    productVersion: 3.9.0
+    productVersion: 3.9.1
   clusterConfig:
     zookeeperConfigMapName: simple-kafka-znode
     tls:

modules/ROOT/partials/release-notes/release-25.3.adoc

@@ -112,6 +112,10 @@ See https://github.com/stackabletech/hive-operator/pull/578[hive-operator#578].
   See https://github.com/stackabletech/secret-operator/pull/566[secret-operator#566].
 * In 24.11 we used a custom build of jmx_exporter to resolve a https://github.com/stackabletech/issues/issues/649[performance degradation].
   In this release, Java products ship with the fixed upstream https://github.com/prometheus/jmx_exporter/releases/tag/1.1.0[jmx_exporter 1.1.0] which includes https://github.com/prometheus/jmx_exporter/pull/1009[the fix].
+* In 24.11, HDFS metrics suffixed with `+_total+`, `+_created+`, and `+_info+` were not exported by the jmx_exporter.
+  With this release, metrics suffixed with `+_total+`, e.g. `+hadoop_namenode_files_total+`, are emitted again.
+  Metrics originally suffixed with `+_created+` and `+_info+` are now suffixed with `+_created_+` and `+_info_+` to be OpenMetrics compliant.
+  See https://github.com/stackabletech/hdfs-operator/issues/634[hdfs-operator#634].
 
 ==== Platform deprecations
 

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

@@ -81,6 +81,17 @@ Of the changes mentioned above, the following are breaking (or could lead to bre
 
 ===== 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.
+
+[source,console]
+----
+$ stackablectl release upgrade YY.M
+----
+
+====== Upgrade with multiple consecutive commands
+
 Uninstall the `OO.M` release
 
 [source,console]

modules/concepts/pages/product-image-selection.adoc

@@ -30,7 +30,7 @@ These images contain various tools for initialization jobs and/or the actual pro
 Stackable uses two separate versions to describe the images provided as part of the platform:
 
 **Product version** +
-This is the version of the product that the image provides, such as Kafka 3.9.0.
+This is the version of the product that the image provides, such as Kafka 3.9.1
 
 TIP: You can find all products and their supported versions in the xref:operators:supported_versions.adoc[supported versions overview].
 You can also find the supported versions per product on each operator page, for example, for xref:kafka:index.adoc#_supported_versions[Apache Kafka].
@@ -71,7 +71,7 @@ TIP: All our images are also mirrored to our https://quay.io/organization/stacka
 ----
 spec:
   image:
-    productVersion: 3.9.0 <.>
+    productVersion: 3.9.1 <.>
     # stackableVersion: 25.7.0 # optional <.>
 ----
 <.> The version of your product.

modules/contributor/pages/code-style-guide.adoc

@@ -531,6 +531,45 @@ enum Error {
 . `unable to read config file from ...` to indicate that the file could not be loaded (for example because the file doesn't exist).
 . `unable to parse value ...` to indicate that parsing a user provided value failed (for example because it didn't conform to the expected syntax).
 
+=== Using `unwrap`
+
+:unwrap_or: https://doc.rust-lang.org/std/result/enum.Result.html#method.unwrap_or
+:unwrap_or_default: https://doc.rust-lang.org/std/result/enum.Result.html#method.unwrap_or_default
+:unwrap_or_else: https://doc.rust-lang.org/std/result/enum.Result.html#method.unwrap_or_else
+
+The `unwrap` function must not be used in any code.
+Instead, proper error handling like above should be used, unless there is a valid reason to use `expect` described below.
+Using link:{unwrap_or}[`unwrap_or`], link:{unwrap_or_default}[`unwrap_or_default`] or link:{unwrap_or_else}[`unwrap_or_else`] is allowed because these functions will not panic.
+
+The `expect` function can be used when external factors cannot influence whether a panic will happen. For example, when compiling regular expressions inside const/static environments.
+For such cases code must use `expect` instead of `unwrap` to provide additional context for why a particular piece of code should never fail.
+
+// Do we want to mention that this is enforced via clippy and that we actually enable that lint in our repos?
+
+[TIP.code-rule,caption=Examples of correct code for this rule]
+====
+
+[source,rust]
+----
+static VERSION_REGEX: LazyLock<Regex> = LazyLock::new(|| {
+    Regex::new(r".*").expect("valid regular expression")
+});
+----
+
+====
+
+[WARNING.code-rule,caption=Examples of incorrect code for this rule]
+====
+
+[source,rust]
+----
+static VERSION_REGEX: LazyLock<Regex> = LazyLock::new(|| {
+    Regex::new(r".*").unwrap()
+});
+----
+
+====
+
 == String formatting
 
 === Named versus unnamed format string identifiers
@@ -737,3 +776,35 @@ mod test {
 ----
 
 ====
+
+=== Using `unwrap`
+
+The usage of `unwrap` in unit tests is also not allowed for the same reasons as mentioned above.
+
+[TIP.code-rule,caption=Examples of correct code for this rule]
+====
+
+[source,rust]
+----
+#[test]
+fn deserialize() {
+    let input: String = serde_yaml::from_str("my string").expect("constant input string must deserialize");
+    assert_eq(&input, "my string");
+}
+----
+
+====
+
+[WARNING.code-rule,caption=Examples of incorrect code for this rule]
+====
+
+[source,rust]
+----
+#[test]
+fn serialize() {
+    let serialized = serde_yaml::to_string(&String::from("my string")).unwrap();
+    println!("{serialized}");
+}
+----
+
+====

modules/contributor/pages/testing-on-kubernetes.adoc

@@ -20,6 +20,7 @@ To shorten these, we have settled on a tool called https://github.com/kolloch/cr
 This tool uses the https://nixos.org/[Nix package manager] to cache intermediate build steps and only recompile what has actually changed, thus significantly shortening build times.
 
 == Installation
+
 Due to the nature of how Nix works, all the setup steps are defined in the operator repositories and automatically applied when you start using this workflow.
 
 The only prerequisite you need to install is the actual Nix package manager - you can find installation instructions and additional documentation on the https://nixos.org/download.html[Nix website].
@@ -47,6 +48,12 @@ Please adjust the number of `cores` to your system and set the `max-jobs` to e.g
 
 Just installing Nix does not affect your system much, as it keeps all its configuration and installed packages separate from other package managers and you won't even notice it is there, unless you actually start using it.
 
+=== macOS
+
+The Docker images need to be built on a Linux host. Nix can automatically delegate the build to a remote worker, but it must be configured to do so.
+
+https://github.com/stackabletech/nix-docker-builder can set this up for you.
+
 == Using
 
 The build and deploy steps for installing and running the operator are defined in the `Tiltfile` in the operators repository.

modules/tutorials/examples/ldap-auth/80-verify-trino.sh

@@ -2,7 +2,7 @@
 set -euo pipefail
 
 
-trino_version="403"
+trino_version="476"
 trino_download_url="https://repo.stackable.tech/repository/packages/trino-cli/trino-cli-${trino_version}-executable.jar"
 
 trino_login() {

modules/tutorials/examples/logging-aggregator/main.sh

@@ -5,6 +5,11 @@ echo "Installing ZooKeeper Operator"
 stackablectl release install -i secret -i commons -i listener -i zookeeper 23.11
 # end::zk-op[]
 
+# tag::vector-helm-repo[]
+helm repo add vector https://helm.vector.dev
+helm repo update
+# end::vector-helm-repo[]
+
 # tag::vector-agg[]
 helm install \
   --wait \
@@ -35,4 +40,4 @@ then
   echo "it worked"
 else
   echo "it didn't work"
-fi
+fi