Skip to content

Edits to worker profile description #3173

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
merged 1 commit into from
Apr 8, 2025
Merged

Edits to worker profile description #3173

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
12 changes: 6 additions & 6 deletions docs/reference/embedded-config.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -285,13 +285,13 @@ spec:
key: value
```

### Configure the Kubelet with k0s Worker Profiles
### Configure the Kubelet

k0s supports worker profiles, which allow you to configure the Kubelet with different settings for different worker nodes. One common use case for setting a worker profile is that you need more pods on a single node than the default limit of 100. In this case, you could define a worker profile to set `maxPods` to 150. Another common example is reducing startup time by setting `maxParallelImagePulls` to increase the maximum number of image pulls that can be done in parallel.
You can configure the Kubelet to customize your worker nodes with Embedded Cluster. One common use case for configuring the Kubelet is that you need more pods on a single node than the default limit of 100. In this case, you could set the `maxPods` Kubelet configuration option to 150. Another common example is reducing startup time by setting `maxParallelImagePulls` to increase the maximum number of image pulls that can be done in parallel.

When a worker profile is defined in the Embedded Cluster Config, Embedded Cluster uses the profile for every node in the cluster during initial installation and when joining nodes to the cluster.
You can customize the Kubelet configuration settings by adding a _worker profile_ in the Embedded Cluster Config under `unsupportedOverrides.k0s.config.spec.workerProfiles[]`. When a worker profile is defined, Embedded Cluster uses the profile for every node in the cluster during initial installation and when joining nodes to the cluster.

You can add a worker profile in the Embedded Cluster Config under `unsupportedOverrides.k0s.config.spec.workerProfiles[]`. The worker profile has the following required fields:
The worker profile has the following required fields:
* `name`: The name of the worker profile. Do not use the name `default` for your custom worker profile. `default` is reserved by k0s.
* `values`: The Kubelet configuration settings for the profile. For a complete list of the available Kubelet configuration options that you can set in a worker profile, see [KubeletConfiguration](https://kubernetes.io/docs/reference/config-api/kubelet-config.v1beta1/#kubelet-config-k8s-io-v1beta1-KubeletConfiguration) in the Kubernetes documentation.

Expand All @@ -312,10 +312,10 @@ spec:
k0s: |
config:
spec:
# Define a default profile that sets maxPods to 150
# Define a profile that sets maxPods to 150
workerProfiles:
# Note: Do not use the name "default"
- name: custom-maxpods
values:
maxPods: 150
```
```