Skip to content

Commit 3b35d3a

Browse files
nineinchnicknineinchnick
committed
Fix README template for Gateway chart
1 parent e856194 commit 3b35d3a

File tree

4 files changed

+165
-102
lines changed

4 files changed

+165
-102
lines changed

‎charts/gateway/Chart.yaml

+10-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,15 @@ apiVersion: v2
22
name: trino-gateway
33
description: A Helm chart for Trino Gateway
44
type: application
5-
# Trino Gateway Helm chart version. Should be appVersion with .0.0 appended.
65
version: "12.0.0"
7-
# Trino Gateway version
86
appVersion: "12"
7+
8+
icon: https://trino.io/assets/images/logos/trino-gateway-small.png
9+
10+
home: https://trino.io/
11+
sources:
12+
- https://github.com/trinodb/charts
13+
- https://github.com/trinodb/trino-gateway/tree/master/docker
14+
15+
maintainers:
16+
- name: Trino community

‎charts/gateway/README.md

+130-93
Original file line numberDiff line numberDiff line change
@@ -4,101 +4,138 @@
44

55
A Helm chart for Trino Gateway
66

7+
**Homepage:** <https://trino.io/>
8+
9+
## Source Code
10+
11+
* <https://github.com/trinodb/charts>
12+
* <https://github.com/trinodb/trino-gateway/tree/master/docker>
13+
714
## Values
15+
* `replicaCount` - int, default: `1`
16+
* `image.repository` - string, default: `"trinodb/trino-gateway"`
17+
18+
Repository location of the Trino Gateway image, typically `organization/imagename`
19+
* `image.pullPolicy` - string, default: `"IfNotPresent"`
20+
* `image.tag` - string, default: `""`
21+
22+
Override the image tag whose default is the chart appVersion.
23+
* `imagePullSecrets` - list, default: `[]`
24+
25+
An optional list of references to secrets in the same namespace to use for pulling images.
26+
Example:
27+
```yaml
28+
imagePullSecrets:
29+
- name: registry-credentials
30+
```
31+
* `dataStoreSecret` - object, default: `{"key":"","name":""}`
32+
33+
Provide configuration for the Trino Gateway `dataStore` in `dataStoreSecret`. This node can be left undefined if `dataStore` is defined under the config node. For production deployments sensitive values should be stored in a Secret
34+
* `backendStateSecret` - object, default: `{"key":"","name":""}`
35+
36+
Provide configuration for the Trino Gateway `backendState` in `backendStateSecret`. This should be used with health check configurations that require backend credentials. This node can be left undefined if `dataStore` is defined under the config node.
37+
* `authenticationSecret` - object, default: `{"key":"","name":""}`
38+
39+
Provide configuration for the Trino Gateway authentication configuration in `authenticationSecret`. This node can be left undefined if `dataStore` is defined under the config node.
40+
* `config.serverConfig."node.environment"` - string, default: `"test"`
41+
* `config.serverConfig."http-server.http.port"` - int, default: `8080`
42+
* `config.dataStore.jdbcUrl` - string, default: `"jdbc:postgresql://localhost:5432/gateway"`
43+
44+
The connection details for the backend database for Trino Gateway and Trino query history
45+
* `config.dataStore.user` - string, default: `"postgres"`
46+
* `config.dataStore.password` - string, default: `"mysecretpassword"`
47+
* `config.dataStore.driver` - string, default: `"org.postgresql.Driver"`
48+
* `config.clusterStatsConfiguration.monitorType` - string, default: `"INFO_API"`
49+
* `config.modules[0]` - string, default: `"io.trino.gateway.ha.module.HaGatewayProviderModule"`
50+
* `config.modules[1]` - string, default: `"io.trino.gateway.ha.module.ClusterStateListenerModule"`
51+
* `config.modules[2]` - string, default: `"io.trino.gateway.ha.module.ClusterStatsMonitorModule"`
52+
* `config.managedApps[0]` - string, default: `"io.trino.gateway.ha.clustermonitor.ActiveClusterMonitor"`
53+
* `command` - list, default: `["java","-XX:MinRAMPercentage=80.0","-XX:MaxRAMPercentage=80.0","-jar","/usr/lib/trino/gateway-ha-jar-with-dependencies.jar","/etc/gateway/config.yaml"]`
54+
55+
Startup command for Trino Gateway process. Add additional Java options and other modifications as desired.
56+
* `service.type` - string, default: `"ClusterIP"`
57+
* `service.port` - int, default: `8080`
58+
* `ingress.enabled` - bool, default: `false`
59+
* `ingress.className` - string, default: `""`
60+
* `ingress.annotations` - object, default: `{}`
61+
* `ingress.hosts` - list, default: `[{"host":"chart-example.local","paths":[{"path":"/","pathType":"ImplementationSpecific"}]}]`
62+
63+
[Ingress rules](https://kubernetes.io/docs/concepts/services-networking/ingress/#ingress-rules).
64+
Example:
65+
```yaml
66+
- host: trino.example.com
67+
paths:
68+
- path: /
69+
pathType: ImplementationSpecific
70+
```
71+
* `ingress.tls` - list, default: `[]`
72+
73+
Ingress [TLS](https://kubernetes.io/docs/concepts/services-networking/ingress/#tls) configuration.
74+
Example:
75+
```yaml
76+
- secretName: chart-example-tls
77+
hosts:
78+
- chart-example.local
79+
```
80+
* `resources.limits.cpu` - int, default: `2`
81+
* `resources.limits.memory` - string, default: `"4Gi"`
82+
* `resources.requests.cpu` - int, default: `2`
83+
* `resources.requests.memory` - string, default: `"4Gi"`
84+
* `autoscaling.enabled` - bool, default: `false`
85+
* `autoscaling.minReplicas` - int, default: `1`
86+
* `autoscaling.maxReplicas` - int, default: `100`
87+
* `autoscaling.targetCPUUtilizationPercentage` - int, default: `80`
88+
89+
Target average CPU utilization, represented as a percentage of requested CPU. To disable scaling based on CPU, set to an empty string.
90+
* `autoscaling.targetMemoryUtilizationPercentage` - string, default: `""`
91+
92+
Target average memory utilization, represented as a percentage of requested memory. To disable scaling based on memory, set to an empty string.
93+
* `livenessProbe.initialDelaySeconds` - int, default: `30`
94+
* `livenessProbe.periodSeconds` - int, default: `10`
95+
* `livenessProbe.failureThreshold` - int, default: `3`
96+
* `livenessProbe.timeoutSeconds` - int, default: `1`
97+
* `livenessProbe.scheme` - string, default: `"HTTP"`
98+
* `readinessProbe.initialDelaySeconds` - int, default: `5`
99+
* `readinessProbe.periodSeconds` - int, default: `5`
100+
* `readinessProbe.failureThreshold` - int, default: `12`
101+
* `readinessProbe.timeoutSeconds` - int, default: `1`
102+
* `readinessProbe.scheme` - string, default: `"HTTP"`
103+
* `volumes` - object, default: `{}`
104+
* `volumeMounts` - object, default: `{}`
105+
* `nodeSelector` - object, default: `{}`
106+
* `tolerations` - list, default: `[]`
107+
* `affinity` - object, default: `{}`
108+
* `commonLabels` - object, default: `{}`
109+
110+
Labels that get applied to every resource's metadata
111+
* `podAnnotations` - object, default: `{}`
112+
* `podLabels` - object, default: `{}`
113+
* `podSecurityContext` - object, default: `{}`
114+
115+
[Pod security context](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod) configuration. To remove the default, set it to null (or `~`).
116+
* `securityContext` - object, default: `{}`
117+
118+
[Container security context](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-container) configuration.
119+
Example:
120+
```yaml
121+
capabilities:
122+
drop:
123+
- ALL
124+
readOnlyRootFilesystem: true
125+
runAsNonRoot: true
126+
```
127+
* `serviceAccount.create` - bool, default: `true`
128+
129+
Specifies whether a service account should be created
130+
* `serviceAccount.automount` - bool, default: `true`
131+
132+
Automatically mount a ServiceAccount's API credentials?
133+
* `serviceAccount.annotations` - object, default: `{}`
134+
135+
Annotations to add to the service account
136+
* `serviceAccount.name` - string, default: `""`
8137

9-
| Key | Type | Default | Description |
10-
|-----|------|---------|-------------|
11-
| replicaCount | int | `1` | |
12-
| image.repository | string | `"trinodb/trino-gateway"` | Repository location of the Trino Gateway image, typically `organization/imagename` |
13-
| image.pullPolicy | string | `"IfNotPresent"` | |
14-
| image.tag | string | `""` | Override the image tag whose default is the chart appVersion. |
15-
| imagePullSecrets | list | `[]` | An optional list of references to secrets in the same namespace to use for pulling images.
16-
Example:
17-
```yaml
18-
imagePullSecrets:
19-
- name: registry-credentials
20-
``` |
21-
| dataStoreSecret | object | `{"key":"","name":""}` | Provide configuration for the Trino Gateway `dataStore` in `dataStoreSecret`. This node can be left undefined if `dataStore` is defined under the config node. For production deployments sensitive values should be stored in a Secret |
22-
| backendStateSecret | object | `{"key":"","name":""}` | Provide configuration for the Trino Gateway `backendState` in `backendStateSecret`. This should be used with health check configurations that require backend credentials. This node can be left undefined if `dataStore` is defined under the config node. |
23-
| authenticationSecret | object | `{"key":"","name":""}` | Provide configuration for the Trino Gateway authentication configuration in `authenticationSecret`. This node can be left undefined if `dataStore` is defined under the config node. |
24-
| config.serverConfig."node.environment" | string | `"test"` | |
25-
| config.serverConfig."http-server.http.port" | int | `8080` | |
26-
| config.dataStore.jdbcUrl | string | `"jdbc:postgresql://localhost:5432/gateway"` | The connection details for the backend database for Trino Gateway and Trino query history |
27-
| config.dataStore.user | string | `"postgres"` | |
28-
| config.dataStore.password | string | `"mysecretpassword"` | |
29-
| config.dataStore.driver | string | `"org.postgresql.Driver"` | |
30-
| config.clusterStatsConfiguration.monitorType | string | `"INFO_API"` | |
31-
| config.modules[0] | string | `"io.trino.gateway.ha.module.HaGatewayProviderModule"` | |
32-
| config.modules[1] | string | `"io.trino.gateway.ha.module.ClusterStateListenerModule"` | |
33-
| config.modules[2] | string | `"io.trino.gateway.ha.module.ClusterStatsMonitorModule"` | |
34-
| config.managedApps[0] | string | `"io.trino.gateway.ha.clustermonitor.ActiveClusterMonitor"` | |
35-
| command | list | `["java","-XX:MinRAMPercentage=80.0","-XX:MaxRAMPercentage=80.0","-jar","/usr/lib/trino/gateway-ha-jar-with-dependencies.jar","/etc/gateway/config.yaml"]` | Startup command for Trino Gateway process. Add additional Java options and other modifications as desired. |
36-
| service.type | string | `"ClusterIP"` | |
37-
| service.port | int | `8080` | |
38-
| ingress.enabled | bool | `false` | |
39-
| ingress.className | string | `""` | |
40-
| ingress.annotations | object | `{}` |
41-
Example:
42-
```yaml
43-
kubernetes.io/ingress.class: nginx
44-
kubernetes.io/tls-acme: "true"
45-
``` |
46-
| ingress.hosts | list | `[{"host":"chart-example.local","paths":[{"path":"/","pathType":"ImplementationSpecific"}]}]` | [Ingress rules](https://kubernetes.io/docs/concepts/services-networking/ingress/#ingress-rules).
47-
Example:
48-
```yaml
49-
- host: trino.example.com
50-
paths:
51-
- path: /
52-
pathType: ImplementationSpecific
53-
``` |
54-
| ingress.tls | list | `[]` | Ingress [TLS](https://kubernetes.io/docs/concepts/services-networking/ingress/#tls) configuration.
55-
Example:
56-
```yaml
57-
- secretName: chart-example-tls
58-
hosts:
59-
- chart-example.local
60-
``` |
61-
| resources.limits.cpu | int | `2` | |
62-
| resources.limits.memory | string | `"4Gi"` | |
63-
| resources.requests.cpu | int | `2` | |
64-
| resources.requests.memory | string | `"4Gi"` | |
65-
| autoscaling.enabled | bool | `false` | |
66-
| autoscaling.minReplicas | int | `1` | |
67-
| autoscaling.maxReplicas | int | `100` | |
68-
| autoscaling.targetCPUUtilizationPercentage | int | `80` | Target average CPU utilization, represented as a percentage of requested CPU. To disable scaling based on CPU, set to an empty string. |
69-
| autoscaling.targetMemoryUtilizationPercentage | string | `""` | Target average memory utilization, represented as a percentage of requested memory. To disable scaling based on memory, set to an empty string. |
70-
| livenessProbe.initialDelaySeconds | int | `30` | |
71-
| livenessProbe.periodSeconds | int | `10` | |
72-
| livenessProbe.failureThreshold | int | `3` | |
73-
| livenessProbe.timeoutSeconds | int | `1` | |
74-
| livenessProbe.scheme | string | `"HTTP"` | |
75-
| readinessProbe.initialDelaySeconds | int | `5` | |
76-
| readinessProbe.periodSeconds | int | `5` | |
77-
| readinessProbe.failureThreshold | int | `12` | |
78-
| readinessProbe.timeoutSeconds | int | `1` | |
79-
| readinessProbe.scheme | string | `"HTTP"` | |
80-
| volumes | object | `{}` | |
81-
| volumeMounts | object | `{}` | |
82-
| nodeSelector | object | `{}` | |
83-
| tolerations | list | `[]` | |
84-
| affinity | object | `{}` | |
85-
| commonLabels | object | `{}` | Labels that get applied to every resource's metadata |
86-
| podAnnotations | object | `{}` | |
87-
| podLabels | object | `{}` | |
88-
| podSecurityContext | object | `{}` | [Pod security context](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod) configuration. To remove the default, set it to null (or `~`). |
89-
| securityContext | object | `{}` | [Container security context](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-container) configuration.
90-
Example:
91-
```yaml
92-
capabilities:
93-
drop:
94-
- ALL
95-
readOnlyRootFilesystem: true
96-
runAsNonRoot: true
97-
``` |
98-
| serviceAccount.create | bool | `true` | Specifies whether a service account should be created |
99-
| serviceAccount.automount | bool | `true` | Automatically mount a ServiceAccount's API credentials? |
100-
| serviceAccount.annotations | object | `{}` | Annotations to add to the service account |
101-
| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template |
138+
The name of the service account to use. If not set and create is true, a name is generated using the fullname template
102139

103140
----------------------------------------------
104141
Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)

‎charts/gateway/README.md.gotmpl

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
{{ template "chart.header" . }}
2+
{{ template "chart.deprecationWarning" . }}
3+
4+
{{ template "chart.badgesSection" . }}
5+
6+
{{ template "chart.description" . }}
7+
8+
{{ template "chart.homepageLine" . }}
9+
10+
{{ template "chart.sourcesSection" . }}
11+
12+
{{ template "chart.requirementsSection" . }}
13+
14+
{{ template "chart.valuesHeader" . }}
15+
16+
{{- range .Values }}
17+
* `{{ .Key }}` - {{ .Type }}, default: {{ if .Default }}{{ .Default }}{{ else }}{{ .AutoDefault }}{{ end }}{{ if or .Description .AutoDescription }} {{ end }}
18+
{{- if .Description }}
19+
{{ .Description | nindent 2 }}
20+
{{- else if .AutoDescription }}
21+
{{ .AutoDescription | nindent 2 }}
22+
{{- end }}
23+
{{- end }}
24+
25+
{{ template "helm-docs.versionFooter" . }}

‎charts/gateway/values.yaml

-7
Original file line numberDiff line numberDiff line change
@@ -76,13 +76,6 @@ ingress:
7676
enabled: false
7777
className: ""
7878
annotations: {}
79-
# ingress.annotations --
80-
# @raw
81-
# Example:
82-
# ```yaml
83-
# kubernetes.io/ingress.class: nginx
84-
# kubernetes.io/tls-acme: "true"
85-
# ```
8679
hosts:
8780
- host: chart-example.local
8881
paths:

0 commit comments

Comments
 (0)