chore(tracking): Release Notes for SDP 25.7.0

.github/PULL_REQUEST_TEMPLATE/release-notes.md

@@ -16,10 +16,10 @@
 
 [template]: https://github.com/stackabletech/documentation/blob/8dc93f28ac6d20a587f54d0a697c71fe47e8643a/modules/ROOT/pages/release-notes.adoc?plain=1#L11-L56
 
-```[tasklist]
-#### Release note compilation tasks
-- [ ] Check [Issues](https://github.com/search?q=org%3Astackabletech+label%3Arelease-note%2Crelease-note%2Faction-required+label%3Arelease%YY.M.X%2Cscheduled-for%YY.M.X&type=issues) for Product and Platform release notes
-- [ ] Check [PRs](https://github.com/search?q=org%3Astackabletech+label%3Arelease-note%2Crelease-note%2Faction-required+label%3Arelease%YY.M.X%2Cscheduled-for%YY.M.X&type=pullrequests) for Product and Platform release notes
+## Release note compilation tasks
+
+- [ ] Check [Issues](https://github.com/search?q=org%3Astackabletech+label%3Arelease-note%2Crelease-note%2Faction-required+label%3Arelease%2FYY.M.X%2Cscheduled-for%2FYY.M.X&type=issues) for Product and Platform release notes
+- [ ] Check [PRs](https://github.com/search?q=org%3Astackabletech+label%3Arelease-note%2Crelease-note%2Faction-required+label%3Arelease%2FYY.M.X%2Cscheduled-for%2FYY.M.X&type=pullrequests) for Product and Platform release notes
 - [ ] Optionally check the [Changelogs](https://github.com/search?q=org%3Astackabletech+path%3A*CHANGELOG.md+%22YY.M.X%22&type=code) in case release notes were missed
 - [ ] Compile list of new product versions that are supported and compile a list of new product features to include in the Release Highlights
 - [ ] Upgrade guide: Document how to use stackablectl to uninstall all and install new release
@@ -28,15 +28,13 @@
 - [ ] Upgrade guide: List removed product versions (if there are any)
 - [ ] Upgrade guide: List removed operators (if there are any)
 - [ ] Upgrade guide: List supported Kubernetes versions
-```
 
 Each of the following tasks focuses on a specific goal and should be done once the items above have been completed.
 
-```[tasklist]
-#### Release note review tasks
+## Release note review tasks
+
 - [ ] Check overall document structure
 - [ ] Check spelling, grammar, and correct wording
 - [ ] Check that internal links are xrefs
 - [ ] Check that rendered links are valid
 - [ ] Check that each sentence begins on a new line
-```

modules/ROOT/pages/getting-started.adoc

@@ -2,7 +2,8 @@
 :page-aliases: getting_started.adoc
 :description: Learn how to set up and test a Stackable Data Platform with Apache ZooKeeper, Kafka, and NiFi using Kubernetes. Ideal for lab environments.
 
-One of the best ways of getting started with a new platform is to try it out. Any big data platform has a lot of moving parts and getting some hands on keyboard time with it helps reinforce learning.
+One of the best ways of getting started with a new platform is to try it out.
+Any big data platform has a lot of moving parts and getting some hands on keyboard time with it helps reinforce learning.
 
 == About this guide
 
@@ -13,7 +14,8 @@ Firstly, let's cover whether this *Getting Started* guide is right for you. This
 
 == Overview
 
-Stackable is based on Kubernetes and uses this as the control plane to manage clusters. In this guide we will build a simple cluster with 3 services; Apache ZooKeeper, Apache Kafka and Apache NiFi.
+Stackable is based on Kubernetes and uses this as the control plane to manage clusters.
+In this guide we will build a simple cluster with 3 services; Apache ZooKeeper, Apache Kafka and Apache NiFi.
 
 == Installing Kubernetes and kubectl
 
@@ -30,32 +32,36 @@ Install the Stackable command line utility xref:management:stackablectl:index.ad
 
 === Installing Stackable Operators
 
-The Stackable operators are components that translate the service definitions deployed via Kubernetes into deploy services on the worker nodes. These can be installed on any node that has access to the Kubernetes control plane. In this example we will install them on the controller node.
+The Stackable operators are components that translate the service definitions deployed via Kubernetes into deploy services on the worker nodes.
+These can be installed on any node that has access to the Kubernetes control plane.
+In this example we will install them on the controller node.
 
-Stackable operators can be installed using `stackablectl`. Run the following commands to install ZooKeeper, Kafka and NiFi from the Stackable 25.3 release.
+Stackable operators can be installed using `stackablectl`.
+Run the following commands to install ZooKeeper, Kafka and NiFi from the Stackable 25.7 release.
 
 [source,bash]
 ----
-stackablectl release install -i commons -i secret -i listener -i zookeeper -i kafka -i nifi 25.3
+stackablectl release install -i commons -i secret -i listener -i zookeeper -i kafka -i nifi 25.7
 ----
 
 .Using Helm instead
 [%collapsible]
 ====
 NOTE: These examples assume Helm version 3. They will not work with Helm version 2.
 
-`helm repo` subcommands are not supported for OCI registries. The operators are installed directly, without adding the Helm Chart repository first.
+`helm repo` subcommands are not supported for OCI registries.
+The operators are installed directly, without adding the Helm Chart repository first.
 
 Install the operators:
 
 [source,bash]
 ----
-helm install zookeeper-operator oci://oci.stackable.tech/sdp-charts/zookeeper-operator --version=25.3.0
-helm install kafka-operator oci://oci.stackable.tech/sdp-charts/kafka-operator --version=25.3.0
-helm install secret-operator oci://oci.stackable.tech/sdp-charts/secret-operator --version=25.3.0
-helm install listener-operator oci://oci.stackable.tech/sdp-charts/listener-operator --version=25.3.0
-helm install commons-operator oci://oci.stackable.tech/sdp-charts/commons-operator --version=25.3.0
-helm install nifi-operator oci://oci.stackable.tech/sdp-charts/nifi-operator --version=25.3.0
+helm install zookeeper-operator oci://oci.stackable.tech/sdp-charts/zookeeper-operator --version=25.7.0
+helm install kafka-operator oci://oci.stackable.tech/sdp-charts/kafka-operator --version=25.7.0
+helm install secret-operator oci://oci.stackable.tech/sdp-charts/secret-operator --version=25.7.0
+helm install listener-operator oci://oci.stackable.tech/sdp-charts/listener-operator --version=25.7.0
+helm install commons-operator oci://oci.stackable.tech/sdp-charts/commons-operator --version=25.7.0
+helm install nifi-operator oci://oci.stackable.tech/sdp-charts/nifi-operator --version=25.7.0
 ----
 ====
 
@@ -64,17 +70,18 @@ You can check which operators are installed using `stackablectl operator install
 [source,console]
 ----
 OPERATOR              VERSION         NAMESPACE                      STATUS           LAST UPDATED
-commons               25.3.0         default                        deployed         2024-11-30 17:58:32.916032854 +0100 CET
-kafka                 25.3.0         default                        deployed         2024-11-30 17:58:55.036115353 +0100 CET
-listener              25.3.0         default                        deployed         2024-11-30 17:59:18.136775259 +0100 CET
-nifi                  25.3.0         default                        deployed         2024-11-30 17:59:51.927081648 +0100 CET
-secret                25.3.0         default                        deployed         2024-11-30 18:00:05.060241771 +0100 CET
-zookeeper             25.3.0         default                        deployed         2024-11-30 18:00:08.425686918 +0100 CET
+commons               25.7.0         default                        deployed         2024-11-30 17:58:32.916032854 +0100 CET
+kafka                 25.7.0         default                        deployed         2024-11-30 17:58:55.036115353 +0100 CET
+listener              25.7.0         default                        deployed         2024-11-30 17:59:18.136775259 +0100 CET
+nifi                  25.7.0         default                        deployed         2024-11-30 17:59:51.927081648 +0100 CET
+secret                25.7.0         default                        deployed         2024-11-30 18:00:05.060241771 +0100 CET
+zookeeper             25.7.0         default                        deployed         2024-11-30 18:00:08.425686918 +0100 CET
 ----
 
 == Deploying Stackable Services
 
-At this point you've successfully deployed Kubernetes and the Stackable operators we need and are ready to deploy services to the cluster. To do this we provide service descriptions to Kubernetes for each of the services we wish to deploy.
+At this point you've successfully deployed Kubernetes and the Stackable operators we need and are ready to deploy services to the cluster.
+To do this we provide service descriptions to Kubernetes for each of the services we wish to deploy.
 
 === Apache ZooKeeper
 
@@ -113,7 +120,8 @@ EOF
 
 === Apache Kafka
 
-We will deploy an Apache Kafka broker that depends on the ZooKeeper service we just deployed. The zookeeperReference property below points to the namespace and name we gave to the ZooKeeper service deployed previously.
+We will deploy an Apache Kafka broker that depends on the ZooKeeper service we just deployed.
+The zookeeperReference property below points to the namespace and name we gave to the ZooKeeper service deployed previously.
 
 [source,bash]
 ----
@@ -207,7 +215,8 @@ stringData:
 EOF
 ----
 
-You can check the status of the services using `kubectl get pods`. This will retrieve the status of all pods running in the default namespace.
+You can check the status of the services using `kubectl get pods`.
+This will retrieve the status of all pods running in the default namespace.
 
 ----
 NAME                                                       READY   STATUS    RESTARTS   AGE
@@ -227,22 +236,25 @@ simple-zk-server-primary-0                                 1/1     Running   0
 zookeeper-operator-deployment-7bcdcbb558-xc77h             1/1     Running   0          13m
 ----
 
-Since this is the first time that each of these services has been deployed to these nodes, it will take some time to download the software from the Stackable repository and deploy the services. Once all the pods are in the running state your cluster is ready to use.
+Since this is the first time that each of these services has been deployed to these nodes, it will take some time to download the software from the Stackable repository and deploy the services.
+Once all the pods are in the running state your cluster is ready to use.
 
 == Testing your cluster
 
 If all has gone well then you will have successfully deployed a Stackable cluster and used it to start three services that should now be ready for you.
 
 === Apache ZooKeeper
 
-We can test ZooKeeper by running the ZooKeeper CLI shell. The easiest way to do this is to run the CLI shell on the pod that is running ZooKeeper.
+We can test ZooKeeper by running the ZooKeeper CLI shell.
+The easiest way to do this is to run the CLI shell on the pod that is running ZooKeeper.
 
 [source,bash]
 ----
 kubectl exec -i -t simple-zk-server-primary-0 -- bin/zkCli.sh
 ----
 
-The shell should connect automatically to the ZooKeeper server running on the pod. You can run the `ls /` command to see the list of znodes in the root path, which should include those created by Apache Kafka and Apache NiFi.
+The shell should connect automatically to the ZooKeeper server running on the pod.
+You can run the `ls /` command to see the list of znodes in the root path, which should include those created by Apache Kafka and Apache NiFi.
 
 ----
 [zk: localhost:2181(CONNECTED) 0] ls /
@@ -260,7 +272,8 @@ kubectl exec -i -t simple-kafka-broker-brokers-0 -c kafka -- \
   bin/kafka-topics.sh --bootstrap-server localhost:9092 --create --topic demo
 ----
 
-You should see the message, "Created topic demo." on the console. Now let's check to see if it was actually created:
+You should see the message, "Created topic demo." on the console.
+Now let's check to see if it was actually created:
 
 [source,bash]
 ----
@@ -298,7 +311,8 @@ Browse to the address of your Kubernetes node on port `31931` e.g. https://172.1
 
 image:nifi_login_screen.png[The Apache NiFi web interface login screen]
 
-If a password has not been specified for the admin user the Apache NiFi operator will automatically generate the admin user credentials with a random password and store it as a Kubernetes secret in order to provide some security out of the box. In the example above we have provided our own secret, but you can retrieve and confirm this password for the `admin` user with the following kubectl command.
+If a password has not been specified for the admin user the Apache NiFi operator will automatically generate the admin user credentials with a random password and store it as a Kubernetes secret in order to provide some security out of the box.
+In the example above we have provided our own secret, but you can retrieve and confirm this password for the `admin` user with the following kubectl command.
 
 [source,bash]
 ----

modules/ROOT/pages/release-notes.adoc

@@ -7,6 +7,8 @@ The Stackable Data Platform consists of multiple operators that work together.
 Periodically a platform release is made, including all components of the platform at a specific version.
 
 // WARNING: Please keep the empty newlines, otherwise headings are broken.
+include::partial$release-notes/release-25.7.adoc[]
+
 include::partial$release-notes/release-25.3.adoc[]
 
 include::partial$release-notes/release-24.11.adoc[]