mirror of
https://github.com/truenas/charts.git
synced 2026-02-09 21:37:10 +08:00
929e60d801
* Adapt charts CI and improve/fix common * add check on permissions contaienr * add postgres template * update comments * Update create_app.sh * add check * update script * auto gen item.yaml from Chart,yaml * rename readme on dest * duplicate readme from the same source * correct comment * reoder * remove extra space * keep both README and app-readme * update regex, to also allow 2 letter names, which is also valid * No need to check host network if there aren't any pod values * use same pattern as the pod.name label (not prepending release-name * update deps * add chart dirs to ci * Add a validation to check if there is any yaml errors after merging files * update charts path on ci * common/1.0.0/ -> common/ * update common-test dep path * temp update create_app script * make permissions container name configurable, incase we want to change order of execution * update naming convention * fix typo and a missed name change * do not allow `--` in names
96 lines
3.2 KiB
Markdown
96 lines
3.2 KiB
Markdown
# Container
|
|
|
|
Assume every key below 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].imageSelector | `string` | ✅ | ✅ | `image` | Defines the image dict to use |
|
|
| 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.[container-name]`
|
|
|
|
---
|
|
|
|
Naming scheme:
|
|
|
|
- Primary: `$FullName` (release-name-chart-name)
|
|
- Non-Primary: `$FullName-$ContainerName` (release-name-chart-name-container-name)
|
|
|
|
---
|
|
|
|
More keys for `container` can be found below:
|
|
|
|
- [command](command.md)
|
|
- [args](args.md)
|
|
- [termination](termination.md)
|
|
- [lifecycle](lifecycle.md)
|
|
- [probes](probes.md)
|
|
- [resources](resources.md)
|
|
- [securityContext](securityContext.md)
|
|
- [envFrom](envFrom.md)
|
|
- [fixedEnv](fixedEnv.md)
|
|
- [env](env.md)
|
|
- [envList](envList.md)
|
|
|
|
---
|
|
|
|
Examples:
|
|
|
|
```yaml
|
|
workload:
|
|
workload-name:
|
|
enabled: true
|
|
primary: true
|
|
podSpec:
|
|
containers:
|
|
container-name:
|
|
enabled: true
|
|
primary: true
|
|
imageSelector: image
|
|
stdin: true
|
|
tty: true
|
|
```
|
|
|
|
## InitContainer
|
|
|
|
| Key | Type | Required | Helm Template | Default | Description |
|
|
| :-------------------------------------- | :-------: | :------: | :-----------: | :-----: | :----------------------------------------------------- |
|
|
| initContainers.[container-name] | `dict` | ✅ | ❌ | `{}` | Define the initContainer as dict |
|
|
| initContainers.[container-name].enabled | `boolean` | ✅ | ✅ | `false` | Enables or Disables the initContainer |
|
|
| initContainers.[container-name].type | `string` | ✅ | ✅ | `{}` | Define the type initContainer (init, install, upgrade) |
|
|
|
|
> Supports all keys from [container](container.md)
|
|
> Does not use `primary` key, `lifecycle` key and `probes` key
|
|
|
|
---
|
|
|
|
Notes:
|
|
|
|
`init` type run before the containers is started.
|
|
`install` type run before the containers is started and only on install.
|
|
`upgrade` type run before the containers is started and only on upgrade.
|
|
|
|
---
|
|
|
|
Examples:
|
|
|
|
```yaml
|
|
workload:
|
|
workload-name:
|
|
enabled: true
|
|
primary: true
|
|
podSpec:
|
|
initContainers:
|
|
container-name:
|
|
enabled: true
|
|
# ...
|
|
```
|