add common docs

2025-10-15 15:11:59 +02:00
parent 285f235bd2
commit 899cfb71b3
89 changed files with 23477 additions and 1 deletions
@@ -0,0 +1,194 @@
+---
+title: FixedEnv
+---
+
+:::note
+
+- Examples under each key are only to be used as a placement guide
+- See the [Full Examples](/truecharts-common/container/fixedenv#full-examples) section for complete examples.
+
+:::
+
+:::tip
+
+Variable names will be scanned for duplicates across all
+[secrets](/truecharts-common/secret), [configmaps](/truecharts-common/configmap),
+[env](/truecharts-common/container/env), [envList](/truecharts-common/container/envlist) and [fixedEnv](/truecharts-common/container/fixedenv)
+and will throw an error if it finds any.
+
+:::
+
+## Appears in
+
+- `.Values.workload.$name.podSpec.containers.$name`
+- `.Values.workload.$name.podSpec.initContainers.$name`
+
+---
+
+## `fixedEnv`
+
+Override fixedEnv for the container
+
+:::note
+
+By default it will set the following environment variables:
+
+- `TZ`: [Default TZ](/truecharts-common#tz) or [fixedEnv.TZ](/truecharts-common/container/fixedenv#fixedenvtz)
+- `UMASK`: [Default UMASK](/truecharts-common/securitycontext#securitycontextcontainerumask) or [fixedEnv.UMASK](/truecharts-common/container/fixedenv#fixedenvumask)
+- `UMASK_SET`: [Default UMASK](/truecharts-common/securitycontext#securitycontextcontainerumask) or [fixedEnv.UMASK](/truecharts-common/container/fixedenv#fixedenvumask)
+- `S6_READ_ONLY_ROOT`: `1`
+  - Only when [`readOnlyRootFilesystem`](/truecharts-common/container/securitycontext#securitycontextreadonlyrootfilesystem) or [`runAsNonRoot`](/truecharts-common/container/securitycontext#securitycontextrunasnonroot) is `true`
+- `PUID`, `USER_ID`, `UID`: [Default PUID](/truecharts-common/securitycontext#securitycontextcontainerpuid) or [fixedEnv.PUID](/truecharts-common/container/fixedenv#fixedenvpuid)
+  - Only when [`runAsUser`](/truecharts-common/securitycontext#securitycontextcontainerrunasuser) or [`runAsGroup`](/truecharts-common/securitycontext#securitycontextcontainerrunasgroup) is `0`
+- `PGID`, `GROUP_ID`, `GID`: Same as [`fsGroup`](/truecharts-common/securitycontext#securitycontextpodfsgroup)
+  - Only when [`runAsUser`](/truecharts-common/securitycontext#securitycontextcontainerrunasuser) or [`runAsGroup`](/truecharts-common/securitycontext#securitycontextcontainerrunasgroup) is `0`
+- `NVIDIA_DRIVER_CAPABILITIES`: [Default NVIDIA_CAPS](/truecharts-common/containeroptions#nvidia_caps) or [fixedEnv.NVIDIA_CAPS](/truecharts-common/container/fixedenv#fixedenvnvidia_caps)
+  - Only when `nvidia.com/gpu` is set to `> 0` under [`resources`](/truecharts-common/container/resources)
+
+:::
+
+|            |                                                    |
+| ---------- | -------------------------------------------------- |
+| Key        | `workload.$name.podSpec.containers.$name.fixedEnv` |
+| Type       | `map`                                              |
+| Required   | ❌                                                 |
+| Helm `tpl` | ❌                                                 |
+| Default    | `{}`                                               |
+
+Example
+
+```yaml
+workload:
+  workload-name:
+    podSpec:
+      containers:
+        container-name:
+          fixedEnv: {}
+```
+
+---
+
+### `fixedEnv.TZ`
+
+Override the timezone for the container
+
+|            |                                                       |
+| ---------- | ----------------------------------------------------- |
+| Key        | `workload.$name.podSpec.containers.$name.fixedEnv.TZ` |
+| Type       | `string`                                              |
+| Required   | ❌                                                    |
+| Helm `tpl` | ❌                                                    |
+| Default    | See [here](/truecharts-common#tz)                        |
+
+Example
+
+```yaml
+workload:
+  workload-name:
+    podSpec:
+      containers:
+        container-name:
+          fixedEnv:
+            TZ: "America/New_York"
+```
+
+---
+
+### `fixedEnv.UMASK`
+
+Override the umask for the container
+
+|            |                                                                            |
+| ---------- | -------------------------------------------------------------------------- |
+| Key        | `workload.$name.podSpec.containers.$name.fixedEnv.UMASK`                   |
+| Type       | `string`                                                                   |
+| Required   | ❌                                                                         |
+| Helm `tpl` | ❌                                                                         |
+| Default    | See [here](/truecharts-common/securitycontext/#securitycontextcontainerumask) |
+
+Example
+
+```yaml
+workload:
+  workload-name:
+    podSpec:
+      containers:
+        container-name:
+          fixedEnv:
+            UMASK: "003"
+```
+
+---
+
+### `fixedEnv.PUID`
+
+Override the PUID for the container
+
+|            |                                                                           |
+| ---------- | ------------------------------------------------------------------------- |
+| Key        | `workload.$name.podSpec.containers.$name.fixedEnv.PUID`                   |
+| Type       | `string`                                                                  |
+| Required   | ❌                                                                        |
+| Helm `tpl` | ❌                                                                        |
+| Default    | See [here](/truecharts-common/securitycontext/#securitycontextcontainerpuid) |
+
+Example
+
+```yaml
+workload:
+  workload-name:
+    podSpec:
+      containers:
+        container-name:
+          fixedEnv:
+            PUID: "0"
+```
+
+---
+
+### `fixedEnv.NVIDIA_CAPS`
+
+Override the NVIDIA_CAPS for the container
+
+|            |                                                                |
+| ---------- | -------------------------------------------------------------- |
+| Key        | `workload.$name.podSpec.containers.$name.fixedEnv.NVIDIA_CAPS` |
+| Type       | `list`                                                         |
+| Required   | ❌                                                             |
+| Helm `tpl` | ❌                                                             |
+| Default    | See [here](/truecharts-common/containeroptions#nvidia_caps)       |
+
+Example
+
+```yaml
+workload:
+  workload-name:
+    podSpec:
+      containers:
+        container-name:
+          fixedEnv:
+            NVIDIA_CAPS:
+              - compute
+```
+
+---
+
+## Full Examples
+
+```yaml
+workload:
+  workload-name:
+    enabled: true
+    primary: true
+    podSpec:
+      containers:
+        container-name:
+          enabled: true
+          primary: true
+          fixedEnv:
+            TZ: "America/New_York"
+            NVIDIA_CAPS:
+              - compute
+            UMASK: "003"
+            PUID: "0"
+```