Skip to content

Commit 4bb1c6a

Browse files
przemekakhashhar
authored andcommitted
fix artifacthub readme
1 parent 0ea42d6 commit 4bb1c6a

File tree

2 files changed

+69
-43
lines changed

2 files changed

+69
-43
lines changed

README.md

Lines changed: 22 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,26 @@
11

2-
Trino
2+
Trino Community Kubernetes Helm Charts
33
===========
4+
[![Release Trino Chart](https://github.com/trinodb/charts/actions/workflows/release.yaml/badge.svg?branch=main)](https://github.com/trinodb/charts/actions/workflows/release.yaml)
45

5-
Fast distributed SQL query engine for big data analytics
6-
7-
8-
## Configuration
9-
10-
The following table lists the configurable parameters of the Trino chart and their default values.
11-
12-
| Parameter | Description | Default |
13-
| ------------------------ | ----------------------- | -------------- |
14-
| `image.repository` | | `"trinodb/trino"` |
15-
| `image.pullPolicy` | | `"IfNotPresent"` |
16-
| `image.tag` | | `"latest"` |
17-
| `server.workers` | | `2` |
18-
| `server.node.environment` | | `"production"` |
19-
| `server.node.dataDir` | | `"/data/trino"` |
20-
| `server.node.pluginDir` | | `"/usr/lib/trino/plugin"` |
21-
| `server.log.trino.level` | | `"INFO"` |
22-
| `server.config.path` | | `"/etc/trino"` |
23-
| `server.config.http.port` | | `8080` |
24-
| `server.config.query.maxMemory` | | `"4GB"` |
25-
| `server.config.query.maxMemoryPerNode` | | `"1GB"` |
26-
| `server.config.query.maxTotalMemoryPerNode` | | `"2GB"` |
27-
| `server.config.memory.heapHeadroomPerNode` | | `"1GB"` |
28-
| `server.jvm.maxHeapSize` | | `"8G"` |
29-
| `server.jvm.gcMethod.type` | | `"UseG1GC"` |
30-
| `server.jvm.gcMethod.g1.heapRegionSize` | | `"32M"` |
31-
| `additionalNodeProperties` | | `{}` |
32-
| `additionalJVMConfig` | | `{}` |
33-
| `additionalConfigProperties` | | `{}` |
34-
| `additionalLogProperties` | | `{}` |
35-
| `additionalCatalogs` | | `{}` |
36-
| `securityContext.runAsUser` | | `1000` |
37-
| `securityContext.runAsGroup` | | `1000` |
38-
| `service.type` | | `"ClusterIP"` |
39-
| `service.port` | | `8080` |
40-
| `resources` | | `{}` |
41-
| `nodeSelector` | | `{}` |
42-
| `tolerations` | | `[]` |
43-
| `affinity` | | `{}` |
44-
45-
---
46-
_Documentation generated by [Frigate](https://frigate.readthedocs.io)._
6+
Fast distributed SQL query engine for big data analytics that helps you explore your data universe
477

8+
9+
## Usage
10+
11+
[Helm](https://helm.sh) must be installed to use the charts.
12+
Please refer to Helm's [documentation](https://helm.sh/docs/) to get started.
13+
14+
Once Helm is set up properly, add the repo as follows:
15+
16+
```console
17+
helm repo add trino https://trinodb.github.io/charts/
18+
```
19+
20+
You can then run `helm search repo trino` to see the charts.
21+
22+
Then you can install chart using:
23+
24+
```console
25+
helm install my-trino trino/trino --version 0.2.0
26+
```

charts/trino/README.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
2+
Trino
3+
===========
4+
5+
Fast distributed SQL query engine for big data analytics that helps you explore your data universe
6+
7+
8+
## Configuration
9+
10+
The following table lists the configurable parameters of the Trino chart and their default values.
11+
12+
| Parameter | Description | Default |
13+
| ------------------------ | ----------------------- | -------------- |
14+
| `image.repository` | | `"trinodb/trino"` |
15+
| `image.pullPolicy` | | `"IfNotPresent"` |
16+
| `image.tag` | | `"latest"` |
17+
| `server.workers` | | `2` |
18+
| `server.node.environment` | | `"production"` |
19+
| `server.node.dataDir` | | `"/data/trino"` |
20+
| `server.node.pluginDir` | | `"/usr/lib/trino/plugin"` |
21+
| `server.log.trino.level` | | `"INFO"` |
22+
| `server.config.path` | | `"/etc/trino"` |
23+
| `server.config.http.port` | | `8080` |
24+
| `server.config.query.maxMemory` | | `"4GB"` |
25+
| `server.config.query.maxMemoryPerNode` | | `"1GB"` |
26+
| `server.config.query.maxTotalMemoryPerNode` | | `"2GB"` |
27+
| `server.config.memory.heapHeadroomPerNode` | | `"1GB"` |
28+
| `server.jvm.maxHeapSize` | | `"8G"` |
29+
| `server.jvm.gcMethod.type` | | `"UseG1GC"` |
30+
| `server.jvm.gcMethod.g1.heapRegionSize` | | `"32M"` |
31+
| `additionalNodeProperties` | | `{}` |
32+
| `additionalJVMConfig` | | `{}` |
33+
| `additionalConfigProperties` | | `{}` |
34+
| `additionalLogProperties` | | `{}` |
35+
| `additionalCatalogs` | | `{}` |
36+
| `securityContext.runAsUser` | | `1000` |
37+
| `securityContext.runAsGroup` | | `1000` |
38+
| `service.type` | | `"ClusterIP"` |
39+
| `service.port` | | `8080` |
40+
| `resources` | | `{}` |
41+
| `nodeSelector` | | `{}` |
42+
| `tolerations` | | `[]` |
43+
| `affinity` | | `{}` |
44+
45+
---
46+
_Documentation generated by [Frigate](https://frigate.readthedocs.io)._
47+

0 commit comments

Comments
 (0)