diff --git a/docs/modules/trino/pages/reference/commandline-parameters.adoc b/docs/modules/trino/pages/reference/commandline-parameters.adoc index 4e27f328..57e2b485 100644 --- a/docs/modules/trino/pages/reference/commandline-parameters.adoc +++ b/docs/modules/trino/pages/reference/commandline-parameters.adoc @@ -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: diff --git a/docs/modules/trino/pages/reference/crds.adoc b/docs/modules/trino/pages/reference/crds.adoc index 44143f78..fa134033 100644 --- a/docs/modules/trino/pages/reference/crds.adoc +++ b/docs/modules/trino/pages/reference/crds.adoc @@ -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. diff --git a/docs/modules/trino/pages/reference/environment-variables.adoc b/docs/modules/trino/pages/reference/environment-variables.adoc index fddbd1ad..dfcecc41 100644 --- a/docs/modules/trino/pages/reference/environment-variables.adoc +++ b/docs/modules/trino/pages/reference/environment-variables.adoc @@ -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: diff --git a/docs/modules/trino/pages/reference/index.adoc b/docs/modules/trino/pages/reference/index.adoc index 3cfa0289..16cdce13 100644 --- a/docs/modules/trino/pages/reference/index.adoc +++ b/docs/modules/trino/pages/reference/index.adoc @@ -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: diff --git a/docs/modules/trino/pages/reference/security.adoc b/docs/modules/trino/pages/reference/security.adoc index 6e2cf4db..5e868a4d 100644 --- a/docs/modules/trino/pages/reference/security.adoc +++ b/docs/modules/trino/pages/reference/security.adoc @@ -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 diff --git a/docs/modules/trino/pages/usage-guide/catalogs/black-hole.adoc b/docs/modules/trino/pages/usage-guide/catalogs/black-hole.adoc index 8b48ec05..37f5029f 100644 --- a/docs/modules/trino/pages/usage-guide/catalogs/black-hole.adoc +++ b/docs/modules/trino/pages/usage-guide/catalogs/black-hole.adoc @@ -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. diff --git a/docs/modules/trino/pages/usage-guide/catalogs/delta-lake.adoc b/docs/modules/trino/pages/usage-guide/catalogs/delta-lake.adoc index ea1a0cf4..a0432e88 100644 --- a/docs/modules/trino/pages/usage-guide/catalogs/delta-lake.adoc +++ b/docs/modules/trino/pages/usage-guide/catalogs/delta-lake.adoc @@ -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. diff --git a/docs/modules/trino/pages/usage-guide/catalogs/generic.adoc b/docs/modules/trino/pages/usage-guide/catalogs/generic.adoc index 427d0b3a..3e0dee25 100644 --- a/docs/modules/trino/pages/usage-guide/catalogs/generic.adoc +++ b/docs/modules/trino/pages/usage-guide/catalogs/generic.adoc @@ -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 diff --git a/docs/modules/trino/pages/usage-guide/catalogs/google-sheets.adoc b/docs/modules/trino/pages/usage-guide/catalogs/google-sheets.adoc index cb77ca63..4b6a17b5 100644 --- a/docs/modules/trino/pages/usage-guide/catalogs/google-sheets.adoc +++ b/docs/modules/trino/pages/usage-guide/catalogs/google-sheets.adoc @@ -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. diff --git a/docs/modules/trino/pages/usage-guide/catalogs/hive.adoc b/docs/modules/trino/pages/usage-guide/catalogs/hive.adoc index 4581b211..58bcb92c 100644 --- a/docs/modules/trino/pages/usage-guide/catalogs/hive.adoc +++ b/docs/modules/trino/pages/usage-guide/catalogs/hive.adoc @@ -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. diff --git a/docs/modules/trino/pages/usage-guide/catalogs/iceberg.adoc b/docs/modules/trino/pages/usage-guide/catalogs/iceberg.adoc index 4152f2fb..dac94e8b 100644 --- a/docs/modules/trino/pages/usage-guide/catalogs/iceberg.adoc +++ b/docs/modules/trino/pages/usage-guide/catalogs/iceberg.adoc @@ -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. diff --git a/docs/modules/trino/pages/usage-guide/catalogs/index.adoc b/docs/modules/trino/pages/usage-guide/catalogs/index.adoc index 7d1d1c51..374ccf1d 100644 --- a/docs/modules/trino/pages/usage-guide/catalogs/index.adoc +++ b/docs/modules/trino/pages/usage-guide/catalogs/index.adoc @@ -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. diff --git a/docs/modules/trino/pages/usage-guide/catalogs/postgresql.adoc b/docs/modules/trino/pages/usage-guide/catalogs/postgresql.adoc index 18564917..58f4aa6d 100644 --- a/docs/modules/trino/pages/usage-guide/catalogs/postgresql.adoc +++ b/docs/modules/trino/pages/usage-guide/catalogs/postgresql.adoc @@ -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. diff --git a/docs/modules/trino/pages/usage-guide/catalogs/tpcds.adoc b/docs/modules/trino/pages/usage-guide/catalogs/tpcds.adoc index b7623011..e1aca06b 100644 --- a/docs/modules/trino/pages/usage-guide/catalogs/tpcds.adoc +++ b/docs/modules/trino/pages/usage-guide/catalogs/tpcds.adoc @@ -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. diff --git a/docs/modules/trino/pages/usage-guide/catalogs/tpch.adoc b/docs/modules/trino/pages/usage-guide/catalogs/tpch.adoc index 963c9bfd..c8400eba 100644 --- a/docs/modules/trino/pages/usage-guide/catalogs/tpch.adoc +++ b/docs/modules/trino/pages/usage-guide/catalogs/tpch.adoc @@ -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. diff --git a/docs/modules/trino/pages/usage-guide/configuration.adoc b/docs/modules/trino/pages/usage-guide/configuration.adoc index 1ebc6a22..7baff13a 100644 --- a/docs/modules/trino/pages/usage-guide/configuration.adoc +++ b/docs/modules/trino/pages/usage-guide/configuration.adoc @@ -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]: diff --git a/docs/modules/trino/pages/usage-guide/index.adoc b/docs/modules/trino/pages/usage-guide/index.adoc index 8c21f4dc..9c320f89 100644 --- a/docs/modules/trino/pages/usage-guide/index.adoc +++ b/docs/modules/trino/pages/usage-guide/index.adoc @@ -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. diff --git a/docs/modules/trino/pages/usage-guide/operations/cluster-operations.adoc b/docs/modules/trino/pages/usage-guide/operations/cluster-operations.adoc index 91a497cf..9e7bc266 100644 --- a/docs/modules/trino/pages/usage-guide/operations/cluster-operations.adoc +++ b/docs/modules/trino/pages/usage-guide/operations/cluster-operations.adoc @@ -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. diff --git a/docs/modules/trino/pages/usage-guide/operations/graceful-shutdown.adoc b/docs/modules/trino/pages/usage-guide/operations/graceful-shutdown.adoc index a82ada2e..cd6a21fe 100644 --- a/docs/modules/trino/pages/usage-guide/operations/graceful-shutdown.adoc +++ b/docs/modules/trino/pages/usage-guide/operations/graceful-shutdown.adoc @@ -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[]. diff --git a/docs/modules/trino/pages/usage-guide/operations/index.adoc b/docs/modules/trino/pages/usage-guide/operations/index.adoc index dacf0b79..6806fead 100644 --- a/docs/modules/trino/pages/usage-guide/operations/index.adoc +++ b/docs/modules/trino/pages/usage-guide/operations/index.adoc @@ -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. diff --git a/docs/modules/trino/pages/usage-guide/operations/pod-disruptions.adoc b/docs/modules/trino/pages/usage-guide/operations/pod-disruptions.adoc index 0f94fbec..f85f0b4e 100644 --- a/docs/modules/trino/pages/usage-guide/operations/pod-disruptions.adoc +++ b/docs/modules/trino/pages/usage-guide/operations/pod-disruptions.adoc @@ -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[]. diff --git a/docs/modules/trino/pages/usage-guide/operations/pod-placement.adoc b/docs/modules/trino/pages/usage-guide/operations/pod-placement.adoc index 61d32657..041d5005 100644 --- a/docs/modules/trino/pages/usage-guide/operations/pod-placement.adoc +++ b/docs/modules/trino/pages/usage-guide/operations/pod-placement.adoc @@ -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[]. diff --git a/docs/modules/trino/pages/usage-guide/overrides.adoc b/docs/modules/trino/pages/usage-guide/overrides.adoc index 7e48ede9..fc16919e 100644 --- a/docs/modules/trino/pages/usage-guide/overrides.adoc +++ b/docs/modules/trino/pages/usage-guide/overrides.adoc @@ -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].