Skip to content

Commit 8189f19

Browse files
committed
chore(getting-started): add warning to generated script
1 parent 4ad0b08 commit 8189f19

File tree

2 files changed

+34
-4
lines changed

2 files changed

+34
-4
lines changed

docs/modules/hive/examples/getting_started/getting_started.sh

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,21 @@
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+
# hive: 0.0.0-dev
13+
# listener: 0.0.0-dev
14+
# secret: 0.0.0-dev
15+
# minio: 4.0.2
16+
# postgresql: 12.1.5
17+
# EOF
18+
419
# The getting started guide script
520
# It uses tagged regions which are included in the documentation
621
# https://docs.asciidoctor.org/asciidoc/latest/directives/include-tagged-regions/
@@ -39,8 +54,8 @@ helm install --wait hive-operator stackable-dev/hive-operator --version 0.0.0-de
3954
echo "Install minio for S3"
4055
# tag::helm-install-minio[]
4156
helm install minio \
42-
--namespace default \
4357
--version 4.0.2 \
58+
--namespace default \
4459
--set mode=standalone \
4560
--set replicas=1 \
4661
--set persistence.enabled=false \
@@ -55,7 +70,7 @@ helm install minio \
5570
echo "Install postgres for Hive"
5671
# tag::helm-install-postgres[]
5772
helm install postgresql \
58-
--version=12.1.5 \
73+
--version 12.1.5 \
5974
--namespace default \
6075
--set auth.username=hive \
6176
--set auth.password=hive \

docs/modules/hive/examples/getting_started/getting_started.sh.j2

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,21 @@
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+
# hive: 0.0.0-dev
13+
# listener: 0.0.0-dev
14+
# secret: 0.0.0-dev
15+
# minio: 4.0.2
16+
# postgresql: 12.1.5
17+
# EOF
18+
419
# The getting started guide script
520
# It uses tagged regions which are included in the documentation
621
# https://docs.asciidoctor.org/asciidoc/latest/directives/include-tagged-regions/
@@ -39,8 +54,8 @@ helm install --wait hive-operator {{ helm.repo_name }}/hive-operator --version {
3954
echo "Install minio for S3"
4055
# tag::helm-install-minio[]
4156
helm install minio \
57+
--version {{ versions.minio }} \
4258
--namespace default \
43-
--version 4.0.2 \
4459
--set mode=standalone \
4560
--set replicas=1 \
4661
--set persistence.enabled=false \
@@ -55,7 +70,7 @@ helm install minio \
5570
echo "Install postgres for Hive"
5671
# tag::helm-install-postgres[]
5772
helm install postgresql \
58-
--version=12.1.5 \
73+
--version {{ versions.postgresql }} \
5974
--namespace default \
6075
--set auth.username=hive \
6176
--set auth.password=hive \

0 commit comments

Comments
 (0)