Skip to content

Commit 3fbc860

Browse files
TechassiFelix Hennig
authored andcommitted
docs: Update references (#476)
* Initial commit * Update xrefs
1 parent a2c08f2 commit 3fbc860

2 files changed

Lines changed: 21 additions & 19 deletions

File tree

docs/modules/trino/pages/getting_started/installation.adoc

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,22 @@
11
= Installation
22

3-
On this page you will install the Stackable Operator for Trino as well as the commons and secret operator which are required by all Stackable Operators.
3+
On this page you will install the Stackable Operator for Trino as well as the commons and secret operator which are
4+
required by all Stackable Operators.
45

56
== Stackable Operators
67

78
There are two ways to install Stackable Operators:
89

9-
1. Using xref:stackablectl::index.adoc[stackablectl]
10-
11-
2. Using Helm
10+
. Using xref:management:stackablectl:index.adoc[stackablectl]
11+
. Using Helm
1212

1313
=== stackablectl
1414

15-
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.
15+
The `stackablectl` command line tool is the recommended way to interact with operators and dependencies. Follow the
16+
xref:management:stackablectl:installation.adoc[installation steps] for your platform if you choose to work with
17+
`stackablectl`.
1618

17-
After you have installed stackablectl, run the following command to install all operators necessary for Trino:
19+
After you have installed `stackablectl`, run the following command to install all operators necessary for Trino:
1820

1921
[source,bash]
2022
----
@@ -28,7 +30,7 @@ The tool will show
2830
include::example$getting_started/code/install-operator-output.txt[tag=stackablectl-install-operators-output]
2931
----
3032

31-
TIP: Consult the xref:stackablectl::quickstart.adoc[] to learn more about how to use stackablectl.
33+
TIP: Consult the xref:management:stackablectl:quickstart.adoc[] to learn more about how to use `stackablectl`.
3234

3335
=== Helm
3436

@@ -46,37 +48,36 @@ Then install the Stackable Operators:
4648
include::example$getting_started/code/getting-started.sh[tag=helm-install-operators]
4749
----
4850

49-
Helm will deploy the operators in a Kubernetes Deployment and apply the CRDs for the Trino service (as well as the CRDs for the required operators). You are now ready to deploy Trino in Kubernetes.
51+
Helm will deploy the operators in a Kubernetes Deployment and apply the CRDs for the Trino service (as well as the CRDs
52+
for the required operators). You are now ready to deploy Trino in Kubernetes.
5053

5154
== Optional installation steps
5255

53-
Some Trino connectors like `hive` or `iceberg` work together with the Apache Hive metastore and S3 buckets.
54-
For these components extra steps are required.
56+
Some Trino connectors like `hive` or `iceberg` work together with the Apache Hive metastore and S3 buckets. For these
57+
components extra steps are required.
5558

5659
* a Stackable Hive metastore
5760
* an accessible S3 bucket
5861
** an end-point, and access- and secret-keys
5962
** data in the bucket (we use the https://archive.ics.uci.edu/ml/datasets/iris[Iris] dataset here)
6063
* the following are optional
61-
** a Stackable xref:secret-operator::index.adoc[Secret Operator] for certificates when deploying for TLS
62-
** a Stackable xref:commons-operator::index.adoc[Commons Operator] for certificates when deploying for TLS authentication
63-
** (for authorization): a Stackable xref:opa::index.adoc[OPA Operator][OPA-Operator]
64-
** the https://repo.stackable.tech/#browse/browse:packages:trino-cli%2Ftrino-cli-363-executable.jar[Trino CLI] to test SQL queries
64+
** a Stackable xref:secret-operator:index.adoc[Secret Operator] for certificates when deploying for TLS
65+
** a Stackable xref:commons-operator:index.adoc[Commons Operator] for certificates when deploying for TLS authentication
66+
** (for authorization): a Stackable xref:opa:index.adoc[OPA Operator][OPA-Operator]
67+
** the https://repo.stackable.tech/#browse/browse:packages:trino-cli%2Ftrino-cli-363-executable.jar[Trino CLI] to test
68+
SQL queries
6569

6670
=== S3 bucket
6771

6872
Please refer to the S3 provider.
6973

7074
=== Hive operator
7175

72-
Please refer to the xref:hive::index.adoc[Hive Operator] docs.
73-
74-
Both Hive and Trino need the same S3 authentication.
76+
Please refer to the xref:hive:index.adoc[Hive Operator] docs. Both Hive and Trino need the same S3 authentication.
7577

7678
=== OPA operator
7779

78-
Please refer to the xref:opa::index.adoc[OPA Operator] docs.
79-
80+
Please refer to the xref:opa:index.adoc[OPA Operator] docs.
8081

8182
== What's next
8283

docs/modules/trino/pages/index.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ This is an operator for Kubernetes that can manage https://https://trino.io/[Tri
44

55
WARNING: This operator only works with images from the https://repo.stackable.tech/#browse/browse:docker:v2%2Fstackable%2Ftrino[Stackable] repository
66

7+
78
== Supported Versions
89

910
The Stackable Operator for Trino currently supports the following versions of Trino:

0 commit comments

Comments
 (0)