chart/docs/common-library/values/environment_variable.md

Environment Variable

Key: env

• Type: dict
• Default: {}
• Helm Template:
  • key: ❌
  • value: ✅
  • secretKeyRef.name: ✅
  • secretKeyRef.key: ✅
  • configMapKeyRef.name: ✅
  • configMapKeyRef.key: ✅

env dict contains environment variables and can be defined in few different formats

Examples:

env:
# Key/Value pairs
  ADMIN_PASS: password
# Key/Value pairs (tpl)
  ADMIN_PASS: "{{ .Values.app.password }}"

# ConfigMap Key Reference
  ADMIN_PASS:
    configMapKeyRef:
      name: configMap_name
      key: configMap_key
# ConfigMap Key Reference (tpl)
  ADMIN_PASS:
    configMapKeyRef:
      name: "{{ .Values.config.name }}"
      key: "{{ .Values.config.key }}"

# Secret Key Reference
  ADMIN_PASS:
    secretKeyRef:
      optional: true / false
      name: secret_name
      key: secret_key
# Secret Key Reference (tpl)
  ADMIN_PASS:
    secretKeyRef:
      optional: true / false
      name: "{{ .Values.config.name }}"
      key: "{{ .Values.config.key }}"

Key: envList

• Type: list
• Default: []
• Helm Template:
  • name: ✅
  • value: ✅

envList key is mainly designed to be used in the SCALE GUI. So users can pass additional environment variables.

Examples:

envList:
  # List entry
  - name: ADMIN_PASS
    value: password
  # List entry (tpl)
  - name: "{{ .Values.envName }}"
    value: "{{ .Values.password }}"

Key: envFrom

• Type: list
• Default: []
• Helm Template:
  • name: ✅
  • value: ✅

envFrom key is used to load multiple environment variables from a configMap or a secret. With a single list entry, it will load all keys as environment variables defined in the specified object.

Examples:

envFrom:
  # List entry
  - secretRef:
      name: secretName
  - configMapRef:
      name: configMapName
  # List entry (tpl)
  - secretRef:
      name: "{{ .Values.secretName }}"
  - configMapRef:
      name: "{{ .Values.configMapName }}"

Key: TZ

• Type: string
• Default: UTC
• Helm Template: ❌

TZ key is usually defined from the SCALE's GUI dropdown. It is also injected as environment variable into the container. It can also be used to pass timezone to other environment variables an app would use.

Only applied used when injectFixedEnvs is set to true.

Example:

TZ: UTC

env:
  PHP_TZ: "{{ .Values.TZ }}"

Key: security

• Type: dict

• Default:

  security:
    PUID: 568
    UMASK: 002
  

• Helm Template: ❌

security key is used to define a default PUID and UMASK to containers.

Only applied used when injectFixedEnvs is set to true.

Examples:

security:
  PUID: 0
  UMASK: 002

Key: nvidiaCaps

• Type: list

• Default

  nvidiaCaps:
    - all
  

• Helm Template: ❌

Defines the value of nvidia capabilities variable that will be injected in the container.

Example:

nvidiaCaps:
  - compute
  - utility

Key: injectFixedEnvs

• Type: boolean
• Default: true
• Helm Template: ❌

Injects environment variables to the container, based on conditions

TZ:

Applied always. No conditions.

UMASK, UMASK_SET:

Applied always. No conditions.

NVIDIA_VISIBLE_DEVICES:

Applied and set to void, if container has no GPU pass through.

NVIDIA_DRIVER_CAPABILITIES:

Applied when a GPU is passed through to the container. Value is defined based on the nvidiaCaps key

PGID, GROUP_ID, GID:

Applied when container runs as root user or root group. PGID, GROUP_ID, GID is always equal to fsGroup.

PUID, USER_ID, UID:

Applied when container runs as root user or root group.

S6_READ_ONLY_ROOT:

Applied when container runs as root user or root group or has readOnlyRootFilesystem set to true

Example:

injectFixedEnvs: true

Kubernetes Documentation:

• Environment Variables