add docs for image(Selector)

This commit is contained in:
Stavros kois
2022-11-28 18:13:08 +02:00
parent 6d00d12149
commit 8fa0550d70
2 changed files with 66 additions and 10 deletions

View File

@@ -2,6 +2,16 @@
# All values can be overridden per chart, in their values.yaml
# For Examples and Explanation view the "Values.yaml Explained" markdown file
image:
repository: repo
tag: tag
pullPolicy: IfNotPresent
imageSelector: ""
# Everything bellow needs documentation
global:
nameOverride: ""
fullnameOverride: ""
@@ -21,16 +31,6 @@ ixExternalInterfacesConfigurationNames: []
# - interface1
# - interface2
# TODO: docs
image:
# -- Image repository
repository: repo
# -- Image tag
tag: tag
# -- Image pull policy
pullPolicy: IfNotPresent
imageSelector: ""
command: []

View File

@@ -0,0 +1,56 @@
# Image
## Key: image
- Type: `dict`
- Default:
```yaml
image:
repository: repo
tag: tag
pullPolicy: IfNotPresent
```
- Helm Template: ❌
`image` key contains info regarding the container image that will be used
Example:
```yaml
image:
repository: nginx
tag: 1.16
pullPolicy: IfNotPresents
```
## Key: imageSelector
- Type: `string`
- Default: `""`
- Helm Template: ❌
`imageSelector` key is used for apps/charts that have multiple image variations.
Example, an app that has different image for CPU and GPU workloads.
This key should contain an name of a `dict` constructed similar to `image`.
If defined `image` is ignored and the defined `dict` is used.
In the below example the gpu image will be used when `imageSelector` is defined,
otherwise it will default to the `image`, which is the cpu image.
Example:
```yaml
image:
repository: app/repository
tag: cpu-v1
pullPolicy: IfNotPresents
gpuImage:
repository: app/repository
tag: gpu-v1
pullPolicy: IfNotPresents
imageSelector: gpuImage
```