Skip to content

docs(local-dev): document kernel, iptables and userfaultfd prerequisites - #3660

Open
lofoneh wants to merge 1 commit into
e2b-dev:mainfrom
lofoneh:docs/dev-local-prereqs
Open

lofoneh wants to merge 1 commit into
e2b-dev:mainfrom
lofoneh:docs/dev-local-prereqs

Conversation

@lofoneh

@lofoneh lofoneh commented Sep 24, 2026

Copy link
Copy Markdown

Following DEV-LOCAL.md on a fresh Ubuntu 24.04 host, three host requirements the guide doesn't mention each stopped the local stack:

  • iptables: the orchestrator can't set up sandbox networking without it (exec: "iptables": executable file not found in $PATH).
  • vm.unprivileged_userfaultfd=1: without it, snapshot restores fail. The CI runner setup already sets this (.github/scripts/setup-arm64-runner.sh), but the guide didn't.
  • Kernel 6.8+: on 6.6 every snapshot resume fails with Failed to UFFD object because the kernel lacks UFFD_FEATURE_WP_ASYNC. E2B Embed already documents this floor; DEV-LOCAL.md now does too.

Also:

  • Corrects the WSL2 note: /dev/kvm does work on Windows 11; the real blocker is the 6.6 kernel.
  • Adds a troubleshooting entry for clickhouse-config-generated.xml getting created as a directory when docker compose up runs without make local-infra.

Following DEV-LOCAL.md on a fresh Ubuntu 24.04 host (WSL2) surfaced three
host requirements the guide does not mention, each of which stops the
local stack:

- The orchestrator needs iptables to set up sandbox networking.
- Snapshot restore needs vm.unprivileged_userfaultfd=1; the CI runner
  setup already sets it, the guide did not.
- Snapshot restore needs a kernel with UFFD_FEATURE_WP_ASYNC; on 6.6 every
  resume fails with "Failed to UFFD object". Document the 6.8 floor that
  E2B Embed already states.

Also correct the WSL2 note (KVM is available; the kernel is too old) and
add a troubleshooting entry for clickhouse-config-generated.xml being
created as a directory when docker compose is started without
make local-infra.
@cla-bot

cla-bot Bot commented Sep 24, 2026

Copy link
Copy Markdown

We require contributors to sign our Contributor License Agreement, and we don't have @lofoneh on file. You can sign our CLA at https://e2b.dev/docs/cla . Once you've signed, post a comment here that says '@cla-bot check'

@lofoneh

lofoneh commented Sep 24, 2026

Copy link
Copy Markdown
Author

@cla-bot check

@cla-bot cla-bot Bot added the cla-signed label Sep 24, 2026
@cla-bot

cla-bot Bot commented Sep 24, 2026

Copy link
Copy Markdown

The cla-bot has been summoned, and re-checked this pull request!

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant