mirror of
https://github.com/truenas/charts.git
synced 2026-06-17 15:38:49 +08:00
126 lines
2.4 KiB
Markdown
126 lines
2.4 KiB
Markdown
# 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:
|
|
|
|
```yaml
|
|
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:
|
|
|
|
```yaml
|
|
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:
|
|
|
|
```yaml
|
|
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.
|
|
|
|
Example:
|
|
|
|
```yaml
|
|
TZ: UTC
|
|
|
|
env:
|
|
PHP_TZ: "{{ .Values.TZ }}"
|
|
```
|
|
|
|
Kubernetes Documentation:
|
|
|
|
- [environment variables](https://kubernetes.io/docs/tasks/inject-data-application/define-environment-variable-container/#define-an-environment-variable-for-a-container)
|