docs: document missing LIMA_CIDATA_* environment variables#4904
Open
bitalizer wants to merge 1 commit into
Open
docs: document missing LIMA_CIDATA_* environment variables#4904bitalizer wants to merge 1 commit into
bitalizer wants to merge 1 commit into
Conversation
unsuman
reviewed
May 5, 2026
unsuman
reviewed
May 5, 2026
Author
|
done, added the missing periods. thanks! |
Member
|
@bitalizer Please squash the commits |
The internals page only listed a subset of the LIMA_CIDATA_* variables that lima writes into the guest's `lima.env`. Adds entries for every variable that was being emitted by `pkg/cidata/cidata.TEMPLATE.d/lima.env` but not yet documented: - additional-disk vars (DISKS, DISK_%d_NAME / DEVICE / FORMAT / FSTYPE / FSARGS) - yq-provision vars (YQ_PROVISION_%08d_FORMAT / OWNER / PATH / PERMISSIONS) - GUEST_INSTALL_PREFIX, UPGRADE_PACKAGES - ROSETTA_ENABLED, ROSETTA_BINFMT - SKIP_DEFAULT_DEPENDENCY_RESOLUTION - VMTYPE, VSOCK_PORT, VIRTIO_PORT - PLAIN, NO_CLOUD_INIT The new entries are grouped next to the related existing entries (disks near mounts, yq-provision near datafile, rosetta/vmtype/etc. after the SLIRP/DNS block) so the section reads in the same order as `lima.env` itself. Closes lima-vm#2791 Signed-off-by: Bitalizer <23104115+bitalizer@users.noreply.github.com>
bitalizer
force-pushed
the
docs-cidata-env-vars
branch
from
7269a07 to
17d1451
Compare
Author
|
squashed into a single commit. |
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
2 participants
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.
Closes #2791.
Picks up the punch list in #2791 — and a few others that drifted out of the docs since 2023. The internals page only documented a subset of the
LIMA_CIDATA_*vars that lima actually emits in pkg/cidata/cidata.TEMPLATE.d/lima.env. I diffed the env template against the docs and added an entry for every variable that was missing.What's new
LIMA_CIDATA_DISKS,LIMA_CIDATA_DISK_%d_NAME/DEVICE/FORMAT/FSTYPE/FSARGSLIMA_CIDATA_YQ_PROVISION_%08d_FORMAT/OWNER/PATH/PERMISSIONSLIMA_CIDATA_GUEST_INSTALL_PREFIX,LIMA_CIDATA_UPGRADE_PACKAGESLIMA_CIDATA_ROSETTA_ENABLED,LIMA_CIDATA_ROSETTA_BINFMTLIMA_CIDATA_SKIP_DEFAULT_DEPENDENCY_RESOLUTION,LIMA_CIDATA_VMTYPE,LIMA_CIDATA_VSOCK_PORT,LIMA_CIDATA_VIRTIO_PORTLIMA_CIDATA_PLAIN,LIMA_CIDATA_NO_CLOUD_INITThe 14 vars explicitly listed in #2791 are all covered. The extra ones (
YQ_PROVISION_*,UPGRADE_PACKAGES,NO_CLOUD_INIT) were added tolima.envafter the issue was filed and were never documented.Ordering
I kept the section's existing ordering convention — entries appear in the same order as the corresponding lines in
lima.env, with related vars grouped together (disks next to mounts, yq-provision next to datafile, etc.). The diff is purely additive; no existing line was touched.Verification
pkg/cidata/cidata.TEMPLATE.d/lima.envand the corresponding fields oncidata.TemplateArgs(inpkg/cidata/template.go) — not invented.git diff --statis1 file changed, 20 insertions(+).Happy to tweak wording or split this into per-group entries if any of them belong somewhere else (e.g. if the rosetta vars deserve a dedicated section).