Skip to content

[Merged by Bors] - Updated docs #411

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 5 commits into from
Closed
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
4 changes: 4 additions & 0 deletions docs/modules/trino/images/.$trino_overview.drawio.svg.bkp

Large diffs are not rendered by default.

4 changes: 4 additions & 0 deletions docs/modules/trino/images/trino_overview.drawio.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 4 additions & 4 deletions docs/modules/trino/pages/concepts.adoc
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
= Concepts

== Connectors
== [[connectors]]Connectors

https://trino.io/docs/current/overview/use-cases.html#what-trino-is[Trino] is a tool designed to efficiently query vast amounts of data using distributed queries. It is not a database with its own store but rather interacts with many types of store. Trino connects to these stores - or data sources - via https://trino.io/docs/current/connector.html[connectors].
Each connector enables access to a specific underlying datasource such as a Hive warehouse, a PostgreSQL database or a Druid instance.
https://trino.io/docs/current/overview/use-cases.html#what-trino-is[Trino] is a tool designed to efficiently query vast amounts of data using distributed queries. It is not a database with its own storage but rather interacts with many different data stores. Trino connects to these data stores - or data sources - via https://trino.io/docs/current/connector.html[connectors].
Each connector enables access to a specific underlying data source such as a Hive warehouse, a PostgreSQL database or a Druid instance.

A Trino cluster comprises two roles: the Coordinator, responsible for managing and monitoring work loads, and the Worker, which is responsible for executing specific tasks that together make up a work load. The workers fetch data from the connectors, execute tasks and share intermediate results. The coordinator collects and consolidates these results for the end-user.

== Catalogs
== [[catalogs]]Catalogs

An instance of a connector is called a catalog.
Think of a setup containing a large Hive warehouse running on HDFS.
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/trino/pages/getting_started/first_steps.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -123,4 +123,4 @@ include::example$getting_started/code/getting_started.sh[tag=cleanup-trino-cli]

== What's next

Have a look at the xref:usage_guide/cluster.adoc[] to find out more about how to configure a Trino cluster.
Have a look at the xref:usage_guide/index.adoc[] to find out more about how to configure a Trino cluster.
40 changes: 32 additions & 8 deletions docs/modules/trino/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -1,18 +1,42 @@
= Stackable Operator for Trino
:description: The Stackable Operator for Trino is a Kubernetes operator that can manage Trino clusters. Learn about its features, resources, dependencies and demos, and see the list of supported Trino versions.
:keywords: Stackable Operator, Trino, Kubernetes, k8s, operator, data science, data exploration, SQL, engineer, big data, CRD, StatefulSet, ConfigMap, Service, Druid, Trino, S3, Superset

This is an operator for Kubernetes that can manage https://https://trino.io/[Trino] clusters.
Trino is an open-source distributed SQL query engine that enables high-speed analytics of large datasets from multiple data sources using SQL queries. This operator enables you to manage your Trino instances on Kubernetes efficiently.

== Getting started

Follow the xref:getting_started/index.adoc[Getting started guide] to start using the Stackable Operator for Trino on your Kubernetes cluster. It will guide you through the installation process and help you run your first Trino queries on Kubernetes.

== Operator model

The Operator manages Kubernetes resources in sync with https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/[custom resources] defined by you, the user.

=== Custom resources

The Trino Operator manages two custom resources: The _TrinoCluster_ and xref:concepts.adoc#catalogs[_TrinoCatalogs_]. The TrinoCluster resource allows for the specification of a Trino cluster. Two xref:concepts:roles-and-role-groups.adoc[roles] are defined: `coordinators` and `workers`.

To connect to data sources the TrinoCatalogs are used. Have a look at the xref:usage_guide/catalogs/index.adoc[catalog overview] to find out which types of data sources are supported by the Stackable platform.

=== Resources

To run the cluster on Kubernetes the Operator creates Kubernetes resources such as ConfigMaps, StatefulSets and Services.

image::trino_overview.drawio.svg[A diagram depicting the Kubernetes resources created by the operator]

== Demos

The xref:stackablectl::demos/trino-taxi-data.adoc[] demo uses Trino together with xref:hive:index.adoc[Apache Hive] to access the prominent New York Taxi dataset. xref:superset:index.adoc[Apache Superset] is then used to read the data from the Trino instance via SQL and visualize it.

The xref:stackablectl::demos/data-lakehouse-iceberg-trino-spark.adoc[] demo showcases a data Lakehouse with multiple datasets. Again Trino is used to enable SQL acces to the data. The xref:stackablectl::demos/trino-iceberg.adoc[] demo is a subset of the Lakehouse demo, focusing just on Apache Iceberg integration.

The xref:stackablectl::demos/spark-k8s-anomaly-detection-taxi-data.adoc[] also uses Trino to enable SQL access to data but also shows xref:opa:index.adoc[OpenPolicyAgent] integration for xref:usage_guide/security.adoc#authorization[authorization].


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

== Supported Versions

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

include::partial$supported-versions.adoc[]

== Get Docker image

[source]
----
docker pull docker.stackable.tech/stackable/trino:<version>
----
221 changes: 0 additions & 221 deletions docs/modules/trino/pages/usage_guide/cluster.adoc

This file was deleted.

2 changes: 1 addition & 1 deletion docs/modules/trino/pages/usage_guide/connect_to_trino.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ An https://trino.io/docs/current/client/jdbc.html[open source JDBC driver] does

Multiple SQL clients can be used to connect to Trino as described below.

== Perquisites
== Prerequisites
The Trino server must be reachable from your local computer.
It is typically secured via HTTPS with a certificated provided by a xref:secret-operator:secretclass.adoc[SecretClass].

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/trino/pages/usage_guide/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ This section will help you to use the Trino Stackable Operator. It will show you

The following guides are available here:

* xref:usage_guide/cluster.adoc[]
* xref:usage_guide/catalogs/index.adoc[]
* xref:usage_guide/s3.adoc[]
* xref:usage_guide/configuration.adoc[]
* xref:usage_guide/security.adoc[]
* xref:usage_guide/monitoring.adoc[]
Expand Down
Loading