Skip to content

Commit ce6119a

Browse files
authored
docs(getting-started): update stackablectl op install output (#838)
* docs(getting-started): update stackablectl op install output * chore(getting-started): add warning to generated script * chore(shellcheck): defer fixing the warning for now * fix(getting-started): use correct version for rendered file
1 parent 21ab88b commit ce6119a

File tree

4 files changed

+36
-8
lines changed

4 files changed

+36
-8
lines changed

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

Lines changed: 14 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+
# zookeeper: 0.0.0-dev
15+
# EOF
16+
417
# This script contains all the code snippets from the guide, as well as some assert tests
518
# to test if the instructions in the guide work. The user *could* use it, but it is intended
619
# for testing only.
@@ -112,6 +125,7 @@ kubectl describe configmap simple-znode
112125

113126
cm_output=$(get_configmap)
114127

128+
# shellcheck disable=SC2181 # wont't fix this now, but ideally we should enable bash strict mode so we can avoid success checks.
115129
if [[ $? == 0 ]]; then
116130
echo "ConfigMap retrieved."
117131
else

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

Lines changed: 14 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+
# zookeeper: 0.0.0-dev
15+
# EOF
16+
417
# This script contains all the code snippets from the guide, as well as some assert tests
518
# to test if the instructions in the guide work. The user *could* use it, but it is intended
619
# for testing only.
@@ -112,6 +125,7 @@ kubectl describe configmap simple-znode
112125

113126
cm_output=$(get_configmap)
114127

128+
# shellcheck disable=SC2181 # wont't fix this now, but ideally we should enable bash strict mode so we can avoid success checks.
115129
if [[ $? == 0 ]]; then
116130
echo "ConfigMap retrieved."
117131
else
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[INFO ] Installing commons operator in version 0.0.0-dev
2-
[INFO ] Installing secret operator in version 0.0.0-dev
3-
[INFO ] Installing listener operator in version 0.0.0-dev
4-
[INFO ] Installing zookeeper operator in version 0.0.0-dev
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 zookeeper=0.0.0-dev operator
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[INFO ] Installing commons operator in version {{ versions.commons }}
2-
[INFO ] Installing secret operator in version {{ versions.secret }}
3-
[INFO ] Installing listener operator in version {{ versions.listener }}
4-
[INFO ] Installing zookeeper operator in version {{ versions.zookeeper }}
1+
Installed commons={{ versions.commons }} operator
2+
Installed secret={{ versions.secret }} operator
3+
Installed listener={{ versions.listener }} operator
4+
Installed zookeeper={{ versions.zookeeper }} operator

0 commit comments

Comments
 (0)