mirror of
https://github.com/truenas/charts.git
synced 2026-06-18 01:26:53 +08:00
add more docs
This commit is contained in:
Stavros kois
@@ -1,3 +1,7 @@
|
||||
# https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md033
|
||||
# Do not warn for "Inline HTML"
|
||||
MD033: false
|
||||
|
||||
# https://github.com/DavidAnson/markdownlint/blob/v0.26.2/doc/Rules.md#md024
|
||||
# Multiple headings with the same content
|
||||
MD024: false
|
||||
|
||||
@@ -7,19 +7,18 @@ global:
|
||||
annotations: {}
|
||||
labels: {}
|
||||
|
||||
# -- Sets an override for the suffix of the full name (Applies to current chart only)
|
||||
nameOverride: ""
|
||||
|
||||
# -- Set annotations on the pod. Helm templates can be used.
|
||||
podAnnotations: {}
|
||||
|
||||
# -- Set labels on the pod. Helm templates can be used.
|
||||
podLabels: {}
|
||||
|
||||
# TODO: docs
|
||||
ixExternalInterfacesConfigurationNames: []
|
||||
# - interface1
|
||||
# - interface2
|
||||
|
||||
# TODO: docs
|
||||
image:
|
||||
# -- Image repository
|
||||
repository:
|
||||
@@ -28,20 +27,14 @@ image:
|
||||
# -- Image pull policy
|
||||
pullPolicy: IfNotPresent
|
||||
|
||||
# -- Override the command(s) for the default container
|
||||
command: []
|
||||
|
||||
# -- Override the args for the default container
|
||||
args: []
|
||||
|
||||
# -- Add args in addition to the arguments set by default.
|
||||
# Primarily for the SCALE GUI
|
||||
extraArgs: []
|
||||
|
||||
# -- Determines whether containers in a pod runs with TTY enabled.
|
||||
tty: false
|
||||
|
||||
# -- Determines whether containers in a pod runs with stdin enabled.
|
||||
stdin: false
|
||||
|
||||
# -- Configure the Security Context for the Pod
|
||||
|
||||
@@ -2,9 +2,9 @@
|
||||
|
||||
## global
|
||||
|
||||
<details open>
|
||||
<summary>Show more</summary>
|
||||
Available keys:
|
||||
<details>
|
||||
<summary>Show / Hide</summary>
|
||||
Available options:
|
||||
|
||||
```yaml
|
||||
global:
|
||||
@@ -16,6 +16,7 @@ global:
|
||||
### nameOverride
|
||||
|
||||
<details>
|
||||
<summary>Show / Hide</summary>
|
||||
|
||||
Sets an override for the suffix of the full name.
|
||||
(Applies to current chart and all sub-charts)
|
||||
@@ -23,7 +24,7 @@ Sets an override for the suffix of the full name.
|
||||
- Type: `string`
|
||||
- Helm template: ❌
|
||||
|
||||
Example: Values.yaml
|
||||
Examples`: Values.yaml
|
||||
|
||||
```yaml
|
||||
global:
|
||||
@@ -34,7 +35,7 @@ Appends `something` to:
|
||||
|
||||
- Deployment
|
||||
- metadata.name
|
||||
- spec.template.spec.containers[].name
|
||||
- spec.template.spec.containers[0].name
|
||||
|
||||
Sets `something` to:
|
||||
|
||||
@@ -53,6 +54,7 @@ Sets `something` to:
|
||||
### annotations
|
||||
|
||||
<details>
|
||||
<summary>Show / Hide</summary>
|
||||
|
||||
Sets additional global annotations.
|
||||
|
||||
@@ -60,7 +62,7 @@ Sets additional global annotations.
|
||||
- Helm Template: ✅
|
||||
- On values only
|
||||
|
||||
Example:
|
||||
Examples`:
|
||||
|
||||
Values.yaml
|
||||
|
||||
@@ -81,6 +83,7 @@ Sets all `key: value` pairs to:
|
||||
### labels
|
||||
|
||||
<details>
|
||||
<summary>Show / Hide</summary>
|
||||
|
||||
Set additional global labels. Helm templates can be used.
|
||||
|
||||
@@ -88,7 +91,7 @@ Set additional global labels. Helm templates can be used.
|
||||
- Helm Template: ✅
|
||||
- On values only
|
||||
|
||||
Example:
|
||||
Examples`:
|
||||
|
||||
Values.yaml
|
||||
|
||||
@@ -106,3 +109,255 @@ Sets all `key: value` pairs to:
|
||||
|
||||
</details>
|
||||
</details>
|
||||
|
||||
## nameOverride
|
||||
|
||||
<details>
|
||||
<summary>Show / Hide</summary>
|
||||
|
||||
Sets an override for the suffix of the full name.
|
||||
(Applies to current chart only)
|
||||
|
||||
- Type: `string`
|
||||
- Helm template: ❌
|
||||
- Default: `""`
|
||||
|
||||
Examples`: Values.yaml
|
||||
|
||||
```yaml
|
||||
nameOverride: something
|
||||
```
|
||||
|
||||
Appends `something` to:
|
||||
|
||||
- Deployment
|
||||
- metadata.name
|
||||
- spec.template.spec.containers[0].name
|
||||
|
||||
Sets `something` to:
|
||||
|
||||
- Deployment
|
||||
- metadata.app
|
||||
- metadata.app.kubernetes.io/name
|
||||
- spec.selector.matchLabels.app
|
||||
- spec.selector.matchLabels.app.kubernetes.io/name
|
||||
- spec.template.metadata.annotations.app
|
||||
- spec.template.metadata.annotations.app
|
||||
- spec.template.metadata.labels.app.kubernetes.io/name
|
||||
- spec.template.metadata.labels.app.kubernetes.io/name
|
||||
|
||||
</details>
|
||||
|
||||
## podAnnotations
|
||||
|
||||
<details>
|
||||
<summary>Show / Hide</summary>
|
||||
|
||||
Set annotations on the pod.
|
||||
|
||||
- Type: `dict`
|
||||
- Helm Template: ✅
|
||||
- On values only
|
||||
- Default: `{}`
|
||||
|
||||
Examples`: Values.yaml
|
||||
|
||||
```yaml
|
||||
podAnnotations:
|
||||
key1: value
|
||||
key2: "{{ .Values.some.key }}"
|
||||
```
|
||||
|
||||
Sets all `key: value` pairs to:
|
||||
|
||||
- Deployment
|
||||
- spec.template.metadata.annotations
|
||||
|
||||
</details>
|
||||
|
||||
## podLabels
|
||||
|
||||
<details>
|
||||
<summary>Show / Hide</summary>
|
||||
|
||||
Set labels on the pod.
|
||||
|
||||
- Type: `dict`
|
||||
- Helm Template: ✅
|
||||
- On values only
|
||||
- Default: `{}`
|
||||
|
||||
Examples`: Values.yaml
|
||||
|
||||
```yaml
|
||||
podLabels:
|
||||
key1: value
|
||||
key2: "{{ .Values.some.key }}"
|
||||
```
|
||||
|
||||
Sets all `key: value` pairs to:
|
||||
|
||||
- Deployment
|
||||
- spec.template.metadata.labels
|
||||
|
||||
</details>
|
||||
|
||||
## command
|
||||
|
||||
<details>
|
||||
<summary>Show / Hide</summary>
|
||||
|
||||
Override the command(s) for the default container
|
||||
|
||||
- Type: `string` or `list`
|
||||
- Helm Template: ✅
|
||||
- Default: `[]`
|
||||
|
||||
Examples`: Values.yaml
|
||||
|
||||
```yaml
|
||||
command: entrypoint.sh
|
||||
|
||||
command: "{{ .Values.some.key }}"
|
||||
|
||||
command:
|
||||
- /bin/sh
|
||||
- -c
|
||||
- |
|
||||
echo "something"
|
||||
|
||||
command:
|
||||
- "{{ .Values.shell.option }}"
|
||||
- -c
|
||||
- |
|
||||
echo {{ .Values.some.key | quote }}
|
||||
```
|
||||
|
||||
Coverts command to a list and sets it to:
|
||||
|
||||
- Deployment
|
||||
- spec.template.spec.containers[0].command
|
||||
|
||||
</details>
|
||||
|
||||
## args
|
||||
|
||||
<details>
|
||||
<summary>Show / Hide</summary>
|
||||
|
||||
Override the args for the default container
|
||||
|
||||
- Type: `string` or `list`
|
||||
- Helm Template: ✅
|
||||
- Default: `[]`
|
||||
|
||||
Examples`: Values.yaml
|
||||
|
||||
```yaml
|
||||
args: worker
|
||||
|
||||
args: "{{ .Values.some.key }}"
|
||||
|
||||
args:
|
||||
- --port
|
||||
- 8000
|
||||
|
||||
args:
|
||||
- --port
|
||||
- "{{ .Values.some.key }}"
|
||||
```
|
||||
|
||||
Coverts args to a list and sets it to:
|
||||
|
||||
- Deployment
|
||||
- spec.template.spec.containers[0].args
|
||||
|
||||
</details>
|
||||
|
||||
## extraArgs
|
||||
|
||||
<details>
|
||||
<summary>Show / Hide</summary>
|
||||
|
||||
Appends args to the `args` for the default container.
|
||||
If no `args` are defined, `extraArgs` will still be set.
|
||||
Mainly built for the SCALE GUI
|
||||
|
||||
- Type: `string` or `list`
|
||||
- Helm Template: ✅
|
||||
- Default: `[]`
|
||||
|
||||
Examples`: Values.yaml
|
||||
|
||||
```yaml
|
||||
extraArgs: something
|
||||
|
||||
extraArgs: "{{ .Values.some.key }}"
|
||||
|
||||
extraArgs:
|
||||
- --photosPath
|
||||
- /something
|
||||
|
||||
extraArgs:
|
||||
- --photosPath
|
||||
- "{{ .Values.some.key }}"
|
||||
```
|
||||
|
||||
Coverts extraArgs to a list and appends it to:
|
||||
|
||||
- Deployment
|
||||
- spec.template.spec.containers[0].args
|
||||
|
||||
</details>
|
||||
|
||||
## tty
|
||||
|
||||
<details>
|
||||
<summary>Show / Hide</summary>
|
||||
|
||||
Specifies whether the default container in a pod runs with `TTY` enabled.
|
||||
|
||||
- Type: `boolean`
|
||||
- Helm Template: ❌
|
||||
- Default: `false`
|
||||
|
||||
Examples`: Values.yaml
|
||||
|
||||
```yaml
|
||||
tty: true
|
||||
|
||||
tty: false
|
||||
```
|
||||
|
||||
Coverts extraArgs to a list and appends it to:
|
||||
|
||||
- Deployment
|
||||
- spec.template.spec.containers[0].tty
|
||||
|
||||
</details>
|
||||
|
||||
## stdin
|
||||
|
||||
<details>
|
||||
<summary>Show / Hide</summary>
|
||||
|
||||
Specifies whether the default container in a pod runs with `stdin` enabled.
|
||||
|
||||
- Type: `boolean`
|
||||
- Helm Template: ❌
|
||||
- Default: `false`
|
||||
|
||||
Examples`: Values.yaml
|
||||
|
||||
```yaml
|
||||
stdin: true
|
||||
|
||||
stdin: false
|
||||
```
|
||||
|
||||
Coverts extraArgs to a list and appends it to:
|
||||
|
||||
- Deployment
|
||||
- spec.template.spec.containers[0].stdin
|
||||
|
||||
</details>
|
||||
|
||||
Reference in New Issue
Block a user