Skip to content

docs: add [machine] section to config.toml reference #1708

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Jonathan5643 wants to merge 1 commit into
base: main
Choose a base branch
from
+12 −0
Open

docs: add [machine] section to config.toml reference #1708

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/container-system-config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Source of truth: [`Sources/ContainerPersistence/ContainerSystemConfig.swift`](..
[container] # default per-container resources
[dns] # default DNS domain for DNS resolution on host
[kernel] # guest kernel binary path and download URL
[machine] # default per-machine resources and home mount
[network] # default subnets for new networks
[registry] # default registry domain
[vminit] # default vminitd image to use
Expand Down Expand Up @@ -59,6 +60,17 @@ Guest kernel used when launching container VMs. Defaults change per release as k
| `binaryPath` | `String` | `"opt/kata/share/kata-containers/vmlinux-6.18.15-186"` | Path **inside** the downloaded kernel archive that points to the kernel binary. |
| `url` | `URL` | `"https://github.com/kata-containers/kata-containers/releases/download/3.28.0/kata-static-3.28.0-arm64.tar.zst"` | Archive to download when no kernel is installed. Encoded and decoded as a plain string in TOML. |

## `[machine]`

Defaults applied when `container machine create` is invoked without `--cpus`, `--memory`, or `--home-mount`.
Does not affect existing machines — use `container machine set` to change running machines.

| Key | Type | Default | Description |
|-------------|------------|------------------------------------------------------|------------------------------------------------------------------------------------|
| `cpus` | `Int` | `max(processorCount / 2, 4)` | Default CPU count per machine. |
| `memory` | [MemorySize](#memorysize-format) | Half of host physical memory (min 1 GiB) | Default RAM per machine. |
| `homeMount` | `String` | `"rw"` | Home directory mount mode: `"rw"` (read-write), `"ro"` (read-only), or `"none"` (no mount). |

## `[network]`

Default subnets used when creating networks without explicit `--subnet` / `--subnet-v6` flags.
Expand Down