Skip to content

Commit

Permalink
docs: Update references (#372)
Browse files Browse the repository at this point in the history
* Initial commit

* Update xrefs

* Update xref
  • Loading branch information
Techassi committed Sep 21, 2023
1 parent d4e9106 commit c8c655e
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 14 deletions.
13 changes: 8 additions & 5 deletions docs/modules/hive/pages/getting_started/first_steps.adoc
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
= First steps

After going through the xref:getting_started/installation.adoc[] section and having installed all the operators, you will now deploy a Hive metastore cluster and it's dependencies. Afterwards you can <<_verify_that_it_works, verify that it works>>.
After going through the xref:getting_started/installation.adoc[] section and having installed all the operators, you
will now deploy a Hive metastore cluster and it's dependencies. Afterwards you can
<<_verify_that_it_works, verify that it works>>.

== Setup

Several requirements should have already been installed in the xref:getting_started/installation.adoc[Installation guide]:

* xref:commons-operator::index.adoc[Commons Operator]
* xref:secret-operator::index.adoc[Secret Operator]
* xref:hive::index.adoc[Hive Operator]
* xref:commons-operator:index.adoc[Commons Operator]
* xref:secret-operator:index.adoc[Secret Operator]
* xref:hive:index.adoc[Hive Operator]
* PostgreSQL
* MinIO for S3

Expand Down Expand Up @@ -68,7 +70,8 @@ NAME READY AGE
hive-postgres-s3-metastore-default 1/1 48s
----

For further testing we recommend to use e.g. the python https://github.com/quintoandar/hive-metastore-client[hive-metastore-client] in order to e.g. create tables or connect a product like Trino via the xref:trino::index.adoc[Stackable Trino Operator].
For further testing we recommend to use e.g. the python https://github.com/quintoandar/hive-metastore-client[hive-metastore-client]
in order to e.g. create tables or connect a product like Trino via the xref:trino:index.adoc[Stackable Trino Operator].

== What's next

Expand Down
25 changes: 16 additions & 9 deletions docs/modules/hive/pages/getting_started/installation.adoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
= Installation

On this page you will install the Stackable Operator for Apache Hive and all required dependencies. For the installation of the dependencies and operators you can use Helm or stackablectl.
On this page you will install the Stackable Operator for Apache Hive and all required dependencies. For the installation
of the dependencies and operators you can use Helm or `stackablectl`.

The stackablectl command line tool is the recommended way to interact with operators and dependencies. Follow the xref:stackablectl::installation.adoc[installation steps] for your platform if you choose to work with stackablectl.
The `stackablectl` command line tool is the recommended way to interact with operators and dependencies. Follow the
xref:management:stackablectl:installation.adoc[installation steps] for your platform if you choose to work with
`stackablectl`.

== Dependencies

Expand All @@ -15,7 +18,9 @@ There are two ways to install the dependencies:

=== stackablectl

stackablectl was designed to install Stackable components, but its xref:stackablectl::commands/stack.adoc[Stacks] feature can also be used to install arbitrary Helm Charts. You can install MinIO and PostgreSQL using the Stacks feature as follows, but a simpler method via Helm is shown <<Helm, below>>.
`stackablectl` was designed to install Stackable components, but its xref:management:stackablectl:commands/stack.adoc[Stacks]
feature can also be used to install arbitrary Helm Charts. You can install MinIO and PostgreSQL using the Stacks feature
as follows, but a simpler method via Helm is shown <<Helm, below>>.

[source,bash]
----
Expand Down Expand Up @@ -52,16 +57,17 @@ include::example$getting_started/release.yaml[]

The release definition already references the required operators for this Getting Started guide.

Now call stackablectl and reference those two files:
Now call `stackablectl` and reference those two files:

[source,bash]
----
include::example$getting_started/getting_started.sh[tag=stackablectl-install-minio-postgres-stack]
----

This will install MinIO and PostgreSQL as defined in the Stacks, as well as the Operators. You can now skip the <<Stackable Operators>> step that follows next.
This will install MinIO and PostgreSQL as defined in the Stacks, as well as the Operators. You can now skip the
<<Stackable Operators>> step that follows next.

TIP: Consult the xref:stackablectl::quickstart.adoc[Quickstart] to learn more about how to use stackablectl.
TIP: Consult the xref:management:stackablectl:quickstart.adoc[Quickstart] to learn more about how to use `stackablectl`.

=== Helm

Expand All @@ -87,8 +93,8 @@ After the dependencies are deployed, you can start to install the operators.

There are 2 ways to run Stackable Operators:

1. Using xref:stackablectl::index.adoc[stackablectl]
2. Using Helm
. Using xref:management:stackablectl:index.adoc[stackablectl]
. Using Helm

=== stackablectl

Expand Down Expand Up @@ -124,7 +130,8 @@ 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 Apache Hive service (as well as the CRDs for the required operators). You are now ready to deploy the Apache Hive metastore in Kubernetes.
Helm will deploy the operators in a Kubernetes Deployment and apply the CRDs for the Apache Hive service (as well as the
CRDs for the required operators). You are now ready to deploy the Apache Hive metastore in Kubernetes.

== What's next

Expand Down

0 comments on commit c8c655e

Please sign in to comment.