Skip to content

Commit a437ecb

Browse files
authored
fix(docs): Add required TLS and fix stale fields in S3 examples (#919)
* fix(docs): Add required TLS and fix stale fields in S3 examples * fix(docs): focus tls remark
1 parent f3a77b7 commit a437ecb

4 files changed

Lines changed: 50 additions & 13 deletions

File tree

docs/modules/trino/pages/usage-guide/catalogs/delta-lake.adoc

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
= Delta Lake
22

3-
[Delta Lake](https://delta.io/) is an open-source storage framework that enables building a Lakehouse architecture with support for multiple compute engines.
3+
https://delta.io/[Delta Lake] is an open-source storage framework that enables building a Lakehouse architecture with support for multiple compute engines.
44
It depends on a Hive metastore being present and makes use of the same metastore ConfigMap used by the Hive connector.
55

66
== Example Delta Lake catalog configuration
@@ -27,8 +27,16 @@ spec:
2727
accessStyle: Path
2828
credentials:
2929
secretClass: minio-credentials
30+
# TLS is required for S3 connections, see the note below
31+
tls:
32+
verification:
33+
server:
34+
caCert:
35+
secretClass: minio-tls-certificates
3036
----
3137

38+
IMPORTANT: The `tls` section is required, see xref:usage-guide/s3.adoc#tls-required[Connecting Trino to S3].
39+
3240
== Connect to S3 store or HDFS
3341

3442
The Delta Lake connector connects to S3 or HDFS in the same way the xref:usage-guide/catalogs/hive.adoc[] connector does.

docs/modules/trino/pages/usage-guide/catalogs/hive.adoc

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,19 @@ spec:
2626
accessStyle: Path
2727
credentials:
2828
secretClass: minio-credentials
29-
configOverrides: # <4>
29+
tls: # <4>
30+
verification:
31+
server:
32+
caCert:
33+
secretClass: minio-tls-certificates
34+
configOverrides: # <5>
3035
hive.metastore.username: trino
3136
----
3237
<1> The name of the catalog as it will appear in Trino
3338
<2> TrinoCluster can use these labels to select which catalogs to include
3439
<3> The name of your Hive Stacklet
35-
<4> Use `configOverrides` to add arbitrary properties to the Trino catalog configuration
40+
<4> TLS is required for S3 connections, see xref:usage-guide/s3.adoc#tls-required[Connecting Trino to S3]
41+
<5> Use `configOverrides` to add arbitrary properties to the Trino catalog configuration
3642

3743
== Connect to S3 store
3844

@@ -50,11 +56,18 @@ spec:
5056
accessStyle: Path
5157
credentials:
5258
secretClass: minio-credentials
59+
tls:
60+
verification:
61+
server:
62+
caCert:
63+
secretClass: minio-tls-certificates
5364
# OR
5465
s3:
5566
reference: my-minio
5667
----
5768

69+
IMPORTANT: The `tls` section is required, see xref:usage-guide/s3.adoc#tls-required[Connecting Trino to S3].
70+
5871
See xref:concepts:s3.adoc[] for details about S3 connections.
5972

6073
IMPORTANT: Make sure that the underlying Hive metastore also has access to the S3 store, because it will e.g. check if the directory exists when creating tables.

docs/modules/trino/pages/usage-guide/catalogs/iceberg.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,15 @@ spec:
2828
accessStyle: Path
2929
credentials:
3030
secretClass: minio-credentials
31+
tls: # <3>
32+
verification:
33+
server:
34+
caCert:
35+
secretClass: minio-tls-certificates
3136
----
3237
<1> The name of the catalog as it will appear in Trino
3338
<2> This is the name of your Hive Stacklet
39+
<3> TLS is required for S3 connections, see xref:usage-guide/s3.adoc#tls-required[Connecting Trino to S3]
3440

3541
== Connect to S3 store or HDFS
3642
The Iceberg connector can connect to S3 or HDFS in the same way the xref:usage-guide/catalogs/hive.adoc[] connector does.

docs/modules/trino/pages/usage-guide/s3.adoc

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,10 @@
22
:description: Configure S3 connections in Trino either inline within the TrinoCatalog or via an external S3Connection resource for centralized management.
33

44
You can specify S3 connection details directly inside the TrinoCatalog specification or by referring to an external S3Connection custom resource.
5-
This mechanism used used across the whole Stackable Data Platform, read the xref:concepts:s3.adoc[S3 concepts page] to learn more.
5+
This mechanism is used across the whole Stackable Data Platform, read the xref:concepts:s3.adoc[S3 concepts page] to learn more.
6+
7+
[#tls-required]
8+
IMPORTANT: Every S3 connection must contain a `tls` section, because Trino uses the native S3 client, which requires TLS.
69

710
== Inline
811

@@ -14,22 +17,24 @@ s3: # <1>
1417
inline:
1518
host: test-minio # <2>
1619
port: 9000 # <3>
17-
pathStyleAccess: true # <4>
18-
secretClass: minio-credentials # <5>
19-
tls:
20+
accessStyle: Path # <4>
21+
credentials:
22+
secretClass: minio-credentials # <5>
23+
tls: # <6>
2024
verification:
2125
server:
2226
caCert:
23-
secretClass: minio-tls-certificates #<6>
27+
secretClass: minio-tls-certificates
2428
----
2529
<1> Entry point for the connection configuration
2630
<2> Connection host
2731
<3> Optional connection port
28-
<4> Optional flag if path-style URLs should be used; This defaults to `false`
29-
which means virtual hosted-style URLs are used.
30-
<5> Name of the Secret object expected to contain the following keys:
31-
`accessKey` and `secretKey`
32-
<6> Optional TLS settings for encrypted traffic. The `secretClass` can be provided by the Secret Operator or yourself.
32+
<4> Optional access style, either `Path` or `VirtualHosted`; This defaults to
33+
`VirtualHosted`, which means virtual hosted-style URLs are used.
34+
<5> Name of the SecretClass providing the credentials. The Secret behind it is expected
35+
to contain the following keys: `accessKey` and `secretKey`
36+
<6> TLS settings for encrypted traffic. The `secretClass` can be provided by the Secret Operator or yourself.
37+
This section is required, see <<tls-required,the note above>>.
3338

3439
A self provided S3 TLS secret can be specified like this:
3540

@@ -84,6 +89,11 @@ spec:
8489
accessStyle: Path
8590
credentials:
8691
secretClass: minio-credentials
92+
tls:
93+
verification:
94+
server:
95+
caCert:
96+
secretClass: minio-tls-certificates
8797
----
8898

8999
This has the advantage that the connection configuration is configured in a single place and can be shared across applications, reducing the cost of updating these details.

0 commit comments

Comments
 (0)