Skip to content

Add docs about the new helm-controller flag #583

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
manuelbuil merged 1 commit into from
Jul 24, 2026
Merged

Add docs about the new helm-controller flag #583

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions docs/add-ons/helm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,24 @@ K3s includes a [Helm Controller](https://github.com/k3s-io/helm-controller/) tha

The [HelmChart Custom Resource](https://github.com/k3s-io/helm-controller#helm-controller) captures most of the options you would normally pass to the `helm` command-line tool.

K3s also supports passing arguments directly to the `helm-controller` process with `helm-controller-arg`.
This is useful when you want to tune controller behavior globally.

For example, to customize the CPU and memory resources allocated to Helm job pods:

```yaml
# /etc/rancher/k3s/config.yaml
helm-controller-arg:
- 'job-resources={"requests": {"cpu": "0.2", "memory": "64M"}, "limits": {"cpu": "1", "memory": "256M"}}'
```

You can specify `helm-controller-arg` multiple times in CLI form, or as a YAML list in the configuration file.

:::info Version Gate
The `helm-controller-arg` flag is available since the K3s July 2026 releases: v1.36.3+k3s1, v1.35.7+k3s1, v1.34.10+k3s1, v1.33.13+k3s2
:::


### HelmChart Field Definitions

:::note
Expand Down
2 changes: 1 addition & 1 deletion docs/cli/server.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,7 @@ OPTIONS:
--write-kubeconfig value, -o value (client) Write kubeconfig for admin client to this file [$K3S_KUBECONFIG_OUTPUT]
--write-kubeconfig-mode value (client) Write kubeconfig with this mode [$K3S_KUBECONFIG_MODE]
--write-kubeconfig-group value (client) Write kubeconfig with this group [$K3S_KUBECONFIG_GROUP]
--helm-job-image value (helm) Default image to use for helm jobs
--helm-controller-arg value (helm) Customized configuration for helm-controller process
--token value, -t value (cluster) Shared secret used to join a server or agent to a cluster [$K3S_TOKEN]
--token-file value (cluster) File containing the token [$K3S_TOKEN_FILE]
--agent-token value (cluster) Shared secret used to join agents to the cluster, but not servers [$K3S_AGENT_TOKEN]
Expand Down
Loading