Machine Files is experimental: its config and behavior may still change.
/tmp mounted at /tmp:
cat writes /tmp/fix.py on the machine, and the machine’s
python3 reads it there. Nothing is copied or synced: the file lives on the
machine.
Set Up
Mount"@<machine>" at a path to show the folder that machine has at the
same path. Here /tmp is the /tmp of machine sandbox:
- YAML
- Python
- TypeScript
workspace.yaml
/home/user/project: "@sandbox" shows the
project the machine holds there. For a folder at another path, see
Mount Block.
The name must be one under machines:. A typo such as /tmp: "@sandbx"
stops the workspace from starting and lists the names it knows:
/tmp and /dev/shm this way by itself,
unless another mount claims them:
Mount Block
"@sandbox" is short for a machine mount block. Write the block out for
what the short form cannot say: a folder at another path (root), some
machines but not all (machines), or where a new file lands
(default_machine). This shows machine sandbox’s /home/user/project at
/project:
workspace.yaml
"@sandbox" at /tmp is the same as machines: [sandbox] with
root: /tmp.
Where a Command Runs
A command whose paths all sit on one machine runs on the machine itself, in one go, and prints exactly what the machine’s own tools print. A command that also reaches the rest of the workspace runs in Mirage, which still reads and writes each machine file on its machine. With one machine, its/tmp mounted, and a ram mount at /data, whose files live in Mirage and
not on the machine:
A restricted or read-only mount, a coded file policy and a program the
machine lacks keep a command in Mirage too. /dev is Mirage’s (/dev/null,
/dev/stdin); only /dev/shm is the machine’s.
Several Machines
With several machines, the/tmp Mirage mounts by itself shows all of their
/tmp files together. /tmp: "@gpu" shows machine gpu’s only.
A name on two machines is refused as ambiguous unless the command’s program
runs on one of them.
Behavior
- Caching: none. Programs change these files behind Mirage’s back, so every read and listing asks the machine.
- Snapshots: a snapshot keeps the mount’s config; the files stay on the machines.
- Owners:
statand listings report the machine’s own owners and modes;chmod,chownandtouchapply on the machine. - Tools: the machine needs GNU
find(for-printf),cat,head,tail,ddand the coreutils sums; a stock Debian or Ubuntu image has them. - Daytona: its exec takes no input, so a write to its files is refused
(
Operation not supported), and a command that needs piped input stays with Mirage. - Serving: with
mount_type: ssh, a path the machine holds itself is never served back to it; any other machine mount is served like any mount.
SDK Guides
Python
Every config field and the VFS.md.
TypeScript
Every config field and the VFS.md.