Skip to content

Commit bc7c165

Browse files
lexfreimyasnikovdaniil
authored andcommitted
docs(talm): document operator extension points (extra* values keys)
Talm v0.30 exposes four extra* values keys on the cozystack and generic presets for extending the rendered Talos config (kernel modules, sysctls, kubelet args, machine files) without forking the chart preset. Document the keys, their shape, the append-vs-collision-fails semantics on cozystack, and the emit-only-when-set behaviour on generic. Signed-off-by: Aleksei Sviridkin <[email protected]>
1 parent 5781e29 commit bc7c165

2 files changed

Lines changed: 54 additions & 0 deletions

File tree

  • content/en/docs

‎content/en/docs/next/install/kubernetes/talm.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -198,6 +198,33 @@ certSANs: []
198198
You don't need to fill in the node IPs at this step.
199199
Instead, you will provide them later, when you generate node configurations.
200200
201+
#### Extending the rendered Talos config (Talm v0.30+)
202+
203+
The `cozystack` preset ships curated defaults for `machine.kernel.modules`, `machine.sysctls`, `machine.kubelet.extraConfig`, and `machine.files`. Operators wanting to add to any of these without forking the chart use four `extra*` values keys:
204+
205+
| Key | Shape | Semantics on the `cozystack` preset |
206+
| --- | --- | --- |
207+
| `extraKernelModules` | list | Appended to the built-in modules (`openvswitch`, `drbd`, `zfs`, `spl`, `vfio_pci`, `vfio_iommu_type1`). Each entry is a Talos kernel-module spec. |
208+
| `extraKubeletExtraArgs` | map | Merged into `kubelet.extraConfig` after the preset's `cpuManagerPolicy: static`, `maxPods: 512`. Operator keys must NOT collide with built-ins — yaml.v3 rejects duplicate map keys on decode, so a collision fails the render with a precise hint pointing at the offending key. Fork the preset if you need a different default. |
209+
| `extraSysctls` | map | Merged into `machine.sysctls` after the preset's `gc_thresh*` entries. Same collision-fails-render contract as `extraKubeletExtraArgs`. Values must be YAML strings (Talos expects strings even for numeric sysctls). |
210+
| `extraMachineFiles` | list | Appended to the preset's CRI customization and `lvm.conf` entries. Talos rejects duplicate `path:` at apply time. |
211+
212+
Example `values.yaml` addition:
213+
214+
```yaml
215+
extraKernelModules:
216+
- name: nf_conntrack
217+
extraKubeletExtraArgs:
218+
feature-gates: "NodeSwap=true"
219+
extraSysctls:
220+
net.core.somaxconn: "65535"
221+
extraMachineFiles:
222+
- path: /etc/example.conf
223+
op: create
224+
content: "hello = world"
225+
```
226+
227+
The `generic` preset ships no defaults under any of these sections — each block emits only when the matching `extra*` key is non-empty.
201228

202229
### 2.3 Add Keycloak Configuration
203230

‎content/en/docs/v1.3/install/kubernetes/talm.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -198,6 +198,33 @@ certSANs: []
198198
You don't need to fill in the node IPs at this step.
199199
Instead, you will provide them later, when you generate node configurations.
200200
201+
#### Extending the rendered Talos config (Talm v0.30+)
202+
203+
The `cozystack` preset ships curated defaults for `machine.kernel.modules`, `machine.sysctls`, `machine.kubelet.extraConfig`, and `machine.files`. Operators wanting to add to any of these without forking the chart use four `extra*` values keys:
204+
205+
| Key | Shape | Semantics on the `cozystack` preset |
206+
| --- | --- | --- |
207+
| `extraKernelModules` | list | Appended to the built-in modules (`openvswitch`, `drbd`, `zfs`, `spl`, `vfio_pci`, `vfio_iommu_type1`). Each entry is a Talos kernel-module spec. |
208+
| `extraKubeletExtraArgs` | map | Merged into `kubelet.extraConfig` after the preset's `cpuManagerPolicy: static`, `maxPods: 512`. Operator keys must NOT collide with built-ins — yaml.v3 rejects duplicate map keys on decode, so a collision fails the render with a precise hint pointing at the offending key. Fork the preset if you need a different default. |
209+
| `extraSysctls` | map | Merged into `machine.sysctls` after the preset's `gc_thresh*` entries. Same collision-fails-render contract as `extraKubeletExtraArgs`. Values must be YAML strings (Talos expects strings even for numeric sysctls). |
210+
| `extraMachineFiles` | list | Appended to the preset's CRI customization and `lvm.conf` entries. Talos rejects duplicate `path:` at apply time. |
211+
212+
Example `values.yaml` addition:
213+
214+
```yaml
215+
extraKernelModules:
216+
- name: nf_conntrack
217+
extraKubeletExtraArgs:
218+
feature-gates: "NodeSwap=true"
219+
extraSysctls:
220+
net.core.somaxconn: "65535"
221+
extraMachineFiles:
222+
- path: /etc/example.conf
223+
op: create
224+
content: "hello = world"
225+
```
226+
227+
The `generic` preset ships no defaults under any of these sections — each block emits only when the matching `extra*` key is non-empty.
201228

202229
### 2.3 Add Keycloak Configuration
203230

0 commit comments

Comments
 (0)