Skip to content

Commit

Permalink
docs(getting-started): update stackablectl op install output (#616)
Browse files Browse the repository at this point in the history
* docs(getting-started): update stackablectl op install output

* chore(getting-started): add warning to generated script
  • Loading branch information
NickLarsenNZ authored Jul 22, 2024
1 parent 8a9ec4e commit dd6cc36
Show file tree
Hide file tree
Showing 7 changed files with 39 additions and 15 deletions.
Original file line number Diff line number Diff line change
@@ -1,6 +1,19 @@
#!/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
# secret: 0.0.0-dev
# trino: 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/
Expand Down Expand Up @@ -68,10 +81,12 @@ kubectl rollout status --watch --timeout=5m statefulset/simple-trino-worker-defa
sleep 5

echo "Starting port-forwarding of coordinator port 8443"
# shellcheck disable=2069 # we want all output to be blackholed
# tag::port-forwarding[]
kubectl port-forward svc/simple-trino-coordinator 8443 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 5
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,19 @@
#!/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
# secret: 0.0.0-dev
# trino: 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/
Expand Down Expand Up @@ -68,10 +81,12 @@ kubectl rollout status --watch --timeout=5m statefulset/simple-trino-worker-defa
sleep 5

echo "Starting port-forwarding of coordinator port 8443"
# shellcheck disable=2069 # we want all output to be blackholed
# tag::port-forwarding[]
kubectl port-forward svc/simple-trino-coordinator 8443 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 5
Expand Down

This file was deleted.

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Installed commons=0.0.0-dev operator
Installed secret=0.0.0-dev operator
Installed listener=0.0.0-dev operator
Installed trino=0.0.0-dev operator
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Installed commons={{ versions.commons }} operator
Installed secret={{ versions.secret }} operator
Installed listener={{ versions.listener }} operator
Installed trino={{ versions.trino }} operator
4 changes: 1 addition & 3 deletions docs/modules/trino/pages/getting_started/installation.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,7 @@ include::example$getting_started/code/getting_started.sh[tag=stackablectl-instal
The tool will show
[source]
----
include::example$getting_started/code/install-operator-output.txt[tag=stackablectl-install-operators-output]
----
include::example$getting_started/code/install_output.txt[]
TIP: Consult the xref:management:stackablectl:quickstart.adoc[] to learn more about how to use `stackablectl`.
--
Expand Down

0 comments on commit dd6cc36

Please sign in to comment.