Add local development onboarding guide (gVisor + micro-VM/Lima) - #743
Open
Lucky Abolorunke (Oneimu) wants to merge 3 commits into
Open
Add local development onboarding guide (gVisor + micro-VM/Lima)#743Lucky Abolorunke (Oneimu) wants to merge 3 commits into
Lucky Abolorunke (Oneimu) wants to merge 3 commits into
Conversation
Author
|
/assign Benjamin Elder (@BenTheElder) |
2 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
There's currently no documentation for getting a working local development
environment from a fresh machine — in particular for the micro-VM runtime,
where the
/dev/kvmrequirement and asset staging make setup non-obvious, andfor macOS, where nested virtualization via Lima is undocumented. New
contributors have to reverse-engineer the
hack/scripts.What
Adds
docs/dev/onboarding.md, a single guide from zero to a working kindcluster, based on notes from real onboarding runs:
Actor / atenet-router primer and a gVisor vs micro-VM matrix, linking to
docs/architecture.mdanddocs/glossary.mdfor depth.machine with Docker.
--nested-virt(assets assembled insidethe Lima guest, since
assemble.shrequires a Linux host of the target arch)kubectl-atesetup, create/resume,routing via the atenet-router Host header, and suspend/resume state
persistence, identical for both runtimes.
during onboarding (docker/kvm permissions, PATH for
kubectl-ate, stagingbefore rustfs exists, M1 lacking FEAT_NV2, ...).
bugs rather than intended UX:
/dev/kvmprobe requires host permission changes (should probe with aroot container instead)
stage-to-rustfs.shrequires theawsCLI on the host (should run it viaDocker); a containerized alias is provided as an interim workaround
Also links the guide from
CONTRIBUTING.mdunder "Before you begin".