Skip to content

Commit

Permalink
docs: Add listener-operator where missing (#428)
Browse files Browse the repository at this point in the history
* docs: Add listener-operator where missing

* docs: Add listener-operator where missing

* Remove duplicated navigation entry
  • Loading branch information
siegfriedweber authored Nov 20, 2023
1 parent f39a8b1 commit cbb7f55
Show file tree
Hide file tree
Showing 6 changed files with 10 additions and 5 deletions.
2 changes: 2 additions & 0 deletions docs/modules/hdfs/examples/getting_started/getting_started.sh
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ helm install --wait zookeeper-operator stackable-dev/zookeeper-operator --versio
helm install --wait hdfs-operator stackable-dev/hdfs-operator --version 0.0.0-dev
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
# end::helm-install-operators[]
;;
"stackablectl")
Expand All @@ -38,6 +39,7 @@ echo "installing Operators with stackablectl"
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
# end::stackablectl-install-operators[]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ helm install --wait zookeeper-operator {{ helm.repo_name }}/zookeeper-operator -
helm install --wait hdfs-operator {{ helm.repo_name }}/hdfs-operator --version {{ versions.hdfs }}
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 }}
# end::helm-install-operators[]
;;
"stackablectl")
Expand All @@ -38,6 +39,7 @@ echo "installing Operators with stackablectl"
stackablectl operator install \
commons={{ versions.commons }} \
secret={{ versions.secret }} \
listener={{ versions.listener }} \
zookeeper={{ versions.zookeeper }} \
hdfs={{ versions.hdfs }}
# end::stackablectl-install-operators[]
Expand Down
5 changes: 3 additions & 2 deletions docs/modules/hdfs/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 HDFS operator and its dependency, the Zookeeper operator, as well as the
commons and secret operators which are required by all Stackable operators.
commons, secret and listener operators 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
----
Expand Down Expand Up @@ -55,4 +56,4 @@ for the required operators). You are now ready to deploy HDFS in Kubernetes.
== What's next

xref:getting_started/first_steps.adoc[Set up an HDFS cluster] and its dependencies and
xref:getting_started/first_steps.adoc#_verify_that_it_works[verify that it works].
xref:getting_started/first_steps.adoc#_verify_that_it_works[verify that it works].
4 changes: 2 additions & 2 deletions docs/modules/hdfs/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,8 @@ discovery ConfigMap contains the `core-site.xml` file and the `hdfs-site.xml` fi
== Dependencies

HDFS depends on ZooKeeper for coordination between nodes. You can run a ZooKeeper cluster with the
xref:zookeeper:index.adoc[]. Additionally, the xref:commons-operator:index.adoc[] and
xref:secret-operator:index.adoc[] are needed.
xref:zookeeper:index.adoc[]. Additionally, the xref:commons-operator:index.adoc[],
xref:secret-operator:index.adoc[] and xref:listener-operator:index.adoc[] are needed.

== [[demos]]Demos

Expand Down
1 change: 0 additions & 1 deletion docs/modules/hdfs/partials/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@
** xref:hdfs:usage-guide/logging-log-aggregation.adoc[]
** xref:hdfs:usage-guide/monitoring.adoc[]
** xref:hdfs:usage-guide/configuration-environment-overrides.adoc[]
** xref:hdfs:usage-guide/fuse.adoc[]
** xref:hdfs:usage-guide/operations/index.adoc[]
*** xref:hdfs:usage-guide/operations/cluster-operations.adoc[]
*** xref:hdfs:usage-guide/operations/pod-placement.adoc[]
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,5 +5,6 @@ helm:
versions:
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

0 comments on commit cbb7f55

Please sign in to comment.