From cbb7f552cf1337dcc03a7b988331d062a2274959 Mon Sep 17 00:00:00 2001 From: Siegfried Weber Date: Mon, 20 Nov 2023 14:25:54 +0100 Subject: [PATCH] docs: Add listener-operator where missing (#428) * docs: Add listener-operator where missing * docs: Add listener-operator where missing * Remove duplicated navigation entry --- .../modules/hdfs/examples/getting_started/getting_started.sh | 2 ++ .../hdfs/examples/getting_started/getting_started.sh.j2 | 2 ++ docs/modules/hdfs/pages/getting_started/installation.adoc | 5 +++-- docs/modules/hdfs/pages/index.adoc | 4 ++-- docs/modules/hdfs/partials/nav.adoc | 1 - docs/templating_vars.yaml | 1 + 6 files changed, 10 insertions(+), 5 deletions(-) diff --git a/docs/modules/hdfs/examples/getting_started/getting_started.sh b/docs/modules/hdfs/examples/getting_started/getting_started.sh index fbc6b495..c6cbdb91 100755 --- a/docs/modules/hdfs/examples/getting_started/getting_started.sh +++ b/docs/modules/hdfs/examples/getting_started/getting_started.sh @@ -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") @@ -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[] diff --git a/docs/modules/hdfs/examples/getting_started/getting_started.sh.j2 b/docs/modules/hdfs/examples/getting_started/getting_started.sh.j2 index eadf5df1..4a84943f 100755 --- a/docs/modules/hdfs/examples/getting_started/getting_started.sh.j2 +++ b/docs/modules/hdfs/examples/getting_started/getting_started.sh.j2 @@ -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") @@ -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[] diff --git a/docs/modules/hdfs/pages/getting_started/installation.adoc b/docs/modules/hdfs/pages/getting_started/installation.adoc index b94e30fe..0d5abbd3 100644 --- a/docs/modules/hdfs/pages/getting_started/installation.adoc +++ b/docs/modules/hdfs/pages/getting_started/installation.adoc @@ -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 @@ -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 ---- @@ -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]. \ No newline at end of file +xref:getting_started/first_steps.adoc#_verify_that_it_works[verify that it works]. diff --git a/docs/modules/hdfs/pages/index.adoc b/docs/modules/hdfs/pages/index.adoc index 2d05280b..a47d3310 100644 --- a/docs/modules/hdfs/pages/index.adoc +++ b/docs/modules/hdfs/pages/index.adoc @@ -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 diff --git a/docs/modules/hdfs/partials/nav.adoc b/docs/modules/hdfs/partials/nav.adoc index 162aeb79..8ba4f559 100644 --- a/docs/modules/hdfs/partials/nav.adoc +++ b/docs/modules/hdfs/partials/nav.adoc @@ -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[] diff --git a/docs/templating_vars.yaml b/docs/templating_vars.yaml index 4051cd60..5adec89a 100644 --- a/docs/templating_vars.yaml +++ b/docs/templating_vars.yaml @@ -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