truecharts/library-charts

Fork 0

mirror of https://github.com/truecharts/library-charts.git synced 2026-07-05 08:16:21 -03:00

Files

Stavros kois 4b2ea47af6 moar docs

2022-11-18 16:41:50 +02:00

17 KiB

Raw Blame History

Values.yaml Explained

global

Show / Hide

Available options:

global:
  nameOverride: ""
  annotations: {}
  labels: {}

nameOverride

Show / Hide

Sets an override for the suffix of the full name. (Applies to current chart and all sub-charts)

Type: string
Default: ""
Helm template: ❌

Examples: Values.yaml

global:
  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

annotations

Show / Hide

Sets additional global annotations.

Type: dict
Default: {}
Helm Template: ✅
- On values only

Examples: Values.yaml

global:
  annotations:
    key1: value
    key2: "{{ .Values.some.key }}"

Sets all key: value pairs to:

Deployment
- metadata.annotations

labels

Show / Hide

Set additional global labels. Helm templates can be used.

Type: dict
Default: {}
Helm Template: ✅
- On values only

Examples:

Values.yaml

global:
  labels:
    key1: value
    key2: "{{ .Values.some.key }}"

Sets all key: value pairs to:

Deployment
- metadata.labels

nameOverride

Sets an override for the suffix of the full name. (Applies to current chart only)

Show / Hide

Type: string
Default: ""
Helm template: ❌

Examples: Values.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

podAnnotations

Set annotations on the pod.

Show / Hide

Type: dict
Default: {}
Helm Template: ✅
- On values only

Examples: Values.yaml

podAnnotations:
  key1: value
  key2: "{{ .Values.some.key }}"

Sets all key: value pairs to:

Deployment
- spec.template.metadata.annotations

podLabels

Set labels on the pod.

Show / Hide

Type: dict
Default: {}
Helm Template: ✅
- On values only

Examples: Values.yaml

podLabels:
  key1: value
  key2: "{{ .Values.some.key }}"

Sets all key: value pairs to:

Deployment
- spec.template.metadata.labels

command

Override the command(s) for the main container

Show / Hide

Type: string or list
Default: []
Helm Template: ✅

Examples: Values.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

args

Override the args for the main container

Show / Hide

Type: string or list
Default: []
Helm Template: ✅

Examples: Values.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

extraArgs

Appends args to the args for the main container. If no args are defined, extraArgs will still be set. Mainly built for the SCALE GUI

Show / Hide

Type: string or list
Default: []
Helm Template: ✅

Examples: Values.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

tty

Specifies whether the main container in a pod runs with TTY enabled.

Show / Hide

Kubernetes docs

Type: boolean
Default: false
Helm Template: ❌

Examples: Values.yaml

tty: true

tty: false

Sets tty to:

Deployment
- spec.template.spec.containers[0].tty

stdin

Specifies whether the main container in a pod runs with stdin enabled.

Show / Hide

Kubernetes docs

Type: boolean
Default: false
Helm Template: ❌

Examples: Values.yaml

stdin: true

stdin: false

Sets stdin to:

Deployment
- spec.template.spec.containers[0].stdin

podSecurityContext

Configure the Security Context for the Pod

Show / Hide

Available options:

podSecurityContext:
  runAsUser: 568
  runAsGroup: 568
  fsGroup: 568
  supplementalGroups: []
  fsGroupChangePolicy: OnRootMismatch

securityContext

Configure the Security Context for the main container

Show / Hide

Available options:

securityContext:
  privileged: false
  readOnlyRootFilesystem: true
  allowPrivilegeEscalation: false
  runAsNonRoot: true
  capabilities:
    add: []
    drop: []

privileged

Specifies privileged status on securityContext for the main container

Show / Hide

Kubernetes docs

Type: boolean
Default: false
Helm Template: ❌

Examples: Values.yaml

securityContext:
  privileged: false

securityContext:
  privileged: true

Sets privileged on securityContext to:

Deployment
- spec.template.spec.containers[0].securityContext.privileged

readOnlyRootFilesystem

Specifies readOnlyRootFilesystem status on securityContext for the main container

Show / Hide

Kubernetes docs

Type: boolean
Default: true
Helm Template: ❌

Examples: Values.yaml

securityContext:
  readOnlyRootFilesystem: false

securityContext:
  readOnlyRootFilesystem: true

Sets readOnlyRootFilesystem on securityContext to:

Deployment
- spec.template.spec.containers[0].securityContext.readOnlyRootFilesystem

allowPrivilegeEscalation

Specifies allowPrivilegeEscalation status on securityContext for the main container

Show / Hide

Kubernetes docs

Type: boolean
Default: false
Helm Template: ❌

Examples: Values.yaml

securityContext:
  allowPrivilegeEscalation: false

securityContext:
  allowPrivilegeEscalation: true

Sets allowPrivilegeEscalation on securityContext to:

Deployment
- spec.template.spec.containers[0].securityContext.allowPrivilegeEscalation

runAsNonRoot

Specifies runAsNonRoot status on securityContext for the main container

Show / Hide

Kubernetes docs

Type: boolean
Default: true
Helm Template: ❌

Examples: Values.yaml

securityContext:
  runAsNonRoot: false

securityContext:
  runAsNonRoot: true

Sets runAsNonRoot on securityContext to:

Deployment
- spec.template.spec.containers[0].securityContext.runAsNonRoot

capabilities

Specifies capabilities to add or drop on securityContext for the main container

Show / Hide

Kubernetes docs

Type: boolean
Default:
- add: []
- drop: []
Helm Template: ✅

Examples: Values.yaml

  capabilities:
    add:
      - SYS_ADMIN
      - "{{ .Values.some.key }}"
    drop:
      - NET_RAW
      - "{{ .Values.some.key }}"

Sets capabilities to add or drop on securityContext to:

Deployment
- spec.template.spec.containers[0].securityContext.capabilities.add
- spec.template.spec.containers[0].securityContext.capabilities.drop

lifecycle

Configure the lifecycle for the main container.

Show / Hide

Kubernetes docs

Type: dict
Default: {}
Helm Template: ✅

Examples: Values.yaml

lifecycle:
  postStart:
    command:
      - command1
      - "{{ .Values.some.key }}"
  preStop:
    command:
      - command1
      - "{{ .Values.some.key }}"

  postStart:
    command: some_command
  preStop:
    command: some_command

Sets lifecycle to:

Deployment
- spec.template.spec.containers[0].lifecycle.preStop
- spec.template.spec.containers[0].lifecycle.postStart

termination

Configure the termination for the main container.

Show / Hide

Available options:

termination:
  messagePath: ""
  messagePolicy: ""
  gracePeriodSeconds: 10

messagePath

Configure the path at which the file to which the main container's termination message will be written

Show / Hide

Kubernetes docs

Type: string
Default: ""
Helm Template: ✅

Examples: Values.yaml

termination:
  messagePath: /some/path

Sets messagePath to:

Deployment
- spec.template.spec.containers[0].terminationMessagePath

messagePolicy

Indicate how the main container's termination message should be populated.

Show / Hide

Kubernetes docs

Type: string
Default: ""
Helm Template: ✅

Valid options:

File
FallbackToLogsOnError

Examples: Values.yaml

termination:
  messagePolicy: File

Sets messagePolicy to:

Deployment
- spec.template.spec.containers[0].terminationMessagePolicy

gracePeriodSeconds

Duration in seconds the pod needs to terminate gracefully

Show / Hide

Kubernetes docs

Type: int
Default: 10
Helm Template: ❌

Examples: Values.yaml

termination:
  gracePeriodSeconds: 10

Sets gracePeriodSeconds to:

Deployment
- TODO:

nvidiaCaps

Specifies what NVIDIA capabilities will be set.

Show / Hide

Type: list
Default: ["all"]
Helm Template: ❌

Examples: Values.yaml

nvidiaCaps:
  - all

nvidiaCaps:
  - compute
  - utility

Converts the list to a , separated string and sets it to:

Deployment
- spec.template.spec.containers[0].env[NVIDIA_DRIVER_CAPABILITIES]

injectFixedEnvs

Specifies whether to inject some predefined fixed envs.

Show / Hide

Type: boolean
Default: true
Helm Template: ❌

Fixed envs injected:

TZ
- Equal to .Values.TZ
UMASK
- Equal to .Values.security.UMASK
UMASK_SET
- Equal to .Values.security.UMASK
NVIDIA_VISIBLE_DEVICES
- Set to void
- (Only if there are no .Values.scaleGPU set)
NVIDIA_DRIVER_CAPABILITIES
- Equal to .Values.nvidiaCaps
- (Only if there are .Values.scaleGPU set)
PUID
- Equal to .Values.security.PUID
- (Only if runs as root (user or group) and PUID is set)
USER_ID
- Equal to .Values.security.PUID
- (Only if runs as root (user or group) and PUID is set)
UID
- Equal to .Values.security.PUID
- (Only if runs as root (user or group) and PUID is set)
PGID
- Equal to .Values.podSecurityContext.fsGroup
- (Only if runs as root (user or group) and PUID is set)
GROUP_ID
- Equal to .Values.podSecurityContext.fsGroup
- (Only if runs as root (user or group) and PUID is set)
GID
- Equal to .Values.podSecurityContext.fsGroup
- (Only if runs as root (user or group) and PUID is set)
S6_READ_ONLY_ROOT
- Set to 1
- (Only if runs as root (user) or readOnlyRootFilesystem is true)

Examples: Values.yaml

injectFixedEnvs: true

injectFixedEnvs: false

Converts the list to a , separated string and sets it to:

Deployment
- spec.template.spec.containers[0].env[NVIDIA_DRIVER_CAPABILITIES]

TZ

Sets main container's timezone

Show / Hide

Used mainly in Scale GUI

Type: string
Default: UTC
Helm Template: ✅

Examples: Values.yaml

TZ: UTC

TZ: "{{ .Values.some_key }}"

Sets it to:

Deployment
- spec.template.spec.containers[0].env[TZ]

security

Sets some security related environment variables

Show / Hide

Available options:

security:
  PUID: 568
  UMASK: 002

PUID

Sets PUID for the main container

Show / Hide

Type: int
Default: 568
Helm Template: ✅

Examples: Values.yaml

security:
  PUID: 568

security:
  PUID: "{{ .Values.some_key }}"

Sets it to:

Deployment
- spec.template.spec.containers[0].env[PUID]
- spec.template.spec.containers[0].env[USER_ID]
- spec.template.spec.containers[0].env[UID]

UMASK

Sets UMASK for the main container

Show / Hide

Type: int
Default: 002
Helm Template: ✅

Examples: Values.yaml

security:
  UMASK: 002

security:
  UMASK: "{{ .Values.some_key }}"

Sets it to:

Deployment
- spec.template.spec.containers[0].env[UMASK]
- spec.template.spec.containers[0].env[UMASK_SET]

env

Sets env to the main container

Show / Hide

Type: dict
Default: {}
Helm Template: ✅

Examples: Values.yaml

env:
  ENV_VAR: value

env:
  ENV_VAR: "{{ .Values.some.key }}"

env:
  ENV_VAR:
    configMapKeyRef:
      name: configmap-name
      key: confimap-key

env:
  ENV_VAR:
    configMapKeyRef:
      name: "{{ .Values.some.confimap.name }}"
      key: "{{ .Values.some.confimap.key }}"

env:
  ENV_VAR:
    secretKeyRef:
      name: secret-name
      key: secret-key

env:
  ENV_VAR:
    secretKeyRef:
      name: "{{ .Values.some.secret.name }}"
      key: "{{ .Values.some.secret.key }}"

env:
  ENV_VAR:
    secretKeyRef:
      name: secret-name
      key: secret-key
      optional: false

env:
  ENV_VAR:
    secretKeyRef:
      name: "{{ .Values.some.secret.name }}"
      key: "{{ .Values.some.secret.key }}"
      optional: false

Sets each key in the dict to:

Deployment
- spec.template.spec.containers[0].env[ENV_VAR]

envList

Sets env to the main container

Show / Hide

Type: list
Default: []
Helm Template: ✅

Examples: Values.yaml

envList:
  - name: ENV_VAR
    value: value

envList:
  - name: "{{ .Values.some.name }}"
    value: "{{ .Values.some.value }}"

Appends the list to:

Deployment
- spec.template.spec.containers[0].env

envFrom

Load envs from secret or configMap.

Show / Hide

Type: list
Default: []
Helm Template: ✅

Examples: Values.yaml

envFrom:
  - configMapRef:
      name: configmap-name

envFrom:
  - configMapRef:
      name: "{{ .Values.some.name }}"

envFrom:
  - secretRef:
      name: secret-name

envFrom:
  - secretRef:
      name: "{{ .Values.some.name }}"

Appends the list to:

Deployment
- spec.template.spec.containers[0].envFrom

17 KiB Raw Blame History

Values.yaml Explained

global

nameOverride

annotations

labels

nameOverride

podAnnotations

podLabels

command

args

extraArgs

tty

stdin

podSecurityContext

securityContext

privileged

readOnlyRootFilesystem

allowPrivilegeEscalation

runAsNonRoot

capabilities

lifecycle

termination

messagePath

messagePolicy

gracePeriodSeconds

nvidiaCaps

injectFixedEnvs

TZ

security

PUID

UMASK

env

envList

envFrom

17 KiB

Raw Blame History