From 761912f8c065c4b55be80fff9109ee97747c44a4 Mon Sep 17 00:00:00 2001 From: Nick Larsen Date: Sat, 20 Jul 2024 11:21:51 +0200 Subject: [PATCH 1/4] chore(getting-started): add warning to generated script --- .../getting_started/getting_started.sh | 14 ++++++++++++++ .../getting_started/getting_started.sh.j2 | 18 ++++++++++++++++-- 2 files changed, 30 insertions(+), 2 deletions(-) diff --git a/docs/modules/kafka/examples/getting_started/getting_started.sh b/docs/modules/kafka/examples/getting_started/getting_started.sh index 09cc40a0..54019df7 100755 --- a/docs/modules/kafka/examples/getting_started/getting_started.sh +++ b/docs/modules/kafka/examples/getting_started/getting_started.sh @@ -1,6 +1,20 @@ #!/usr/bin/env bash set -euo pipefail +# DO NOT EDIT THE SCRIPT +# Instead, update the j2 template, and regenerate it for dev: +# cat < data echo "Writing test data" # tag::kcat-write-data[] -kafkacat -b localhost:9092 -t test-data-topic -P data +kcat -b localhost:9092 -t test-data-topic -P data # end::kcat-write-data[] echo "Reading test data" # tag::kcat-read-data[] -kafkacat -b localhost:9092 -t test-data-topic -C -e > read-data.out +kcat -b localhost:9092 -t test-data-topic -C -e > read-data.out # end::kcat-read-data[] echo "Check contents" From ca82f068000457a02a64dd1082a83df3d246c27a Mon Sep 17 00:00:00 2001 From: Nick Larsen Date: Sat, 20 Jul 2024 11:22:59 +0200 Subject: [PATCH 2/4] docs(getting-started): update stackablectl op install output --- .../getting_started/install-operator-output.txt | 10 +++++----- .../getting_started/install-operator-output.txt.j2 | 10 +++++----- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/modules/kafka/examples/getting_started/install-operator-output.txt b/docs/modules/kafka/examples/getting_started/install-operator-output.txt index 401e6468..020e2d4a 100644 --- a/docs/modules/kafka/examples/getting_started/install-operator-output.txt +++ b/docs/modules/kafka/examples/getting_started/install-operator-output.txt @@ -1,7 +1,7 @@ # tag::stackablectl-install-operators-output[] -[INFO ] Installing commons operator in version 0.0.0-dev -[INFO ] Installing secret operator in version 0.0.0-dev -[INFO ] Installing listener operator in version 0.0.0-dev -[INFO ] Installing zookeeper operator in version 0.0.0-dev -[INFO ] Installing kafka operator in version 0.0.0-dev +Installing commons=0.0.0-dev operator +Installing secret=0.0.0-dev operator +Installing listener=0.0.0-dev operator +Installing zookeeper=0.0.0-dev operator +Installing kafka=0.0.0-dev operator # end::stackablectl-install-operators-output[] diff --git a/docs/modules/kafka/examples/getting_started/install-operator-output.txt.j2 b/docs/modules/kafka/examples/getting_started/install-operator-output.txt.j2 index 131a9aa7..6d563e37 100644 --- a/docs/modules/kafka/examples/getting_started/install-operator-output.txt.j2 +++ b/docs/modules/kafka/examples/getting_started/install-operator-output.txt.j2 @@ -1,7 +1,7 @@ # tag::stackablectl-install-operators-output[] -[INFO ] Installing commons operator in version {{ versions.commons }} -[INFO ] Installing secret operator in version {{ versions.secret }} -[INFO ] Installing listener operator in version {{ versions.listener }} -[INFO ] Installing zookeeper operator in version {{ versions.zookeeper }} -[INFO ] Installing kafka operator in version {{ versions.kafka }} +Installing commons={{ versions.commons }} operator +Installing secret={{ versions.secret }} operator +Installing listener={{ versions.listener }} operator +Installing zookeeper={{ versions.zookeeper }} operator +Installing kafka={{ versions.kafka }} operator # end::stackablectl-install-operators-output[] From 31e43ed56967cbe7043740aa51b5a52df6a25e96 Mon Sep 17 00:00:00 2001 From: Nick Larsen Date: Sat, 20 Jul 2024 11:35:29 +0200 Subject: [PATCH 3/4] fix(getting-started): revert kafkacat -> kcat change --- .../modules/kafka/examples/getting_started/getting_started.sh | 4 ++-- .../kafka/examples/getting_started/getting_started.sh.j2 | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/modules/kafka/examples/getting_started/getting_started.sh b/docs/modules/kafka/examples/getting_started/getting_started.sh index 54019df7..ba242375 100755 --- a/docs/modules/kafka/examples/getting_started/getting_started.sh +++ b/docs/modules/kafka/examples/getting_started/getting_started.sh @@ -112,12 +112,12 @@ echo "some test data" > data echo "Writing test data" # tag::kcat-write-data[] -kcat -b localhost:9092 -t test-data-topic -P data +kafkacat -b localhost:9092 -t test-data-topic -P data # end::kcat-write-data[] echo "Reading test data" # tag::kcat-read-data[] -kcat -b localhost:9092 -t test-data-topic -C -e > read-data.out +kafkacat -b localhost:9092 -t test-data-topic -C -e > read-data.out # end::kcat-read-data[] echo "Check contents" diff --git a/docs/modules/kafka/examples/getting_started/getting_started.sh.j2 b/docs/modules/kafka/examples/getting_started/getting_started.sh.j2 index 7f27419e..50c2b0cf 100755 --- a/docs/modules/kafka/examples/getting_started/getting_started.sh.j2 +++ b/docs/modules/kafka/examples/getting_started/getting_started.sh.j2 @@ -112,12 +112,12 @@ echo "some test data" > data echo "Writing test data" # tag::kcat-write-data[] -kcat -b localhost:9092 -t test-data-topic -P data +kafkacat -b localhost:9092 -t test-data-topic -P data # end::kcat-write-data[] echo "Reading test data" # tag::kcat-read-data[] -kcat -b localhost:9092 -t test-data-topic -C -e > read-data.out +kafkacat -b localhost:9092 -t test-data-topic -C -e > read-data.out # end::kcat-read-data[] echo "Check contents" From d242b048fca6ca3776f3a909326adcd3c1e784ef Mon Sep 17 00:00:00 2001 From: Nick Larsen Date: Sat, 20 Jul 2024 12:03:31 +0200 Subject: [PATCH 4/4] chore(shellcheck): intentionally ignore warnings --- docs/modules/kafka/examples/getting_started/getting_started.sh | 2 ++ .../kafka/examples/getting_started/getting_started.sh.j2 | 2 ++ 2 files changed, 4 insertions(+) diff --git a/docs/modules/kafka/examples/getting_started/getting_started.sh b/docs/modules/kafka/examples/getting_started/getting_started.sh index ba242375..666dc86c 100755 --- a/docs/modules/kafka/examples/getting_started/getting_started.sh +++ b/docs/modules/kafka/examples/getting_started/getting_started.sh @@ -97,10 +97,12 @@ kubectl rollout status --watch --timeout=5m statefulset/simple-kafka-broker-defa # end::watch-kafka-rollout[] echo "Starting port-forwarding of port 9092" +# shellcheck disable=2069 # we want all output to be blackholed # tag::port-forwarding[] kubectl port-forward svc/simple-kafka 9092 2>&1 >/dev/null & # end::port-forwarding[] PORT_FORWARD_PID=$! +# shellcheck disable=2064 # we want the PID evaluated now, not at the time the trap is trap "kill $PORT_FORWARD_PID" EXIT sleep 15 diff --git a/docs/modules/kafka/examples/getting_started/getting_started.sh.j2 b/docs/modules/kafka/examples/getting_started/getting_started.sh.j2 index 50c2b0cf..9b5dd708 100755 --- a/docs/modules/kafka/examples/getting_started/getting_started.sh.j2 +++ b/docs/modules/kafka/examples/getting_started/getting_started.sh.j2 @@ -97,10 +97,12 @@ kubectl rollout status --watch --timeout=5m statefulset/simple-kafka-broker-defa # end::watch-kafka-rollout[] echo "Starting port-forwarding of port 9092" +# shellcheck disable=2069 # we want all output to be blackholed # tag::port-forwarding[] kubectl port-forward svc/simple-kafka 9092 2>&1 >/dev/null & # end::port-forwarding[] PORT_FORWARD_PID=$! +# shellcheck disable=2064 # we want the PID evaluated now, not at the time the trap is trap "kill $PORT_FORWARD_PID" EXIT sleep 15