Skip to content

Commit

Permalink
Added overrides docs
Browse files Browse the repository at this point in the history
  • Loading branch information
fhennig committed Jan 2, 2024
1 parent f6b6290 commit aea5cf0
Show file tree
Hide file tree
Showing 3 changed files with 66 additions and 13 deletions.
15 changes: 2 additions & 13 deletions docs/modules/trino/pages/usage-guide/index.adoc
Original file line number Diff line number Diff line change
@@ -1,15 +1,4 @@
= Usage guide

This section will help you to use the Trino Stackable Operator. It will show you how to set up a Trino cluster in different ways and to test it with Hive and S3.

== Guides

The following guides are available here:

* 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[]
* xref:usage-guide/log_aggregation.adoc[]
* xref:usage-guide/query.adoc[]
This section will help you to use the Trino Stackable Operator.
It will show you how to set up a Trino cluster in different ways and to test it with Hive and S3.
63 changes: 63 additions & 0 deletions docs/modules/trino/pages/usage-guide/overrides.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
= Configuration, environment & Pod overrides

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].

WARNING: Overriding some settings like port numbers can cause your cluster to malfunction!

== Configuration overrides

Trino configuration is stored in several files listed below.
The configuration overrides menchanism allows you to customize parameters in these files;
consult the Trino documentation to find out which settings available.

Confiuration overrides are applied like so:

[source,yaml]
----
...
configOverrides:
config.properties: # <1>
http-server.authentication.oauth2.principal-field: preferred_username # <2>
...
----

<1> The file where you want to override a setting.
<2> The config setting and the value to set it to.

Configuration overrides can be applied to:

* `config.properties`
* `node.properties`

=== Configuration overrides in the TrinoCatalog

The TrinoCatalog also supports configuration overrides:

[source,yaml]
----
...
configOverrides:
hive.s3.upload-acl-type: BUCKET_OWNER_FULL_CONTROL
...
----

Note how you do not need to specify a filename here.


== Environment overrides

Environment variables can be (over)written by adding the `envOverrides` property:

[source,yaml]
----
...
envOverrides:
MY_ENV_VAR: "MY_VALUE"
...
----

== Pod overrides

Pod overrides allow you to specify a PodTemplateSpec.
Consult the xref:concepts:overrides.adoc#pod-overrides[Pod overrides concept documentation] for more information.
1 change: 1 addition & 0 deletions docs/modules/trino/partials/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
** xref:trino:usage-guide/monitoring.adoc[]
** xref:trino:usage-guide/log_aggregation.adoc[]
** xref:trino:usage-guide/query.adoc[]
** xref:trino:usage-guide/overrides.adoc[]
** xref:trino:usage-guide/catalogs/index.adoc[]
*** xref:trino:usage-guide/catalogs/black-hole.adoc[]
*** xref:trino:usage-guide/catalogs/generic.adoc[]
Expand Down

0 comments on commit aea5cf0

Please sign in to comment.