Skip to content

Commit 4e84b51

Browse files
committed
Fix formatting in the chart readme
1 parent f6cc296 commit 4e84b51

File tree

2 files changed

+41
-34
lines changed

2 files changed

+41
-34
lines changed

charts/trino/README.md

+11-13
Original file line numberDiff line numberDiff line change
@@ -62,17 +62,14 @@ Fast distributed SQL query engine for big data analytics that helps you explore
6262
* `server.config.query.maxMemory` - string, default: `"4GB"`
6363
* `server.exchangeManager` - object, default: `{}`
6464

65-
Mandatory [exchange manager configuration](https://trino.io/docs/current/admin/fault-tolerant-execution.html#id1).
66-
Used to set the name and location(s) of the spooling storage destination.
67-
* To enable fault-tolerant execution, you must set the `retry-policy` property in `additionalConfigProperties`.
68-
* Additional exchange manager configurations can be added to `additionalExchangeManagerProperties`.
65+
Mandatory [exchange manager configuration](https://trino.io/docs/current/admin/fault-tolerant-execution.html#id1). Used to set the name and location(s) of the spooling storage destination. To enable fault-tolerant execution, set the `retry-policy` property in `additionalConfigProperties`. Additional exchange manager configurations can be added to `additionalExchangeManagerProperties`.
6966
Example:
7067
```yaml
71-
server:
72-
exchangeManager:
73-
name: "filesystem"
74-
baseDir: "/tmp/trino-local-file-system-exchange-manager"
75-
additionalConfigProperties:
68+
server:
69+
exchangeManager:
70+
name: "filesystem"
71+
baseDir: "/tmp/trino-local-file-system-exchange-manager"
72+
additionalConfigProperties:
7673
- retry-policy=TASK
7774
additionalExchangeManagerProperties:
7875
- exchange.sink-buffer-pool-min-size=10
@@ -306,7 +303,7 @@ Fast distributed SQL query engine for big data analytics that helps you explore
306303
```
307304
* `envFrom` - list, default: `[]`
308305

309-
additional environment variables added to every pod, specified as a list of either ConfigMap or Secret references
306+
additional environment variables added to every pod, specified as a list of either `ConfigMap` or `Secret` references
310307
Example:
311308
```yaml
312309
- secretRef:
@@ -354,15 +351,15 @@ Fast distributed SQL query engine for big data analytics that helps you explore
354351
Control whether a process can gain more privileges than its parent process.
355352
* `containerSecurityContext.capabilities.drop` - list, default: `["ALL"]`
356353

357-
A list of the Linux kernel capabilities that are dropped from every container. Valid values are listed at https://man7.org/linux/man-pages/man7/capabilities.7.html Ensure to remove the "CAP_" prefix which the kernel attaches to the names of permissions.
354+
A list of the Linux kernel capabilities that are dropped from every container. Valid values are listed in [the capabilities manual page](https://man7.org/linux/man-pages/man7/capabilities.7.html). Ensure # to remove the "CAP_" prefix which the kernel attaches to the names of permissions.
358355
* `shareProcessNamespace.coordinator` - bool, default: `false`
359356
* `shareProcessNamespace.worker` - bool, default: `false`
360357
* `service.annotations` - object, default: `{}`
361358
* `service.type` - string, default: `"ClusterIP"`
362359
* `service.port` - int, default: `8080`
363360
* `service.nodePort` - string, default: `""`
364361

365-
The port the service listens on the host, for NodePort type. If not set, Kubernetes will [allocate a port automatically](https://kubernetes.io/docs/concepts/services-networking/service/#nodeport-custom-port).
362+
The port the service listens on the host, for the `NodePort` type. If not set, Kubernetes will [allocate a port automatically](https://kubernetes.io/docs/concepts/services-networking/service/#nodeport-custom-port).
366363
* `auth` - object, default: `{}`
367364

368365
Available authentication methods.
@@ -683,7 +680,7 @@ Fast distributed SQL query engine for big data analytics that helps you explore
683680
* `jmx.exporter.port` - int, default: `5556`
684681
* `jmx.exporter.configProperties` - string, default: `""`
685682

686-
The string value is templated using `tpl`. JMX Config Properties is mounted to /etc/jmx-exporter/jmx-exporter-config.yaml
683+
The string value is templated using `tpl`. The JMX config properties file is mounted to `/etc/jmx-exporter/jmx-exporter-config.yaml`.
687684
Example:
688685
```yaml
689686
configProperties: |-
@@ -706,6 +703,7 @@ Fast distributed SQL query engine for big data analytics that helps you explore
706703
value: '$2'
707704
help: 'ThreadCount (java.lang<type=Threading><>ThreadCount)'
708705
type: UNTYPED
706+
```
709707
* `jmx.exporter.securityContext` - object, default: `{}`
710708
* `jmx.exporter.resources` - object, default: `{}`
711709

charts/trino/values.yaml

+30-21
Original file line numberDiff line numberDiff line change
@@ -62,17 +62,17 @@ server:
6262
exchangeManager: {}
6363
# server.exchangeManager -- Mandatory [exchange manager
6464
# configuration](https://trino.io/docs/current/admin/fault-tolerant-execution.html#id1).
65+
# Used to set the name and location(s) of the spooling storage destination. To enable fault-tolerant execution,
66+
# set the `retry-policy` property in `additionalConfigProperties`. Additional exchange manager configurations can be
67+
# added to `additionalExchangeManagerProperties`.
6568
# @raw
66-
# Used to set the name and location(s) of the spooling storage destination.
67-
# * To enable fault-tolerant execution, you must set the `retry-policy` property in `additionalConfigProperties`.
68-
# * Additional exchange manager configurations can be added to `additionalExchangeManagerProperties`.
6969
# Example:
7070
# ```yaml
71-
# server:
72-
# exchangeManager:
73-
# name: "filesystem"
74-
# baseDir: "/tmp/trino-local-file-system-exchange-manager"
75-
# additionalConfigProperties:
71+
# server:
72+
# exchangeManager:
73+
# name: "filesystem"
74+
# baseDir: "/tmp/trino-local-file-system-exchange-manager"
75+
# additionalConfigProperties:
7676
# - retry-policy=TASK
7777
# additionalExchangeManagerProperties:
7878
# - exchange.sink-buffer-pool-min-size=10
@@ -85,9 +85,11 @@ server:
8585
autoscaling:
8686
enabled: false
8787
maxReplicas: 5
88-
# -- Target average CPU utilization, represented as a percentage of requested CPU. To disable scaling based on CPU, set to an empty string.
88+
# -- Target average CPU utilization, represented as a percentage of requested CPU. To disable scaling based on CPU,
89+
# set to an empty string.
8990
targetCPUUtilizationPercentage: 50
90-
# -- Target average memory utilization, represented as a percentage of requested memory. To disable scaling based on memory, set to an empty string.
91+
# -- Target average memory utilization, represented as a percentage of requested memory. To disable scaling
92+
# based on memory, set to an empty string.
9193
targetMemoryUtilizationPercentage: 80
9294
behavior: {}
9395
# server.autoscaling.behavior -- Configuration for scaling up and down.
@@ -334,7 +336,8 @@ env: []
334336
# ```
335337

336338
envFrom: []
337-
# envFrom -- additional environment variables added to every pod, specified as a list of either ConfigMap or Secret references
339+
# envFrom -- additional environment variables added to every pod, specified as a list of either `ConfigMap`
340+
# or `Secret` references
338341
# @raw
339342
# Example:
340343
# ```yaml
@@ -390,7 +393,9 @@ containerSecurityContext:
390393
# -- Control whether a process can gain more privileges than its parent process.
391394
allowPrivilegeEscalation: false
392395
capabilities:
393-
# -- A list of the Linux kernel capabilities that are dropped from every container. Valid values are listed at https://man7.org/linux/man-pages/man7/capabilities.7.html Ensure to remove the "CAP_" prefix which the kernel attaches to the names of permissions.
396+
# -- A list of the Linux kernel capabilities that are dropped from every container. Valid values are listed in
397+
# [the capabilities manual page](https://man7.org/linux/man-pages/man7/capabilities.7.html). Ensure # to remove
398+
# the "CAP_" prefix which the kernel attaches to the names of permissions.
394399
drop:
395400
- ALL
396401

@@ -402,7 +407,9 @@ service:
402407
annotations: {}
403408
type: ClusterIP
404409
port: 8080
405-
# service.nodePort -- The port the service listens on the host, for NodePort type. If not set, Kubernetes will [allocate a port automatically](https://kubernetes.io/docs/concepts/services-networking/service/#nodeport-custom-port).
410+
# service.nodePort -- The port the service listens on the host, for the `NodePort` type. If not set, Kubernetes will
411+
# [allocate a port
412+
# automatically](https://kubernetes.io/docs/concepts/services-networking/service/#nodeport-custom-port).
406413
nodePort: ""
407414

408415
auth: {}
@@ -684,12 +691,11 @@ worker:
684691
enabled: false
685692
gracePeriodSeconds: 120
686693
# worker.gracefulShutdown -- Configure [graceful
687-
# shutdown](https://trino.io/docs/current/admin/graceful-shutdown.html)
688-
# in order to ensure that workers terminate without affecting running queries,
689-
# given a sufficient grace period.
690-
# When enabled, the value of `worker.terminationGracePeriodSeconds` must be at least two times greater than the configured `gracePeriodSeconds`.
691-
# Enabling `worker.gracefulShutdown` conflicts with `worker.lifecycle`. When a custom
692-
# `worker.lifecycle` configuration needs to be used, graceful shutdown must be configured manually.
694+
# shutdown](https://trino.io/docs/current/admin/graceful-shutdown.html) in order to ensure that workers terminate
695+
# without affecting running queries, given a sufficient grace period. When enabled, the value of
696+
# `worker.terminationGracePeriodSeconds` must be at least two times greater than the configured `gracePeriodSeconds`.
697+
# Enabling `worker.gracefulShutdown` conflicts with `worker.lifecycle`. When a custom `worker.lifecycle` configuration
698+
# needs to be used, graceful shutdown must be configured manually.
693699
#
694700
# @raw
695701
# Example:
@@ -815,7 +821,8 @@ jmx:
815821
pullPolicy: Always
816822
port: 5556
817823
configProperties: ""
818-
# jmx.exporter.configProperties -- The string value is templated using `tpl`. JMX Config Properties is mounted to /etc/jmx-exporter/jmx-exporter-config.yaml
824+
# jmx.exporter.configProperties -- The string value is templated using `tpl`. The JMX config properties file
825+
# is mounted to `/etc/jmx-exporter/jmx-exporter-config.yaml`.
819826
# @raw
820827
# Example:
821828
# ```yaml
@@ -839,6 +846,7 @@ jmx:
839846
# value: '$2'
840847
# help: 'ThreadCount (java.lang<type=Threading><>ThreadCount)'
841848
# type: UNTYPED
849+
# ```
842850
securityContext: {}
843851
resources: {}
844852
# jmx.exporter.resources -- It is recommended not to specify default resources
@@ -882,7 +890,8 @@ jmx:
882890
# ```
883891

884892
serviceMonitor:
885-
# serviceMonitor.enabled -- Set to true to create resources for the [prometheus-operator](https://github.com/prometheus-operator/prometheus-operator).
893+
# serviceMonitor.enabled -- Set to true to create resources for the
894+
# [prometheus-operator](https://github.com/prometheus-operator/prometheus-operator).
886895
enabled: false
887896
# serviceMonitor.labels -- Labels for serviceMonitor, so that Prometheus can select it
888897
labels:

0 commit comments

Comments
 (0)