chore(getting-started): add warning to generated script

stackabletech · Jul 20, 2024 · a31a2f9 · a31a2f9
1 parent be555e0
commit a31a2f9
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 2 deletions.
diff --git a/docs/modules/nifi/examples/getting_started/getting_started.sh b/docs/modules/nifi/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 <<EOF | jinja2 --format yaml getting_started.sh.j2 -o getting_started.sh
+# helm:
+#   repo_name: stackable-dev
+#   repo_url: https://repo.stackable.tech/repository/helm-dev/
+# versions:
+#   commons: 0.0.0-dev
+#   listener: 0.0.0-dev
+#   nifi: 0.0.0-dev
+#   secret: 0.0.0-dev
+#   zookeeper: 0.0.0-dev
+# EOF
+
 # The getting started guide script
 # It uses tagged regions which are included in the documentation
 # https://docs.asciidoctor.org/asciidoc/latest/directives/include-tagged-regions/
@@ -85,7 +99,7 @@ spec:
   servers:
     roleGroups:
       default:
-        replicas: 1
+        replicas: 3
 EOF
 # end::install-zookeeper[]
 
@@ -155,7 +169,7 @@ spec:
   nodes:
     roleGroups:
       default:
-        replicas: 1
+        replicas: 2
 EOF
 # end::install-nifi[]
 
@@ -164,6 +178,8 @@ sleep 5
 echo "Awaiting NiFi rollout finish"
 # tag::wait-nifi-rollout[]
 kubectl wait -l statefulset.kubernetes.io/pod-name=simple-nifi-node-default-0 \
+--for=condition=ready pod --timeout=1200s && \
+kubectl wait -l statefulset.kubernetes.io/pod-name=simple-nifi-node-default-1 \
 --for=condition=ready pod --timeout=1200s
 # end::wait-nifi-rollout[]
 

diff --git a/docs/modules/nifi/examples/getting_started/getting_started.sh.j2 b/docs/modules/nifi/examples/getting_started/getting_started.sh.j2
@@ -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 <<EOF | jinja2 --format yaml getting_started.sh.j2 -o getting_started.sh
+# helm:
+#   repo_name: stackable-dev
+#   repo_url: https://repo.stackable.tech/repository/helm-dev/
+# versions:
+#   commons: 0.0.0-dev
+#   listener: 0.0.0-dev
+#   nifi: 0.0.0-dev
+#   secret: 0.0.0-dev
+#   zookeeper: 0.0.0-dev
+# EOF
+
 # The getting started guide script
 # It uses tagged regions which are included in the documentation
 # https://docs.asciidoctor.org/asciidoc/latest/directives/include-tagged-regions/