Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add listener-operator where missing #489

Merged
merged 3 commits into from
Nov 20, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
# tag::helm-install-operators[]
helm install --wait commons-operator stackable-dev/commons-operator --version 0.0.0-dev
helm install --wait secret-operator stackable-dev/secret-operator --version 0.0.0-dev
helm install --wait listener-operator stackable-dev/listener-operator --version 0.0.0-dev
helm install --wait zookeeper-operator stackable-dev/zookeeper-operator --version 0.0.0-dev
helm install --wait hdfs-operator stackable-dev/hdfs-operator --version 0.0.0-dev
helm install --wait druid-operator stackable-dev/druid-operator --version 0.0.0-dev
Expand All @@ -42,6 +43,7 @@
stackablectl operator install \
commons=0.0.0-dev \
secret=0.0.0-dev \
listener=0.0.0-dev \
zookeeper=0.0.0-dev \
hdfs=0.0.0-dev \
druid=0.0.0-dev
Expand Down Expand Up @@ -124,7 +126,7 @@
kubectl port-forward svc/simple-druid-router 8888 > /dev/null 2>&1 &
# end::port-forwarding[]
PORT_FORWARD_PID=$!
trap "kill $PORT_FORWARD_PID" EXIT

Check warning on line 129 in docs/modules/druid/examples/getting_started/getting_started.sh

View workflow job for this annotation

GitHub Actions / shellcheck

[shellcheck] docs/modules/druid/examples/getting_started/getting_started.sh#L129 <ShellCheck.SC2064>

Use single quotes, otherwise this expands now rather than when signalled.
Raw output
./docs/modules/druid/examples/getting_started/getting_started.sh:129:12: warning: Use single quotes, otherwise this expands now rather than when signalled. (ShellCheck.SC2064)
sleep 5

submit_job() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ echo "Installing Operators with Helm"
# tag::helm-install-operators[]
helm install --wait commons-operator {{ helm.repo_name }}/commons-operator --version {{ versions.commons }}
helm install --wait secret-operator {{ helm.repo_name }}/secret-operator --version {{ versions.secret }}
helm install --wait listener-operator {{ helm.repo_name }}/listener-operator --version {{ versions.listener }}
helm install --wait zookeeper-operator {{ helm.repo_name }}/zookeeper-operator --version {{ versions.zk }}
helm install --wait hdfs-operator {{ helm.repo_name }}/hdfs-operator --version {{ versions.hdfs }}
helm install --wait druid-operator {{ helm.repo_name }}/druid-operator --version {{ versions.druid }}
Expand All @@ -42,6 +43,7 @@ echo "installing Operators with stackablectl"
stackablectl operator install \
commons={{ versions.commons }} \
secret={{ versions.secret }} \
listener={{ versions.listener }} \
zookeeper={{ versions.zk }} \
hdfs={{ versions.hdfs }} \
druid={{ versions.druid }}
Expand Down
5 changes: 3 additions & 2 deletions docs/modules/druid/pages/getting_started/installation.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= Installation

On this page you will install the Stackable Druid Operator and Operators for its dependencies - ZooKeeper and HDFS - as
well as the commons and secret operator which are required by all Stackable Operators.
well as the commons, secret and listener operator which are required by all Stackable Operators.

== Stackable Operators

Expand All @@ -28,6 +28,7 @@ The tool will show
----
[INFO ] Installing commons operator
[INFO ] Installing secret operator
[INFO ] Installing listener operator
[INFO ] Installing zookeeper operator
[INFO ] Installing hdfs operator
[INFO ] Installing druid operator
Expand Down Expand Up @@ -56,4 +57,4 @@ the CRDs for the required operators). You are now ready to deploy Apache Druid i

xref:getting_started/first_steps.adoc[Set up a Druid cluster] and its dependencies and
xref:getting_started/first_steps.adoc#_ingest_example_data[ingest example data] and
xref:getting_started/first_steps.adoc#_query_the_data[query the data].
xref:getting_started/first_steps.adoc#_query_the_data[query the data].
1 change: 1 addition & 0 deletions docs/modules/druid/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ The Druid Operator has the following dependencies:
between processes.
* The xref:commons-operator:index.adoc[] provides common CRDs such as xref:concepts:s3.adoc[] CRDs.
* The xref:secret-operator:index.adoc[] is required for things like S3 access credentials or LDAP integration.
* The xref:listener-operator:index.adoc[] exposes the pods to the outside network.

Have a look at the xref:getting_started/index.adoc[getting started guide] for an example of a minimal working setup.

Expand Down
1 change: 1 addition & 0 deletions docs/templating_vars.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ helm:
versions:
commons: 0.0.0-dev
secret: 0.0.0-dev
listener: 0.0.0-dev
zk: 0.0.0-dev
hdfs: 0.0.0-dev
druid: 0.0.0-dev