Skip to content

docs(quickstart): add Linux inotify prerequisite note#134

Open
MichaelSp wants to merge 1 commit into
mainfrom
docs/quickstart-inotify-prerequisite
Open

docs(quickstart): add Linux inotify prerequisite note#134
MichaelSp wants to merge 1 commit into
mainfrom
docs/quickstart-inotify-prerequisite

Conversation

@MichaelSp

Copy link
Copy Markdown
Contributor

Summary

  • Adds a note in the Prerequisites section of the Quickstart guide warning Linux users to raise fs.inotify.max_user_instances before running the tutorial.
  • Provides the two sysctl commands to apply the fix immediately, plus the persistence step (/etc/sysctl.d/99-kind.conf).

Background

The default Linux inotify limit (max_user_instances=128) is exhausted when running multiple Kind clusters simultaneously. When it is hit, containerd inside the ControlPlane Kind cluster fails to initialize, which delays the API server bootstrap significantly. This in turn triggers the exponential backoff bug described in cluster-provider-kind#163: the AccessRequest controller builds up a large backoff interval before the API server becomes reachable, leaving the AccessRequest stuck in Pending for several minutes after the cluster is already healthy.

Test plan

  • Verified failure reproduces at max_user_instances=128: AccessRequest stays Pending, cluster controller logs could not find a log line matching "Reached target Multi-User System", backoff grows to 328s → 600s cap
  • Verified clean run at max_user_instances=512: full quickstart completes in under 7 minutes, AccessRequest granted on first attempt with zero errors

@MichaelSp MichaelSp requested a review from maximiliantech as a code owner June 8, 2026 15:17
The default fs.inotify.max_user_instances=128 is exhausted when running
multiple Kind clusters, causing containerd inside the ControlPlane cluster
to fail. This delays bootstrap significantly and triggers the exponential
backoff bug described in cluster-provider-kind#163.

Validated by reproducing the failure at 128 and confirming clean runs at 512.

Signed-off-by: Michael Sprauer <Michael.Sprauer@sap.com>
@MichaelSp MichaelSp force-pushed the docs/quickstart-inotify-prerequisite branch from 8916034 to cf410c9 Compare June 8, 2026 15:21
@MichaelSp MichaelSp enabled auto-merge (squash) June 9, 2026 15:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant