Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Command line parameters
:description: Command-line parameters the Stackable operator for Trino accepts, with their default values and usage examples.

This operator accepts the following command line parameters:

Expand Down
1 change: 1 addition & 0 deletions docs/modules/trino/pages/reference/crds.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
= CRD Reference
:description: CRD reference for the Stackable operator for Trino on the Stackable Hub, covering every field, default and API version.

Find all CRD reference for the Stackable Operator for Trino at: {crd-ref}{crd-ref-release}&operator=trino-operator.
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Environment variables
:description: Environment variables the Stackable operator for Trino accepts, with their default values and what each one controls.

This operator accepts the following environment variables:

Expand Down
1 change: 1 addition & 0 deletions docs/modules/trino/pages/reference/index.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Reference
:description: Reference for the Stackable operator for Trino, covering CRD fields, command-line parameters and environment variables.

Consult the reference documentation section to find exhaustive information on:

Expand Down
1 change: 1 addition & 0 deletions docs/modules/trino/pages/reference/security.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Security
:description: Reference for Trino security settings in the TrinoCluster resource, such as OPA authorization with column masking and the properties it sets.

== Authorization

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Black Hole
:description: Trino catalogs for the Black Hole connector, which discards written data and returns empty reads, for testing the performance of other components.

Primarily the https://trino.io/docs/current/connector/blackhole.html[Black Hole connector] is designed for high performance testing of other components.
It works like the `/dev/null` device on Unix-like operating systems for data writing and like `/dev/null` or `/dev/zero` for data reading.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Delta Lake
:description: Trino catalogs for Delta Lake tables, backed by a Hive metastore and stored in S3 or HDFS, with the Stackable operator for Trino.

https://delta.io/[Delta Lake] is an open-source storage framework that enables building a Lakehouse architecture with support for multiple compute engines.
It depends on a Hive metastore being present and makes use of the same metastore ConfigMap used by the Hive connector.
Expand Down
1 change: 1 addition & 0 deletions docs/modules/trino/pages/usage-guide/catalogs/generic.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Generic
:description: Generic Trino catalogs for any connector Trino supports, including PostgreSQL, with properties taken from Secrets and ConfigMaps.
:trino-connector: https://trino.io/docs/current/connector.html
:trino-psql-connector: https://trino.io/docs/current/connector/postgresql.html

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Google sheets
:description: Trino catalogs for Google Sheets, covering the service account credentials the connector uses to read spreadsheets through the Google APIs.
:trino-google-sheets-connector: https://trino.io/docs/current/connector/googlesheets.html

With this connector Trino can connect to Google Sheets.
Expand Down
1 change: 1 addition & 0 deletions docs/modules/trino/pages/usage-guide/catalogs/hive.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Apache Hive
:description: Trino catalogs for Apache Hive, covering data in S3 or HDFS through a Hive metastore, including Hive clusters not managed by Stackable.

The Apache Hive connector allows Trino to connect to a Hive metastore and query data stored in Apache Hadoop or S3 compatible objects storage.

Expand Down
1 change: 1 addition & 0 deletions docs/modules/trino/pages/usage-guide/catalogs/iceberg.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Apache Iceberg
:description: Trino catalogs for Apache Iceberg tables, backed by a Hive metastore and stored in S3 or HDFS, with the Stackable operator for Trino.

Apache Iceberg is a format for huge analytic tables designed to address some of the scaling issues with traditional Hive tables.
Iceberg depends on a Hive metastore being present and makes use of the same metastore ConfigMap used by the Hive connector.
Expand Down
1 change: 1 addition & 0 deletions docs/modules/trino/pages/usage-guide/catalogs/index.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Catalogs
:description: Trino catalogs as TrinoCatalog resources, covering how catalogs are created, added to clusters, overridden and used with generic connectors.

Trino does not have a built-in catalog and instead provides connectors to external data sources.
This allows Trino to connect to, read from and join a wide variety of data sources.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= PostgreSQL
:description: Trino catalogs for PostgreSQL, covering queries against tables in a PostgreSQL database with credentials taken from a Kubernetes Secret.

The https://trino.io/docs/current/connector/postgresql.html[PostgreSQL connector] provides connectivity to a PostgreSQL databases.

Expand Down
1 change: 1 addition & 0 deletions docs/modules/trino/pages/usage-guide/catalogs/tpcds.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= TPC-DS
:description: Trino catalogs for the TPC-DS connector, which generates the TPC-DS benchmark data set at query time without storing any data.

The https://trino.io/docs/current/connector/tpcds.html[TPC-DS connector] provides a data source for the TCP-DS benchmark data set.
This is not a stored data set and is instead a virtual data set generated at query time using a deterministic algorithm.
Expand Down
1 change: 1 addition & 0 deletions docs/modules/trino/pages/usage-guide/catalogs/tpch.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= TPC-H
:description: Trino catalogs for the TPC-H connector, which generates the TPC-H benchmark data set at query time without storing any data.

The https://trino.io/docs/current/connector/tpch.html[TPC-H connector] provides a data source for the TCP-H benchmark data set.
This is not a stored data set and is instead a virtual data set generated at query time using a deterministic algorithm.
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/trino/pages/usage-guide/configuration.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ Here too, overriding properties such as `http-server.https.port` will lead to br

== Resource Requests

include::home:concepts:stackable_resource_requests.adoc[]
include::concepts:partial$stackable_resource_requests.adoc[]

A minimal HA setup consisting of 1 coordinator and 2 worker instances has the following https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/[resource requirements]:

Expand Down
1 change: 1 addition & 0 deletions docs/modules/trino/pages/usage-guide/index.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Usage guide
:description: Guides for the Stackable operator for Trino, covering different ways to set up Trino clusters and testing them with Apache Hive and S3 storage.

This section helps you to use the Trino Stackable operator.
It shows you how to set up a Trino cluster in different ways and to test it with Hive and S3.
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@

= Cluster Operation
:description: Cluster operations for Trino, covering how to pause reconciliation of a cluster or stop it entirely through its TrinoCluster resource.

Trino installations can be configured with different cluster operations like pausing reconciliation or stopping the cluster. See xref:concepts:operations/cluster_operations.adoc[cluster operations] for more details.
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Graceful shutdown
:description: Graceful shutdown of Trino coordinators and workers, covering how running queries finish and why it requires OPA authorization.

You can configure the graceful shutdown as described in xref:concepts:operations/graceful_shutdown.adoc[].

Expand Down
1 change: 1 addition & 0 deletions docs/modules/trino/pages/usage-guide/operations/index.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Operations
:description: Operating Trino with the Stackable operator, covering graceful shutdown, Pod disruptions, Pod placement and cluster operations.

This section of the documentation is intended for the operations teams that maintain a Stackable Data Platform installation.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Allowed Pod disruptions
:description: PodDisruptionBudgets for Trino coordinators and workers, and how to shorten rolling redeployments of clusters with many workers.

You can configure the permitted Pod disruptions for Trino nodes as described in xref:concepts:operations/pod_disruptions.adoc[].

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Pod placement
:description: Pod placement for Trino, covering default affinities that keep coordinators and workers together and spread each role across nodes.

You can configure the Pod placement of the Trino pods as described in xref:concepts:operations/pod_placement.adoc[].

Expand Down
1 change: 1 addition & 0 deletions docs/modules/trino/pages/usage-guide/overrides.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Configuration, environment & Pod overrides
:description: Overrides for Trino, covering configuration files, catalog properties, environment variables, Pod specs and JVM arguments per role or role group.

The Stackable Data Platform supports overrides in config files, environment variables and Pod templates.
Read more about overrides on the xref:concepts:overrides.adoc[overrides concepts page].
Expand Down
Loading