Skip to content

Commit 17d1451

Browse files
committed
docs: document missing LIMA_CIDATA_* environment variables
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 #2791 Signed-off-by: Bitalizer <23104115+bitalizer@users.noreply.github.com>
1 parent 917327d commit 17d1451

1 file changed

Lines changed: 33 additions & 13 deletions

File tree

website/content/en/docs/dev/internals.md

Lines changed: 33 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -173,29 +173,49 @@ The volume label is "cidata", as defined by [cloud-init NoCloud](https://docs.cl
173173
### Environment variables
174174
- `LIMA_CIDATA_DEBUG`: the value of the `--debug` flag of the `limactl start` command.
175175
- `LIMA_CIDATA_IID`: the instance ID, regenerated on every boot.
176-
- `LIMA_CIDATA_NAME`: the lima instance name
176+
- `LIMA_CIDATA_NAME`: the lima instance name.
177177
- `LIMA_CIDATA_MNT`: the mount point of the disk. `/mnt/lima-cidata`.
178-
- `LIMA_CIDATA_USER`: the username string
179-
- `LIMA_CIDATA_UID`: the numeric UID
180-
- `LIMA_CIDATA_COMMENT`: the full name or comment string
181-
- `LIMA_CIDATA_HOME`: the guest home directory
182-
- `LIMA_CIDATA_SHELL`: the guest login shell
183-
- `LIMA_CIDATA_HOSTHOME_MOUNTPOINT`: the mount point of the host home directory, or empty if not mounted
184-
- `LIMA_CIDATA_MOUNTS`: the number of the Lima mounts
185-
- `LIMA_CIDATA_MOUNTS_%d_MOUNTPOINT`: the N-th mount point of Lima mounts (N=0, 1, ...)
186-
- `LIMA_CIDATA_MOUNTTYPE`: the type of the Lima mounts ("reverse-sshfs", "9p", ...)
178+
- `LIMA_CIDATA_USER`: the username string.
179+
- `LIMA_CIDATA_UID`: the numeric UID.
180+
- `LIMA_CIDATA_COMMENT`: the full name or comment string.
181+
- `LIMA_CIDATA_HOME`: the guest home directory.
182+
- `LIMA_CIDATA_SHELL`: the guest login shell.
183+
- `LIMA_CIDATA_HOSTHOME_MOUNTPOINT`: the mount point of the host home directory, or empty if not mounted.
184+
- `LIMA_CIDATA_MOUNTS`: the number of the Lima mounts.
185+
- `LIMA_CIDATA_MOUNTS_%d_MOUNTPOINT`: the N-th mount point of Lima mounts (N=0, 1, ...).
186+
- `LIMA_CIDATA_MOUNTTYPE`: the type of the Lima mounts ("reverse-sshfs", "9p", ...).
187+
- `LIMA_CIDATA_DISKS`: the number of additional disks attached to the instance.
188+
- `LIMA_CIDATA_DISK_%d_NAME`: the name of the N-th additional disk (N=0, 1, ...).
189+
- `LIMA_CIDATA_DISK_%d_DEVICE`: the guest block device path of the N-th additional disk.
190+
- `LIMA_CIDATA_DISK_%d_FORMAT`: set to "true" when the N-th additional disk should be formatted on first boot.
191+
- `LIMA_CIDATA_DISK_%d_FSTYPE`: the filesystem type to format the N-th additional disk with (e.g. `ext4`).
192+
- `LIMA_CIDATA_DISK_%d_FSARGS`: extra arguments passed to mkfs for the N-th additional disk (space-separated).
187193
- `LIMA_CIDATA_DATAFILE_%08d_OVERWRITE`: set to "true" if the datafile should be overwritten if it already exists.
188194
- `LIMA_CIDATA_DATAFILE_%08d_OWNER`: set to the owner of the datafile.
189195
- `LIMA_CIDATA_DATAFILE_%08d_PATH`: set to the path the datafile should be copied to.
190196
- `LIMA_CIDATA_DATAFILE_%08d_PERMISSIONS`: set to the file permissions (in octal) for the datafile.
191-
- `LIMA_CIDATA_CONTAINERD_USER`: set to "1" if rootless containerd to be set up
192-
- `LIMA_CIDATA_CONTAINERD_SYSTEM`: set to "1" if system-wide containerd to be set up
193-
- `LIMA_CIDATA_CONTAINERD_ARCHIVE`: the name of the containerd archive. `nerdctl-full.tgz`
197+
- `LIMA_CIDATA_YQ_PROVISION_%08d_FORMAT`: the input format ("yaml" or "json") for the N-th yq provision step.
198+
- `LIMA_CIDATA_YQ_PROVISION_%08d_OWNER`: the owner (user[:group]) for the file produced by the N-th yq provision step.
199+
- `LIMA_CIDATA_YQ_PROVISION_%08d_PATH`: the destination path for the N-th yq provision step.
200+
- `LIMA_CIDATA_YQ_PROVISION_%08d_PERMISSIONS`: the file permissions (in octal) for the N-th yq provision step.
201+
- `LIMA_CIDATA_GUEST_INSTALL_PREFIX`: the install prefix used for guest tools (e.g. `/usr/local`).
202+
- `LIMA_CIDATA_UPGRADE_PACKAGES`: set to "1" if `upgradePackages` is enabled in `lima.yaml`, empty otherwise.
203+
- `LIMA_CIDATA_CONTAINERD_USER`: set to "1" if rootless containerd to be set up.
204+
- `LIMA_CIDATA_CONTAINERD_SYSTEM`: set to "1" if system-wide containerd to be set up.
205+
- `LIMA_CIDATA_CONTAINERD_ARCHIVE`: the name of the containerd archive. `nerdctl-full.tgz`.
194206
- `LIMA_CIDATA_SLIRP_GATEWAY`: set to the IP address of the host on the SLIRP network. `192.168.5.2`.
195207
- `LIMA_CIDATA_SLIRP_DNS`: set to the IP address of the DNS on the SLIRP network. `192.168.5.3`.
196208
- `LIMA_CIDATA_SLIRP_IP_ADDRESS`: set to the IP address of the guest on the SLIRP network. `192.168.5.15`.
197209
- `LIMA_CIDATA_UDP_DNS_LOCAL_PORT`: set to the udp port number of the hostagent dns server (or 0 when not enabled).
198210
- `LIMA_CIDATA_TCP_DNS_LOCAL_PORT`: set to the tcp port number of the hostagent dns server (or 0 when not enabled).
211+
- `LIMA_CIDATA_ROSETTA_ENABLED`: set to "true" if Rosetta x86_64 emulation is enabled in the guest (Apple Silicon, `vz` driver).
212+
- `LIMA_CIDATA_ROSETTA_BINFMT`: set to "true" if the guest should register the Rosetta binfmt_misc handler at boot.
213+
- `LIMA_CIDATA_SKIP_DEFAULT_DEPENDENCY_RESOLUTION`: set to "1" to skip Lima's built-in package dependency resolution during provisioning, empty otherwise.
214+
- `LIMA_CIDATA_VMTYPE`: the VM driver type ("qemu", "vz", "wsl2", ...), used to conditionally enable VM-specific behavior (e.g. virtiofs mounts on `vz`).
215+
- `LIMA_CIDATA_VSOCK_PORT`: the vsock port used by the guest agent (0 when vsock is not used).
216+
- `LIMA_CIDATA_VIRTIO_PORT`: the virtio-serial port name used by the guest agent (empty when virtio-serial is not used).
217+
- `LIMA_CIDATA_PLAIN`: set to "1" when the instance is in plain mode (no mounts, port forwarding, or containerd), empty otherwise.
218+
- `LIMA_CIDATA_NO_CLOUD_INIT`: set to "1" if cloud-init should be skipped on this boot, empty otherwise.
199219

200220
# VM lifecycle
201221

0 commit comments

Comments
 (0)