Skip to content

Commit dd6cc36

Browse files
authored
docs(getting-started): update stackablectl op install output (#616)
* docs(getting-started): update stackablectl op install output * chore(getting-started): add warning to generated script
1 parent 8a9ec4e commit dd6cc36

File tree

7 files changed

+39
-15
lines changed

7 files changed

+39
-15
lines changed

docs/modules/trino/examples/getting_started/code/getting_started.sh

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,19 @@
11
#!/usr/bin/env bash
22
set -euo pipefail
33

4+
# DO NOT EDIT THE SCRIPT
5+
# Instead, update the j2 template, and regenerate it for dev:
6+
# cat <<EOF | jinja2 --format yaml getting_started.sh.j2 -o getting_started.sh
7+
# helm:
8+
# repo_name: stackable-dev
9+
# repo_url: https://repo.stackable.tech/repository/helm-dev/
10+
# versions:
11+
# commons: 0.0.0-dev
12+
# listener: 0.0.0-dev
13+
# secret: 0.0.0-dev
14+
# trino: 0.0.0-dev
15+
# EOF
16+
417
# The getting started guide script
518
# It uses tagged regions which are included in the documentation
619
# https://docs.asciidoctor.org/asciidoc/latest/directives/include-tagged-regions/
@@ -68,10 +81,12 @@ kubectl rollout status --watch --timeout=5m statefulset/simple-trino-worker-defa
6881
sleep 5
6982

7083
echo "Starting port-forwarding of coordinator port 8443"
84+
# shellcheck disable=2069 # we want all output to be blackholed
7185
# tag::port-forwarding[]
7286
kubectl port-forward svc/simple-trino-coordinator 8443 2>&1 >/dev/null &
7387
# end::port-forwarding[]
7488
PORT_FORWARD_PID=$!
89+
# shellcheck disable=2064 # we want the PID evaluated now, not at the time the trap is
7590
trap "kill $PORT_FORWARD_PID" EXIT
7691

7792
sleep 5

docs/modules/trino/examples/getting_started/code/getting_started.sh.j2

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,19 @@
11
#!/usr/bin/env bash
22
set -euo pipefail
33

4+
# DO NOT EDIT THE SCRIPT
5+
# Instead, update the j2 template, and regenerate it for dev:
6+
# cat <<EOF | jinja2 --format yaml getting_started.sh.j2 -o getting_started.sh
7+
# helm:
8+
# repo_name: stackable-dev
9+
# repo_url: https://repo.stackable.tech/repository/helm-dev/
10+
# versions:
11+
# commons: 0.0.0-dev
12+
# listener: 0.0.0-dev
13+
# secret: 0.0.0-dev
14+
# trino: 0.0.0-dev
15+
# EOF
16+
417
# The getting started guide script
518
# It uses tagged regions which are included in the documentation
619
# https://docs.asciidoctor.org/asciidoc/latest/directives/include-tagged-regions/
@@ -68,10 +81,12 @@ kubectl rollout status --watch --timeout=5m statefulset/simple-trino-worker-defa
6881
sleep 5
6982

7083
echo "Starting port-forwarding of coordinator port 8443"
84+
# shellcheck disable=2069 # we want all output to be blackholed
7185
# tag::port-forwarding[]
7286
kubectl port-forward svc/simple-trino-coordinator 8443 2>&1 >/dev/null &
7387
# end::port-forwarding[]
7488
PORT_FORWARD_PID=$!
89+
# shellcheck disable=2064 # we want the PID evaluated now, not at the time the trap is
7590
trap "kill $PORT_FORWARD_PID" EXIT
7691

7792
sleep 5

docs/modules/trino/examples/getting_started/code/install-operator-output.txt

Lines changed: 0 additions & 6 deletions
This file was deleted.

docs/modules/trino/examples/getting_started/code/install-operator-output.txt.j2

Lines changed: 0 additions & 6 deletions
This file was deleted.
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Installed commons=0.0.0-dev operator
2+
Installed secret=0.0.0-dev operator
3+
Installed listener=0.0.0-dev operator
4+
Installed trino=0.0.0-dev operator
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Installed commons={{ versions.commons }} operator
2+
Installed secret={{ versions.secret }} operator
3+
Installed listener={{ versions.listener }} operator
4+
Installed trino={{ versions.trino }} operator

docs/modules/trino/pages/getting_started/installation.adoc

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,7 @@ include::example$getting_started/code/getting_started.sh[tag=stackablectl-instal
2424
The tool will show
2525
2626
[source]
27-
----
28-
include::example$getting_started/code/install-operator-output.txt[tag=stackablectl-install-operators-output]
29-
----
27+
include::example$getting_started/code/install_output.txt[]
3028
3129
TIP: Consult the xref:management:stackablectl:quickstart.adoc[] to learn more about how to use `stackablectl`.
3230
--

0 commit comments

Comments
 (0)