truenas/chart
1
0
Fork 0
mirror of https://github.com/truenas/charts.git synced 2026-06-16 15:08:11 +08:00
Code Issues Packages Projects Releases Wiki Activity

split docs

Browse Source
This commit is contained in:
Stavros kois
2023-02-13 17:58:45 +02:00
parent 6d805a1409
commit 68a35341e6
5 changed files with 170 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files

66
library/common/1.0.0/docs/container/README.md
View File

@@ -2,35 +2,19 @@
Assume every key bellow has a prefix of `workload.[workload-name].podSpec`.
| Key | Type | Required | Helm Template | Default | Description |
| :------------------------------------------------------- | :-----------: | :---------------: | :----------------: | :-----: | :--------------------------------------------------------------------------------------------- | --- |
| containers.[container-name] | `dict` | ✅ | ❌ | `{}` | Define the container as dict |
| containers.[container-name].enabled | `boolean` | ✅ | ❌ | `false` | Enables or Disables the container |
| containers.[container-name].primary | `boolean` | ✅ | ❌ | `false` | Sets the container as primary |
| containers.[container-name].stdin | `boolean` | ❌ | ❌ | `false` | whether to enable stdin or not |
| containers.[container-name].tty | `boolean` | ❌ | ❌ | `false` | whether to enable tty or not |
| containers.[container-name].command | `list/string` | ❌ | ✅ | `[]` | Define command(s). If it's single, can be defined as string |
| containers.[container-name].args | `list/string` | ❌ | ✅ | `[]` | Define arg(s). If it's single, can be defined as string |
| containers.[container-name].extraArgs | `list/string` | ❌ | ✅ | `[]` | Define extraArg(s). Those are appended after the `args`. Useful for user defined args from GUI |
| containers.[container-name].termination | `dict` | ❌ | ❌ | `{}` | Define termination for the container |
| containers.[container-name].termination.messagePath | `string` | ❌ | ✅ | `""` | Define termination message path for the container |
| containers.[container-name].termination.messagePolicy | `string` | ❌ | ✅ | `""` | Define termination message policy for the container |
| containers.[container-name].lifecycle | `dict` | ❌ | ❌ | `{}` | Define lifecycle for the container |
| containers.[container-name].lifecycle.preStop | `dict` | ❌ | ❌ | `{}` | Define preStop lifecycle |
| containers.[container-name].lifecycle.postStart | `dict` | ❌ | ❌ | `{}` | Define preStop lifecycle |
| containers.[container-name].lifecycle.[hook].type | `string` | ❌ | ❌ | `""` | Define hook type (exec, http) |
| containers.[container-name].lifecycle.[hook].command | `list/string` | ✅ (On exec type) | ✅ | `""` | Define command(s). If it's single, can be defined as string (Only when exec type is used) | |
| containers.[container-name].lifecycle.[hook].port | `int` | ✅ (On http type) | ✅ | `""` | Define the port, (Only when http type is used) | |
| containers.[container-name].lifecycle.[hook].host | `string` | ❌ | ✅ | | Define the host, k8s defaults to POD IP (Only when http type is used) | |
| containers.[container-name].lifecycle.[hook].path | `string` | ❌ | ✅ | `/` | Define the path (Only when http type is used) | |
| containers.[container-name].lifecycle.[hook].scheme | `string` | ❌ | ✅ | `HTTP` | Define the scheme (Only when http type is used) | |
| containers.[container-name].lifecycle.[hook].httpHeaders | `dict` | ❌ | ✅ (On value only) | `{}` | Define the httpHeaders in key-value pairs (Only when http type is used) | |
| Key | Type | Required | Helm Template | Default | Description |
| :---------------------------------- | :-----------: | :------: | :-----------: | :-----: | :---------------------------------------------------------- |
| containers.[container-name] | `dict` | ✅ | ❌ | `{}` | Define the container as dict |
| containers.[container-name].enabled | `boolean` | ✅ | ❌ | `false` | Enables or Disables the container |
| containers.[container-name].primary | `boolean` | ✅ | ❌ | `false` | Sets the container as primary |
| containers.[container-name].stdin | `boolean` | ❌ | ❌ | `false` | whether to enable stdin or not |
| containers.[container-name].tty | `boolean` | ❌ | ❌ | `false` | whether to enable tty or not |
---
Appears in:
- `.Values.workload.[workload-name].podSpec.containers`
- `.Values.workload.[workload-name].podSpec.containers.[container-name]`
---
@@ -41,6 +25,15 @@ Naming scheme:
---
More keys for `container` can be found below:
- [command](command.md)
- [args](args.md)
- [termination](termination.md)
- [lifecycle](lifecycle.md)
---
Examples:
```yaml
@@ -48,10 +41,6 @@ workload:
workload-name:
enabled: true
primary: true
labels:
key: value
annotations:
key: value
podSpec:
containers:
container-name:
@@ -59,25 +48,4 @@ workload:
primary: true
stdin: true
tty: true
command:
- command
args: arg
extraArgs:
- extraArg
termination:
messagePath: /dev/termination-log
messagePolicy: File
lifecycle:
preStop:
type: exec
command:
- command
postStart:
type: http
port: 8080
host: localhost
path: /path
scheme: HTTP
httpHeaders:
key: value
```

33
library/common/1.0.0/docs/container/args.md Normal file
View File

@@ -0,0 +1,33 @@
# Args
Assume every key bellow has a prefix of `workload.[workload-name].podSpec.containers.[container-name]`.
| Key | Type | Required | Helm Template | Default | Description |
| :-------- | :-----------: | :------: | :-----------: | :-----: | :--------------------------------------------------------------------------------------------- |
| args | `list/string` | ❌ | ✅ | `[]` | Define arg(s). If it's single, can be defined as string |
| extraArgs | `list/string` | ❌ | ✅ | `[]` | Define extraArg(s). Those are appended after the `args`. Useful for user defined args from GUI |
---
Appears in:
- `.Values.workload.[workload-name].podSpec.containers.[container-name].args`
---
Examples:
```yaml
workload:
workload-name:
enabled: true
primary: true
podSpec:
containers:
container-name:
enabled: true
primary: true
args: arg
extraArgs:
- extraArg
```

35
library/common/1.0.0/docs/container/command.md Normal file
View File

@@ -0,0 +1,35 @@
# Command
Assume every key bellow has a prefix of `workload.[workload-name].podSpec.containers.[container-name]`.
| Key | Type | Required | Helm Template | Default | Description |
| :------ | :-----------: | :------: | :-----------: | :-----: | :---------------------------------------------------------- |
| command | `list/string` | ❌ | ✅ | `[]` | Define command(s). If it's single, can be defined as string |
---
Appears in:
- `.Values.workload.[workload-name].podSpec.containers.[container-name].args`
---
Examples:
```yaml
workload:
workload-name:
enabled: true
primary: true
podSpec:
containers:
container-name:
enabled: true
primary: true
# As a list
command:
- command1
- command2
# As a string
command: command
```

51
library/common/1.0.0/docs/container/lifecycle.md Normal file
View File

@@ -0,0 +1,51 @@
# Lifecycle
Assume every key bellow has a prefix of `workload.[workload-name].podSpec.containers.[container-name]`.
| Key | Type | Required | Helm Template | Default | Description |
| :--------------------------- | :-----------: | :---------------: | :----------------: | :-----: | :---------------------------------------------------------------------------------------- | --- |
| lifecycle | `dict` | ❌ | ❌ | `{}` | Define lifecycle for the container |
| lifecycle.preStop | `dict` | ❌ | ❌ | `{}` | Define preStop lifecycle |
| lifecycle.postStart | `dict` | ❌ | ❌ | `{}` | Define preStop lifecycle |
| lifecycle.[hook].type | `string` | ❌ | ❌ | `""` | Define hook type (exec, http, https) |
| lifecycle.[hook].command | `list/string` | ✅ (On exec type) | ✅ | `""` | Define command(s). If it's single, can be defined as string (Only when exec type is used) | |
| lifecycle.[hook].port | `int` | ✅ (On http type) | ✅ | `""` | Define the port, (Only when http type is used) | |
| lifecycle.[hook].host | `string` | ❌ | ✅ | | Define the host, k8s defaults to POD IP (Only when http type is used) | |
| lifecycle.[hook].path | `string` | ❌ | ✅ | `/` | Define the path (Only when http type is used) | |
| lifecycle.[hook].scheme | `string` | ❌ | ✅ | `HTTP` | Define the scheme (Only when http type is used) | |
| lifecycle.[hook].httpHeaders | `dict` | ❌ | ✅ (On value only) | `{}` | Define the httpHeaders in key-value pairs (Only when http type is used) | |
---
Appears in:
- `.Values.workload.[workload-name].podSpec.containers.[container-name].lifecycle`
---
Examples:
```yaml
workload:
workload-name:
enabled: true
primary: true
podSpec:
containers:
container-name:
enabled: true
primary: true
lifecycle:
preStop:
type: exec
command:
- command
postStart:
type: http
port: 8080
host: localhost
path: /path
scheme: HTTP
httpHeaders:
key: value
```

34
library/common/1.0.0/docs/container/termination.md Normal file
View File

@@ -0,0 +1,34 @@
# Termination
Assume every key bellow has a prefix of `workload.[workload-name].podSpec.containers.[container-name]`.
| Key | Type | Required | Helm Template | Default | Description |
| :------------------------ | :------: | :------: | :-----------: | :-----: | :-------------------------------------------------- |
| termination | `dict` | ❌ | ❌ | `{}` | Define termination for the container |
| termination.messagePath | `string` | ❌ | ✅ | `""` | Define termination message path for the container |
| termination.messagePolicy | `string` | ❌ | ✅ | `""` | Define termination message policy for the container |
---
Appears in:
- `.Values.workload.[workload-name].podSpec.containers.[container-name].termination`
---
Examples:
```yaml
workload:
workload-name:
enabled: true
primary: true
podSpec:
containers:
container-name:
enabled: true
primary: true
termination:
messagePath: /dev/termination-log
messagePolicy: File
```