From c08229da3ddb2611843aa0533cda9fa2fa8c93b2 Mon Sep 17 00:00:00 2001 From: Andrew Kenworthy Date: Mon, 23 Jan 2023 11:45:51 +0100 Subject: [PATCH 1/7] release 23.1.0 --- CHANGELOG.md | 2 ++ Cargo.lock | 4 ++-- deploy/helm/hbase-operator/Chart.yaml | 4 ++-- docs/antora.yml | 4 ++-- docs/modules/ROOT/pages/usage.adoc | 2 +- .../examples/code/getting_started.sh | 24 +++++++++---------- .../getting_started/examples/code/hbase.yaml | 2 +- .../getting_started/examples/code/hdfs.yaml | 2 +- .../examples/code/install_output.txt | 10 ++++---- .../getting_started/examples/code/zk.yaml | 2 +- docs/templating_vars.yaml | 14 +++++------ rust/crd/Cargo.toml | 2 +- rust/operator-binary/Cargo.toml | 2 +- tests/test-definition.yaml | 24 +++++++++---------- 14 files changed, 50 insertions(+), 48 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 81dc1ca5..43cff4b8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,8 @@ ## [Unreleased] +## [23.1.0] - 2023-01-23 + ### Added - Log aggregation added ([#294]). diff --git a/Cargo.lock b/Cargo.lock index 13ee995e..b8519f05 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1759,7 +1759,7 @@ dependencies = [ [[package]] name = "stackable-hbase-crd" -version = "0.6.0-nightly" +version = "23.1.0" dependencies = [ "serde", "serde_json", @@ -1771,7 +1771,7 @@ dependencies = [ [[package]] name = "stackable-hbase-operator" -version = "0.6.0-nightly" +version = "23.1.0" dependencies = [ "anyhow", "built", diff --git a/deploy/helm/hbase-operator/Chart.yaml b/deploy/helm/hbase-operator/Chart.yaml index cb415618..fa326b12 100644 --- a/deploy/helm/hbase-operator/Chart.yaml +++ b/deploy/helm/hbase-operator/Chart.yaml @@ -1,8 +1,8 @@ --- apiVersion: v2 name: hbase-operator -version: "0.6.0-nightly" -appVersion: "0.6.0-nightly" +version: "23.1.0" +appVersion: "23.1.0" description: The Stackable Operator for Apache HBase home: https://github.com/stackabletech/hbase-operator maintainers: diff --git a/docs/antora.yml b/docs/antora.yml index a17601c1..94a43bc5 100644 --- a/docs/antora.yml +++ b/docs/antora.yml @@ -1,7 +1,7 @@ name: hbase -version: "nightly" +version: "23.1.0" title: Stackable Operator for Apache HBase nav: - modules/getting_started/nav.adoc - modules/ROOT/nav.adoc -prerelease: true +prerelease: false diff --git a/docs/modules/ROOT/pages/usage.adoc b/docs/modules/ROOT/pages/usage.adoc index 122c6d6d..d8ecdbf7 100644 --- a/docs/modules/ROOT/pages/usage.adoc +++ b/docs/modules/ROOT/pages/usage.adoc @@ -154,7 +154,7 @@ The HBase Operator currently does not support any https://kubernetes.io/docs/con // The "nightly" version is needed because the "include" directive searches for // files in the "stable" version by default. // TODO: remove the "nightly" version after the next platform release (current: 22.09) -include::nightly@home:concepts:stackable_resource_requests.adoc[] +include::home:concepts:stackable_resource_requests.adoc[] If no resources are configured explicitly, the HBase operator uses following defaults: diff --git a/docs/modules/getting_started/examples/code/getting_started.sh b/docs/modules/getting_started/examples/code/getting_started.sh index b1ca3f16..8c9f955e 100755 --- a/docs/modules/getting_started/examples/code/getting_started.sh +++ b/docs/modules/getting_started/examples/code/getting_started.sh @@ -14,28 +14,28 @@ fi case "$1" in "helm") -echo "Adding 'stackable-dev' Helm Chart repository" +echo "Adding 'stackable-stable' Helm Chart repository" # tag::helm-add-repo[] -helm repo add stackable-dev https://repo.stackable.tech/repository/helm-dev/ +helm repo add stackable-stable https://repo.stackable.tech/repository/helm-stable/ # end::helm-add-repo[] echo "Installing Operators with Helm" # tag::helm-install-operators[] -helm install --wait zookeeper-operator stackable-dev/zookeeper-operator --version 0.13.0-nightly -helm install --wait hdfs-operator stackable-dev/hdfs-operator --version 0.7.0-nightly -helm install --wait commons-operator stackable-dev/commons-operator --version 0.5.0-nightly -helm install --wait secret-operator stackable-dev/secret-operator --version 0.7.0-nightly -helm install --wait hbase-operator stackable-dev/hbase-operator --version 0.6.0-nightly +helm install --wait zookeeper-operator stackable-stable/zookeeper-operator --version 23.1.0 +helm install --wait hdfs-operator stackable-stable/hdfs-operator --version 23.1.0 +helm install --wait commons-operator stackable-stable/commons-operator --version 23.1.0 +helm install --wait secret-operator stackable-stable/secret-operator --version 23.1.0 +helm install --wait hbase-operator stackable-stable/hbase-operator --version 23.1.0 # end::helm-install-operators[] ;; "stackablectl") echo "installing Operators with stackablectl" # tag::stackablectl-install-operators[] stackablectl operator install \ - commons=0.5.0-nightly \ - secret=0.7.0-nightly \ - zookeeper=0.13.0-nightly \ - hdfs=0.7.0-nightly \ - hbase=0.6.0-nightly + commons=23.1.0 \ + secret=23.1.0 \ + zookeeper=23.1.0 \ + hdfs=23.1.0 \ + hbase=23.1.0 # end::stackablectl-install-operators[] ;; *) diff --git a/docs/modules/getting_started/examples/code/hbase.yaml b/docs/modules/getting_started/examples/code/hbase.yaml index 8ddd3a90..7c3aa27e 100644 --- a/docs/modules/getting_started/examples/code/hbase.yaml +++ b/docs/modules/getting_started/examples/code/hbase.yaml @@ -6,7 +6,7 @@ metadata: spec: image: productVersion: 2.4.12 - stackableVersion: 0.4.0 + stackableVersion: 23.1.0 hdfsConfigMapName: simple-hdfs zookeeperConfigMapName: simple-znode config: diff --git a/docs/modules/getting_started/examples/code/hdfs.yaml b/docs/modules/getting_started/examples/code/hdfs.yaml index d862f872..1165553f 100644 --- a/docs/modules/getting_started/examples/code/hdfs.yaml +++ b/docs/modules/getting_started/examples/code/hdfs.yaml @@ -6,7 +6,7 @@ metadata: spec: image: productVersion: 3.3.4 - stackableVersion: 0.2.0 + stackableVersion: 23.1.0 zookeeperConfigMapName: simple-znode dfsReplication: 3 nameNodes: diff --git a/docs/modules/getting_started/examples/code/install_output.txt b/docs/modules/getting_started/examples/code/install_output.txt index b8927a37..c32c4e97 100644 --- a/docs/modules/getting_started/examples/code/install_output.txt +++ b/docs/modules/getting_started/examples/code/install_output.txt @@ -1,5 +1,5 @@ -[INFO ] Installing commons operator in version 0.5.0-nightly -[INFO ] Installing secret operator in version 0.7.0-nightly -[INFO ] Installing zookeeper operator in version 0.13.0-nightly -[INFO ] Installing hdfs operator 0.7.0-nightly -[INFO ] Installing hbase operator 0.6.0-nightly +[INFO ] Installing commons operator in version 23.1.0 +[INFO ] Installing secret operator in version 23.1.0 +[INFO ] Installing zookeeper operator in version 23.1.0 +[INFO ] Installing hdfs operator 23.1.0 +[INFO ] Installing hbase operator 23.1.0 diff --git a/docs/modules/getting_started/examples/code/zk.yaml b/docs/modules/getting_started/examples/code/zk.yaml index dd22801a..d9d64b70 100644 --- a/docs/modules/getting_started/examples/code/zk.yaml +++ b/docs/modules/getting_started/examples/code/zk.yaml @@ -6,7 +6,7 @@ metadata: spec: image: productVersion: 3.8.0 - stackableVersion: 0.8.0 + stackableVersion: 23.1.0 servers: roleGroups: default: diff --git a/docs/templating_vars.yaml b/docs/templating_vars.yaml index 95688740..8ebdc2e4 100644 --- a/docs/templating_vars.yaml +++ b/docs/templating_vars.yaml @@ -1,10 +1,10 @@ --- helm: - repo_name: stackable-dev - repo_url: https://repo.stackable.tech/repository/helm-dev/ + repo_name: stackable-stable + repo_url: https://repo.stackable.tech/repository/helm-stable/ versions: - commons: 0.5.0-nightly - secret: 0.7.0-nightly - zookeeper: 0.13.0-nightly - hdfs: 0.7.0-nightly - hbase: 0.6.0-nightly + commons: 23.1.0 + secret: 23.1.0 + zookeeper: 23.1.0 + hdfs: 23.1.0 + hbase: 23.1.0 diff --git a/rust/crd/Cargo.toml b/rust/crd/Cargo.toml index f03969d0..bcb81120 100644 --- a/rust/crd/Cargo.toml +++ b/rust/crd/Cargo.toml @@ -5,7 +5,7 @@ edition = "2021" license = "OSL-3.0" name = "stackable-hbase-crd" repository = "https://github.com/stackabletech/hbase-operator" -version = "0.6.0-nightly" +version = "23.1.0" publish = false [dependencies] diff --git a/rust/operator-binary/Cargo.toml b/rust/operator-binary/Cargo.toml index 6ebfcbeb..107e722d 100644 --- a/rust/operator-binary/Cargo.toml +++ b/rust/operator-binary/Cargo.toml @@ -3,7 +3,7 @@ name = "stackable-hbase-operator" authors = ["Stackable GmbH "] description = "Stackable Operator for Apache HBase" license = "OSL-3.0" -version = "0.6.0-nightly" +version = "23.1.0" edition = "2021" repository = "https://github.com/stackabletech/hbase-operator" publish = false diff --git a/tests/test-definition.yaml b/tests/test-definition.yaml index bd6e4051..c0666b04 100644 --- a/tests/test-definition.yaml +++ b/tests/test-definition.yaml @@ -2,28 +2,28 @@ dimensions: - name: hbase values: - - 2.4.8-stackable0.9.0 - - 2.4.9-stackable0.9.0 - - 2.4.11-stackable0.9.0 - - 2.4.12-stackable0.4.0 + - 2.4.8-stackable23.1.0 + - 2.4.9-stackable23.1.0 + - 2.4.11-stackable23.1.0 + - 2.4.12-stackable23.1.0 - name: hbase-latest values: - - 2.4.12-stackable0.4.0 + - 2.4.12-stackable23.1.0 - name: hdfs values: - - 3.2.2-stackable0.6.0 - - 3.3.3-stackable0.2.0 + - 3.2.2-stackable23.1.0 + - 3.3.3-stackable23.1.0 - name: hdfs-latest values: - - 3.3.4-stackable0.2.0 + - 3.3.4-stackable23.1.0 - name: zookeeper values: - - 3.6.3-stackable0.9.0 - - 3.7.0-stackable0.9.0 - - 3.8.0-stackable0.9.0 + - 3.6.3-stackable23.1.0 + - 3.7.0-stackable23.1.0 + - 3.8.0-stackable23.1.0 - name: zookeeper-latest values: - - 3.8.0-stackable0.9.0 + - 3.8.0-stackable23.1.0 tests: - name: smoke dimensions: From 67775573a7ef2aa26e5fddfdab4a3690a2deb54e Mon Sep 17 00:00:00 2001 From: Razvan-Daniel Mihai <84674+razvan@users.noreply.github.com> Date: Tue, 24 Jan 2023 15:02:29 +0100 Subject: [PATCH 2/7] Change antora version to 23.1 --- docs/antora.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/antora.yml b/docs/antora.yml index 94a43bc5..48069c38 100644 --- a/docs/antora.yml +++ b/docs/antora.yml @@ -1,5 +1,5 @@ name: hbase -version: "23.1.0" +version: "23.1" title: Stackable Operator for Apache HBase nav: - modules/getting_started/nav.adoc From 903b83bf85874daf2760950a93c2501d011e2c93 Mon Sep 17 00:00:00 2001 From: Felix Hennig Date: Mon, 13 Feb 2023 15:21:39 +0000 Subject: [PATCH 3/7] Spike/distributed component (#313) *Please add a description here. This will become the commit message of the merge request later.* --- docs/antora.yml | 8 ++--- docs/modules/ROOT/nav.adoc | 3 -- docs/modules/getting_started/nav.adoc | 3 -- .../getting_started}/getting_started.sh | 0 .../getting_started}/getting_started.sh.j2 | 0 .../examples/getting_started}/hbase.yaml | 0 .../examples/getting_started}/hdfs.yaml | 0 .../getting_started}/install_output.txt | 0 .../getting_started}/install_output.txt.j2 | 0 .../test_getting_started_helm.sh | 6 ++++ .../test_getting_started_stackablectl.sh | 6 ++++ .../examples/getting_started}/zk.yaml | 0 .../examples/getting_started}/znode.yaml | 0 .../images/phoenix_sqlline.png | Bin .../{ROOT => hbase}/images/phoenix_tables.png | Bin .../pages/commandline_args.adoc | 0 .../{ROOT => hbase}/pages/configuration.adoc | 0 .../{ROOT => hbase}/pages/discovery.adoc | 0 .../{ROOT => hbase}/pages/env_var_args.adoc | 0 .../pages/getting_started}/first_steps.adoc | 32 +++++++++--------- .../pages/getting_started}/index.adoc | 4 +-- .../pages/getting_started}/installation.adoc | 10 +++--- docs/modules/{ROOT => hbase}/pages/index.adoc | 0 docs/modules/{ROOT => hbase}/pages/usage.adoc | 0 docs/modules/hbase/partials/nav.adoc | 6 ++++ .../partials/supported-versions.adoc | 0 26 files changed, 43 insertions(+), 35 deletions(-) delete mode 100644 docs/modules/ROOT/nav.adoc delete mode 100644 docs/modules/getting_started/nav.adoc rename docs/modules/{getting_started/examples/code => hbase/examples/getting_started}/getting_started.sh (100%) rename docs/modules/{getting_started/examples/code => hbase/examples/getting_started}/getting_started.sh.j2 (100%) rename docs/modules/{getting_started/examples/code => hbase/examples/getting_started}/hbase.yaml (100%) rename docs/modules/{getting_started/examples/code => hbase/examples/getting_started}/hdfs.yaml (100%) rename docs/modules/{getting_started/examples/code => hbase/examples/getting_started}/install_output.txt (100%) rename docs/modules/{getting_started/examples/code => hbase/examples/getting_started}/install_output.txt.j2 (100%) create mode 100755 docs/modules/hbase/examples/getting_started/test_getting_started_helm.sh create mode 100755 docs/modules/hbase/examples/getting_started/test_getting_started_stackablectl.sh rename docs/modules/{getting_started/examples/code => hbase/examples/getting_started}/zk.yaml (100%) rename docs/modules/{getting_started/examples/code => hbase/examples/getting_started}/znode.yaml (100%) rename docs/modules/{ROOT => hbase}/images/phoenix_sqlline.png (100%) rename docs/modules/{ROOT => hbase}/images/phoenix_tables.png (100%) rename docs/modules/{ROOT => hbase}/pages/commandline_args.adoc (100%) rename docs/modules/{ROOT => hbase}/pages/configuration.adoc (100%) rename docs/modules/{ROOT => hbase}/pages/discovery.adoc (100%) rename docs/modules/{ROOT => hbase}/pages/env_var_args.adoc (100%) rename docs/modules/{getting_started/pages => hbase/pages/getting_started}/first_steps.adoc (78%) rename docs/modules/{getting_started/pages => hbase/pages/getting_started}/index.adoc (79%) rename docs/modules/{getting_started/pages => hbase/pages/getting_started}/installation.adoc (74%) rename docs/modules/{ROOT => hbase}/pages/index.adoc (100%) rename docs/modules/{ROOT => hbase}/pages/usage.adoc (100%) create mode 100644 docs/modules/hbase/partials/nav.adoc rename docs/modules/{ROOT => hbase}/partials/supported-versions.adoc (100%) diff --git a/docs/antora.yml b/docs/antora.yml index 48069c38..40b88a7b 100644 --- a/docs/antora.yml +++ b/docs/antora.yml @@ -1,7 +1,3 @@ -name: hbase +--- +name: home version: "23.1" -title: Stackable Operator for Apache HBase -nav: - - modules/getting_started/nav.adoc - - modules/ROOT/nav.adoc -prerelease: false diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc deleted file mode 100644 index 0184e513..00000000 --- a/docs/modules/ROOT/nav.adoc +++ /dev/null @@ -1,3 +0,0 @@ -* xref:configuration.adoc[] -* xref:usage.adoc[] -* xref:discovery.adoc[] diff --git a/docs/modules/getting_started/nav.adoc b/docs/modules/getting_started/nav.adoc deleted file mode 100644 index 4fdd6221..00000000 --- a/docs/modules/getting_started/nav.adoc +++ /dev/null @@ -1,3 +0,0 @@ -* xref:index.adoc[] -** xref:installation.adoc[] -** xref:first_steps.adoc[] \ No newline at end of file diff --git a/docs/modules/getting_started/examples/code/getting_started.sh b/docs/modules/hbase/examples/getting_started/getting_started.sh similarity index 100% rename from docs/modules/getting_started/examples/code/getting_started.sh rename to docs/modules/hbase/examples/getting_started/getting_started.sh diff --git a/docs/modules/getting_started/examples/code/getting_started.sh.j2 b/docs/modules/hbase/examples/getting_started/getting_started.sh.j2 similarity index 100% rename from docs/modules/getting_started/examples/code/getting_started.sh.j2 rename to docs/modules/hbase/examples/getting_started/getting_started.sh.j2 diff --git a/docs/modules/getting_started/examples/code/hbase.yaml b/docs/modules/hbase/examples/getting_started/hbase.yaml similarity index 100% rename from docs/modules/getting_started/examples/code/hbase.yaml rename to docs/modules/hbase/examples/getting_started/hbase.yaml diff --git a/docs/modules/getting_started/examples/code/hdfs.yaml b/docs/modules/hbase/examples/getting_started/hdfs.yaml similarity index 100% rename from docs/modules/getting_started/examples/code/hdfs.yaml rename to docs/modules/hbase/examples/getting_started/hdfs.yaml diff --git a/docs/modules/getting_started/examples/code/install_output.txt b/docs/modules/hbase/examples/getting_started/install_output.txt similarity index 100% rename from docs/modules/getting_started/examples/code/install_output.txt rename to docs/modules/hbase/examples/getting_started/install_output.txt diff --git a/docs/modules/getting_started/examples/code/install_output.txt.j2 b/docs/modules/hbase/examples/getting_started/install_output.txt.j2 similarity index 100% rename from docs/modules/getting_started/examples/code/install_output.txt.j2 rename to docs/modules/hbase/examples/getting_started/install_output.txt.j2 diff --git a/docs/modules/hbase/examples/getting_started/test_getting_started_helm.sh b/docs/modules/hbase/examples/getting_started/test_getting_started_helm.sh new file mode 100755 index 00000000..b936b1d8 --- /dev/null +++ b/docs/modules/hbase/examples/getting_started/test_getting_started_helm.sh @@ -0,0 +1,6 @@ +#! /usr/bin/env bash +set -euo pipefail + +cd "$(dirname "$0")" +./getting_started.sh helm + diff --git a/docs/modules/hbase/examples/getting_started/test_getting_started_stackablectl.sh b/docs/modules/hbase/examples/getting_started/test_getting_started_stackablectl.sh new file mode 100755 index 00000000..147a7276 --- /dev/null +++ b/docs/modules/hbase/examples/getting_started/test_getting_started_stackablectl.sh @@ -0,0 +1,6 @@ +#! /usr/bin/env bash +set -euo pipefail + +cd "$(dirname "$0")" +./getting_started.sh stackablectl + diff --git a/docs/modules/getting_started/examples/code/zk.yaml b/docs/modules/hbase/examples/getting_started/zk.yaml similarity index 100% rename from docs/modules/getting_started/examples/code/zk.yaml rename to docs/modules/hbase/examples/getting_started/zk.yaml diff --git a/docs/modules/getting_started/examples/code/znode.yaml b/docs/modules/hbase/examples/getting_started/znode.yaml similarity index 100% rename from docs/modules/getting_started/examples/code/znode.yaml rename to docs/modules/hbase/examples/getting_started/znode.yaml diff --git a/docs/modules/ROOT/images/phoenix_sqlline.png b/docs/modules/hbase/images/phoenix_sqlline.png similarity index 100% rename from docs/modules/ROOT/images/phoenix_sqlline.png rename to docs/modules/hbase/images/phoenix_sqlline.png diff --git a/docs/modules/ROOT/images/phoenix_tables.png b/docs/modules/hbase/images/phoenix_tables.png similarity index 100% rename from docs/modules/ROOT/images/phoenix_tables.png rename to docs/modules/hbase/images/phoenix_tables.png diff --git a/docs/modules/ROOT/pages/commandline_args.adoc b/docs/modules/hbase/pages/commandline_args.adoc similarity index 100% rename from docs/modules/ROOT/pages/commandline_args.adoc rename to docs/modules/hbase/pages/commandline_args.adoc diff --git a/docs/modules/ROOT/pages/configuration.adoc b/docs/modules/hbase/pages/configuration.adoc similarity index 100% rename from docs/modules/ROOT/pages/configuration.adoc rename to docs/modules/hbase/pages/configuration.adoc diff --git a/docs/modules/ROOT/pages/discovery.adoc b/docs/modules/hbase/pages/discovery.adoc similarity index 100% rename from docs/modules/ROOT/pages/discovery.adoc rename to docs/modules/hbase/pages/discovery.adoc diff --git a/docs/modules/ROOT/pages/env_var_args.adoc b/docs/modules/hbase/pages/env_var_args.adoc similarity index 100% rename from docs/modules/ROOT/pages/env_var_args.adoc rename to docs/modules/hbase/pages/env_var_args.adoc diff --git a/docs/modules/getting_started/pages/first_steps.adoc b/docs/modules/hbase/pages/getting_started/first_steps.adoc similarity index 78% rename from docs/modules/getting_started/pages/first_steps.adoc rename to docs/modules/hbase/pages/getting_started/first_steps.adoc index 7e2d5d4c..2c0e5673 100644 --- a/docs/modules/getting_started/pages/first_steps.adoc +++ b/docs/modules/hbase/pages/getting_started/first_steps.adoc @@ -1,6 +1,6 @@ = First steps -Once you have followed the steps in the xref:installation.adoc[] section to install the operator and its dependencies, you will now deploy an HBase cluster and its dependencies. Afterwards you can <<_verify_that_it_works, verify that it works>> by creating tables and data in HBase using the REST API and Apache Phoenix (an SQL layer used to interact with HBase). +Once you have followed the steps in the xref:getting_started/installation.adoc[] section to install the operator and its dependencies, you will now deploy an HBase cluster and its dependencies. Afterwards you can <<_verify_that_it_works, verify that it works>> by creating tables and data in HBase using the REST API and Apache Phoenix (an SQL layer used to interact with HBase). == Setup @@ -9,22 +9,22 @@ Once you have followed the steps in the xref:installation.adoc[] section to inst To deploy a ZooKeeper cluster create one file called `zk.yaml`: [source,yaml] -include::example$code/zk.yaml[] +include::example$getting_started/zk.yaml[] We also need to define a ZNode that will be used by the HDFS and HBase clusters to reference ZooKeeper. Create another file called `znode.yaml`: [source,yaml] -include::example$code/znode.yaml[] +include::example$getting_started/znode.yaml[] Apply both of these files: [source] -include::example$code/getting_started.sh[tag=install-zk] +include::example$getting_started/getting_started.sh[tag=install-zk] The state of the ZooKeeper cluster can be tracked with `kubectl`: [source] -include::example$code/getting_started.sh[tag=watch-zk-rollout] +include::example$getting_started/getting_started.sh[tag=watch-zk-rollout] === HDFS @@ -32,7 +32,7 @@ An HDFS cluster has three components: the `namenode`, the `datanode` and the `jo [source,yaml] ---- -include::example$code/hdfs.yaml[] +include::example$getting_started/hdfs.yaml[] ---- Where: @@ -47,13 +47,13 @@ It should generally be safe to simply use the latest image version that is avail Create the actual HDFS cluster by applying the file: ---- -include::example$code/getting_started.sh[tag=install-hdfs] +include::example$getting_started/getting_started.sh[tag=install-hdfs] ---- Track the progress with `kubectl` as this step may take a few minutes: [source] -include::example$code/getting_started.sh[tag=watch-hdfs-rollout] +include::example$getting_started/getting_started.sh[tag=watch-hdfs-rollout] === HBase @@ -61,7 +61,7 @@ You can now create the HBase cluster. Create a file called `hbase.yaml` containi [source,yaml] ---- -include::example$code/hbase.yaml[] +include::example$getting_started/hbase.yaml[] ---- == Verify that it works @@ -71,7 +71,7 @@ To test the cluster you will use the REST API to check its version and status, a First, check the cluster version with this callout: [source] -include::example$code/getting_started.sh[tag=cluster-version] +include::example$getting_started/getting_started.sh[tag=cluster-version] This will return the version that was specified in the HBase cluster definition: @@ -81,7 +81,7 @@ This will return the version that was specified in the HBase cluster definition: The cluster status can be checked and formatted like this: [source] -include::example$code/getting_started.sh[tag=cluster-status] +include::example$getting_started/getting_started.sh[tag=cluster-status] which will display cluster metadata that looks like this (only the first region is included for the sake of readability): @@ -123,12 +123,12 @@ which will display cluster metadata that looks like this (only the first region You can now create a table like this: [source] -include::example$code/getting_started.sh[tag=create-table] +include::example$getting_started/getting_started.sh[tag=create-table] This will create a table `users` with a single column family `cf`. Its creation can be verified by listing it: [source] -include::example$code/getting_started.sh[tag=get-table] +include::example$getting_started/getting_started.sh[tag=get-table] [source,json] { @@ -142,7 +142,7 @@ include::example$code/getting_started.sh[tag=get-table] An alternative way to interact with HBase is to use the https://phoenix.apache.org/index.html[Phoenix] library that is pre-installed on the Stackable HBase image (in the /stackable/phoenix directory). Use the python utility `psql.py` (found in /stackable/phoenix/bin) to create, populate and query a table called `WEB_STAT`: [source] -include::example$code/getting_started.sh[tag=phoenix-table] +include::example$getting_started/getting_started.sh[tag=phoenix-table] The final command will display some grouped data like this: @@ -156,7 +156,7 @@ Time: 0.017 sec(s) Check the tables again with: [source] -include::example$code/getting_started.sh[tag=get-table] +include::example$getting_started/getting_started.sh[tag=get-table] This time the list includes not just `users` (created above with the REST API) and `WEB_STAT`, but several other tables too: @@ -200,4 +200,4 @@ This is because Phoenix requires these `SYSTEM.` tables for its own internal map == What's next -Look at the xref:ROOT:usage.adoc[Usage page] to find out more about configuring your HBase cluster. \ No newline at end of file +Look at the xref:usage.adoc[Usage page] to find out more about configuring your HBase cluster. \ No newline at end of file diff --git a/docs/modules/getting_started/pages/index.adoc b/docs/modules/hbase/pages/getting_started/index.adoc similarity index 79% rename from docs/modules/getting_started/pages/index.adoc rename to docs/modules/hbase/pages/getting_started/index.adoc index a27b293a..a6df8b15 100644 --- a/docs/modules/getting_started/pages/index.adoc +++ b/docs/modules/hbase/pages/getting_started/index.adoc @@ -20,5 +20,5 @@ Resource sizing depends on cluster type(s), usage and scope, but as a starting p The Guide is divided into two steps: -* xref:installation.adoc[Installing the Operators]. -* xref:first_steps.adoc[Setting up the HBase cluster and verifying it works]. +* xref:getting_started/installation.adoc[Installing the Operators]. +* xref:getting_started/first_steps.adoc[Setting up the HBase cluster and verifying it works]. diff --git a/docs/modules/getting_started/pages/installation.adoc b/docs/modules/hbase/pages/getting_started/installation.adoc similarity index 74% rename from docs/modules/getting_started/pages/installation.adoc rename to docs/modules/hbase/pages/getting_started/installation.adoc index 32462d03..414785b8 100644 --- a/docs/modules/getting_started/pages/installation.adoc +++ b/docs/modules/hbase/pages/getting_started/installation.adoc @@ -19,13 +19,13 @@ After you have installed stackablectl run the following command to install all o [source,bash] ---- -include::example$code/getting_started.sh[tag=stackablectl-install-operators] +include::example$getting_started/getting_started.sh[tag=stackablectl-install-operators] ---- The tool will show [source] -include::example$code/install_output.txt[] +include::example$getting_started/install_output.txt[] TIP: Consult the xref:stackablectl::quickstart.adoc[] to learn more about how to use stackablectl. For example, you can use the `-k` flag to create a Kubernetes cluster with link:https://kind.sigs.k8s.io/[kind]. @@ -35,17 +35,17 @@ TIP: Consult the xref:stackablectl::quickstart.adoc[] to learn more about how to You can also use Helm to install the operators. Add the Stackable Helm repository: [source,bash] ---- -include::example$code/getting_started.sh[tag=helm-add-repo] +include::example$getting_started/getting_started.sh[tag=helm-add-repo] ---- Then install the Stackable Operators: [source,bash] ---- -include::example$code/getting_started.sh[tag=helm-install-operators] +include::example$getting_started/getting_started.sh[tag=helm-install-operators] ---- Helm will deploy the operators in a Kubernetes Deployment and apply the CRDs for the HBase cluster (as well as the CRDs for the required operators). You are now ready to deploy HBase in Kubernetes. == What's next -xref:first_steps.adoc[Set up an HBase cluster] and its dependencies and xref:first_steps.adoc#_verify_that_it_works[verify that it works]. \ No newline at end of file +xref:getting_started/first_steps.adoc[Set up an HBase 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 diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/hbase/pages/index.adoc similarity index 100% rename from docs/modules/ROOT/pages/index.adoc rename to docs/modules/hbase/pages/index.adoc diff --git a/docs/modules/ROOT/pages/usage.adoc b/docs/modules/hbase/pages/usage.adoc similarity index 100% rename from docs/modules/ROOT/pages/usage.adoc rename to docs/modules/hbase/pages/usage.adoc diff --git a/docs/modules/hbase/partials/nav.adoc b/docs/modules/hbase/partials/nav.adoc new file mode 100644 index 00000000..e4ed12e1 --- /dev/null +++ b/docs/modules/hbase/partials/nav.adoc @@ -0,0 +1,6 @@ +* xref:hbase:getting_started/index.adoc[] +** xref:hbase:getting_started/installation.adoc[] +** xref:hbase:getting_started/first_steps.adoc[] +* xref:hbase:configuration.adoc[] +* xref:hbase:usage.adoc[] +* xref:hbase:discovery.adoc[] diff --git a/docs/modules/ROOT/partials/supported-versions.adoc b/docs/modules/hbase/partials/supported-versions.adoc similarity index 100% rename from docs/modules/ROOT/partials/supported-versions.adoc rename to docs/modules/hbase/partials/supported-versions.adoc From 6e60df29ffa710280f66745f2bb8508ef8fd693e Mon Sep 17 00:00:00 2001 From: Felix Hennig Date: Tue, 14 Feb 2023 12:36:52 +0100 Subject: [PATCH 4/7] Fixed a docs warning --- docs/modules/hbase/pages/getting_started/installation.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/hbase/pages/getting_started/installation.adoc b/docs/modules/hbase/pages/getting_started/installation.adoc index 414785b8..4e0e3b42 100644 --- a/docs/modules/hbase/pages/getting_started/installation.adoc +++ b/docs/modules/hbase/pages/getting_started/installation.adoc @@ -8,7 +8,7 @@ There are 2 ways to run Stackable operators 1. Using xref:stackablectl::index.adoc[] -1. Using Helm +2. Using Helm === stackablectl From 99bde361e2236ef1a85a9fbdb43e436acd868aa1 Mon Sep 17 00:00:00 2001 From: Techassi Date: Thu, 21 Sep 2023 11:32:34 +0200 Subject: [PATCH 5/7] Initial commit (#397) --- .../pages/getting_started/installation.adoc | 21 +++++++++++-------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/docs/modules/hbase/pages/getting_started/installation.adoc b/docs/modules/hbase/pages/getting_started/installation.adoc index 4e0e3b42..f9b93cfe 100644 --- a/docs/modules/hbase/pages/getting_started/installation.adoc +++ b/docs/modules/hbase/pages/getting_started/installation.adoc @@ -1,19 +1,19 @@ = Installation -On this page you will install the Stackable HBase operator and its dependencies, the ZooKeeper and HDFS operators, as well as the commons and secret operators which are required by all Stackable operators. +On this page you will install the Stackable HBase operator and its dependencies, the ZooKeeper and HDFS operators, as +well as the commons and secret operators which are required by all Stackable operators. == Stackable Operators There are 2 ways to run Stackable operators -1. Using xref:stackablectl::index.adoc[] - -2. Using Helm +. Using xref:management:stackablectl:index.adoc[] +. Using Helm === stackablectl -stackablectl is the command line tool to interact with Stackable operators and our recommended way to install operators. -Follow the xref:stackablectl::installation.adoc[installation steps] for your platform. +`stackablectl` is the command line tool to interact with Stackable operators and our recommended way to install +operators. Follow the xref:management:stackablectl:installation.adoc[installation steps] for your platform. After you have installed stackablectl run the following command to install all operators necessary for the HBase cluster: @@ -28,7 +28,8 @@ The tool will show include::example$getting_started/install_output.txt[] -TIP: Consult the xref:stackablectl::quickstart.adoc[] to learn more about how to use stackablectl. For example, you can use the `-k` flag to create a Kubernetes cluster with link:https://kind.sigs.k8s.io/[kind]. +TIP: Consult the xref:management:stackablectl:quickstart.adoc[] to learn more about how to use `stackablectl`. For +example, you can use the `--cluster kind` flag to create a Kubernetes cluster with link:https://kind.sigs.k8s.io/[kind]. === Helm @@ -44,8 +45,10 @@ Then install the Stackable Operators: include::example$getting_started/getting_started.sh[tag=helm-install-operators] ---- -Helm will deploy the operators in a Kubernetes Deployment and apply the CRDs for the HBase cluster (as well as the CRDs for the required operators). You are now ready to deploy HBase in Kubernetes. +Helm will deploy the operators in a Kubernetes Deployment and apply the CRDs for the HBase cluster (as well as the CRDs +for the required operators). You are now ready to deploy HBase in Kubernetes. == What's next -xref:getting_started/first_steps.adoc[Set up an HBase 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[Set up an HBase 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 From 87c4c785903fdf9c59dd0c6ab6e78cd42c7494cb Mon Sep 17 00:00:00 2001 From: Lars Francke Date: Thu, 1 Aug 2024 15:14:36 +0200 Subject: [PATCH 6/7] docs: remove home module from refs (stackabletech/documentation#637) (#540) --- docs/modules/hbase/pages/usage.adoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/modules/hbase/pages/usage.adoc b/docs/modules/hbase/pages/usage.adoc index d8ecdbf7..52a08382 100644 --- a/docs/modules/hbase/pages/usage.adoc +++ b/docs/modules/hbase/pages/usage.adoc @@ -61,7 +61,7 @@ It should generally be safe to simply use the latest image version that is avail == Monitoring The managed HBase instances are automatically configured to export Prometheus metrics. See -xref:home:operators:monitoring.adoc[] for more details. +xref:operators:monitoring.adoc[] for more details. == Log aggregation @@ -87,7 +87,7 @@ spec: ---- Further information on how to configure logging, can be found in -xref:home:concepts:logging.adoc[]. +xref:concepts:logging.adoc[]. == Configuration Overrides @@ -154,7 +154,7 @@ The HBase Operator currently does not support any https://kubernetes.io/docs/con // The "nightly" version is needed because the "include" directive searches for // files in the "stable" version by default. // TODO: remove the "nightly" version after the next platform release (current: 22.09) -include::home:concepts:stackable_resource_requests.adoc[] +include::concepts:stackable_resource_requests.adoc[] If no resources are configured explicitly, the HBase operator uses following defaults: From f1a5c1d21e65d9c0ac824b5ca85ed83eb1b37f8f Mon Sep 17 00:00:00 2001 From: xeniape Date: Mon, 4 May 2026 17:05:09 +0200 Subject: [PATCH 7/7] fix: Fix broken link --- docs/modules/hbase/pages/usage.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/hbase/pages/usage.adoc b/docs/modules/hbase/pages/usage.adoc index 52a08382..a4eff6e5 100644 --- a/docs/modules/hbase/pages/usage.adoc +++ b/docs/modules/hbase/pages/usage.adoc @@ -3,7 +3,7 @@ == Requirements A distributed Apache HBase installation depends on a running Apache ZooKeeper and HDFS cluster. See -the documentation for the https://docs.stackable.tech/hdfs/usage.html[Stackable Operator for Apache HDFS] +the documentation for the xref:hdfs:getting_started/first_steps.adoc[Stackable Operator for Apache HDFS] how to set up these clusters. == Deployment of an Apache HBase cluster