mirror of
https://github.com/nestriness/nestri.git
synced 2026-09-19 17:25:19 +03:00
feat(build): borealis-style multi-stage rootfs for the open guest components (#309)
## What
Adds `build/` — a Dockerfile with `mesa-build`, `nestri-build`,
`os-base`, `runtime`, `runtime_prod` and `runtime_debug` stages, plus
the `etc/` overlay, `mkimage.sh` and a `Makefile` — laid out the way
[borealis](https://chromium.googlesource.com/chromiumos/overlays/board-overlays/+/main/project-borealis)
lays out its own `build/`. This moves the guest rootfs formula into this
repo, targeting the four open guest components already here: `nescope`,
`neshub`, `neswire`, `nescapture`.
## Two structural properties worth calling out
- **No privileged host chroot.** A bare `chroot` into a hand-extracted
rootfs needs `/proc`, `/sys`, `/dev` bind-mounted in first. `os-base`
here is `FROM artixlinux/artixlinux:base-openrc` directly with `pacman
-S` as plain `RUN` steps — a Docker build step already has its own
`/proc`/`/sys`/`/dev`.
- **No host-side ownership bug to guard against.** `COPY --from=` runs
as root inside the build with no invoking-user uid in the loop.
## Scope boundary
**Deliberately excludes Proton and Valve's `steamclient.so`** — both
closed, and `CLAUDE.md` forbids closed content in this repo.
`runtime_prod`, tagged `nestrilabs/nestri:base`, is a complete,
bootable, Steam-less image — and also the shared foundation other builds
start from. Whatever layers Proton/Steam on top of it is a closed build
outside this repo, by design.
## Known gap
Nothing starts a payload yet — `nesinit` isn't open code — so
`/etc/init.d/nescope` boots it in plain-compositor mode (no command
after `--`) rather than running a game. Real and testable, just not a
full session yet. Details in `build/README.md`.
## Status
Built and tagged locally as `nestrilabs/nestri:base` (podman, no
`--no-cache` issues, greptile's three findings all fixed and verified
against a real build). Not yet packed into a disk image or run inside
nesbox.
🤖 Generated with [Claude Code](https://claude.com/claude-code)
<!-- greptile_comment -->
<h3>Greptile Summary</h3>
The PR adds a multi-stage Artix/OpenRC guest-rootfs build for the open
Nestri components, with production and debug image flavors.
- Builds patched Mesa and the Rust workspace in dedicated builder
stages.
- Assembles and configures the bootable guest environment and OpenRC
services.
- Packs a selected container image into an ext4 root filesystem while
retaining rootless container storage access.
<h3>Confidence Score: 5/5</h3>
The PR appears safe to merge.
No blocking failure remains.
<h3>Important Files Changed</h3>
| Filename | Overview |
|----------|----------|
| build/Dockerfile | Defines the complete multi-stage build, overlays
repository-root-relative configuration paths, and creates production and
debug runtime targets. |
| build/Makefile | Provides consistent image build and packing targets
using a repository-root context and matching image tags. |
| build/scripts/mkimage.sh | Keeps container-runtime operations in the
invoking user's storage while escalating only filesystem creation and
mounting operations. |
| build/etc/conf.d/nestri-user-env | Supplies the shared service
environment and export function required by the OpenRC service scripts.
|
| build/etc/init.d/guest-net | Configures optional guest networking from
kernel parameters or stable defaults. |
| build/etc/init.d/neswire | Starts the audio sink after its
dependencies and pins it as the PipeWire default once the graph is
ready. |
<h3>Flowchart</h3>
```mermaid
%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[Arch builder] --> B[Mesa build]
A --> C[Nestri workspace build]
D[Artix OpenRC base] --> E[Common runtime]
B --> E
C --> E
F[build/etc overlay] --> E
E --> G[runtime_prod]
E --> H[runtime_debug]
G --> I[Container image]
H --> J[Debug container image]
I --> K[mkimage.sh]
J --> K
K --> L[ext4 rootfs]
```
<sub>Reviews (6): Last reviewed commit: ["refactor(build): rename the
published
im..."](6fecc8cc31)
| [Re-trigger
Greptile](https://app.greptile.com/api/retrigger?id=58981739)</sub>
<!-- /greptile_comment -->
This commit is contained in:
33
build/etc/init.d/dbus-session
Normal file
33
build/etc/init.d/dbus-session
Normal file
@@ -0,0 +1,33 @@
|
||||
#!/sbin/openrc-run
|
||||
|
||||
description="D-Bus session bus for nestri user"
|
||||
|
||||
nestri_export_env
|
||||
|
||||
command="/usr/bin/dbus-daemon"
|
||||
command_args="--session --address=unix:path=/run/user/1000/bus --nofork --nopidfile --print-address"
|
||||
command_user="nestri:nestri"
|
||||
command_background="yes"
|
||||
pidfile="/run/nestri/dbus-session.pid"
|
||||
|
||||
depend() {
|
||||
need xdg-runtime dbus
|
||||
before pipewire wireplumber
|
||||
}
|
||||
|
||||
start_pre() {
|
||||
checkpath -d -m 0755 -o "nestri:nestri" /run/nestri
|
||||
if [ -e "/run/user/1000/bus" ]; then
|
||||
ewarn "Removing stale bus socket"
|
||||
rm -f "/run/user/1000/bus"
|
||||
fi
|
||||
}
|
||||
|
||||
start_post() {
|
||||
local i=0
|
||||
while [ ! -S /run/user/1000/bus ] && [ $i -lt 20 ]; do
|
||||
sleep 0.1
|
||||
i=$((i+1))
|
||||
done
|
||||
[ -S /run/user/1000/bus ] || { eerror "Bus didn't appear"; return 1; }
|
||||
}
|
||||
19
build/etc/init.d/dbus-system
Normal file
19
build/etc/init.d/dbus-system
Normal file
@@ -0,0 +1,19 @@
|
||||
#!/sbin/openrc-run
|
||||
|
||||
description="D-Bus system message bus"
|
||||
|
||||
command="/usr/bin/dbus-daemon"
|
||||
command_args="--system --nofork --nopidfile"
|
||||
command_background="yes"
|
||||
pidfile="/run/dbus/dbus.pid"
|
||||
|
||||
depend() {
|
||||
need localmount xdg-runtime
|
||||
before pipewire
|
||||
}
|
||||
|
||||
start_pre() {
|
||||
checkpath -d -m 0755 -o root:root /run/dbus
|
||||
checkpath -d -m 0755 -o messagebus:messagebus /var/run/dbus 2>/dev/null || true
|
||||
dbus-uuidgen --ensure=/var/lib/dbus/machine-id
|
||||
}
|
||||
92
build/etc/init.d/guest-net
Normal file
92
build/etc/init.d/guest-net
Normal file
@@ -0,0 +1,92 @@
|
||||
#!/sbin/openrc-run
|
||||
|
||||
description="Configure the guest's network to match the host's tap"
|
||||
|
||||
# Overridden from /etc/conf.d/guest-net if present. These defaults match
|
||||
# nesbox's own defaults; if you change the `network` section in the VM's
|
||||
# JSON, change these to match.
|
||||
: ${GUEST_IFACE:=eth0}
|
||||
: ${GUEST_IP:=172.30.0.2}
|
||||
: ${GUEST_PREFIX:=24}
|
||||
: ${GUEST_GATEWAY:=172.30.0.1}
|
||||
|
||||
depend() {
|
||||
need localmount
|
||||
provide net
|
||||
keyword -shutdown
|
||||
}
|
||||
|
||||
# Read one `nestri.<key>=<value>` from the kernel command line.
|
||||
#
|
||||
# The address has to come from somewhere per-boot, because the alternative --
|
||||
# baking it into the image -- makes every guest built from that image the
|
||||
# same host on the network. Two sandboxes then collide the moment they run
|
||||
# together.
|
||||
#
|
||||
# `nestri.`-prefixed rather than the kernel's own `ip=`: that one needs
|
||||
# CONFIG_IP_PNP and exists to configure NFS root, and the prefix makes it
|
||||
# obvious whose parameter this is.
|
||||
cmdline_value() {
|
||||
local key="$1" word
|
||||
for word in $(cat /proc/cmdline 2>/dev/null); do
|
||||
case "$word" in
|
||||
"nestri.${key}="*) printf '%s' "${word#nestri.${key}=}"; return 0 ;;
|
||||
esac
|
||||
done
|
||||
return 1
|
||||
}
|
||||
|
||||
start() {
|
||||
ebegin "Bringing up loopback"
|
||||
ip link set lo up
|
||||
eend $?
|
||||
|
||||
# The command line wins over conf.d when it says anything, and conf.d is
|
||||
# the fallback so a hand-written VM config with no parameters keeps
|
||||
# working -- which is how a guest gets debugged.
|
||||
local source="/etc/conf.d/guest-net"
|
||||
local cmdline_ip
|
||||
if cmdline_ip="$(cmdline_value ip)"; then
|
||||
# Accepts address/prefix; a bare address keeps the configured prefix
|
||||
# rather than guessing one.
|
||||
case "$cmdline_ip" in
|
||||
*/*)
|
||||
GUEST_IP="${cmdline_ip%%/*}"
|
||||
GUEST_PREFIX="${cmdline_ip##*/}"
|
||||
;;
|
||||
*) GUEST_IP="$cmdline_ip" ;;
|
||||
esac
|
||||
source="kernel command line"
|
||||
fi
|
||||
|
||||
local cmdline_gw
|
||||
if cmdline_gw="$(cmdline_value gw)"; then
|
||||
GUEST_GATEWAY="$cmdline_gw"
|
||||
source="kernel command line"
|
||||
fi
|
||||
|
||||
# The VM may have been started with no network device at all, which is a
|
||||
# perfectly good configuration. Do not fail the boot over it.
|
||||
if [ ! -e "/sys/class/net/${GUEST_IFACE}" ]; then
|
||||
einfo "no ${GUEST_IFACE}: this VM has no network device"
|
||||
return 0
|
||||
fi
|
||||
|
||||
# Says which source won, because "the address is wrong" and "the address
|
||||
# came from somewhere unexpected" look identical from inside the guest.
|
||||
ebegin "Configuring ${GUEST_IFACE} as ${GUEST_IP}/${GUEST_PREFIX} via ${GUEST_GATEWAY} (from ${source})"
|
||||
# `replace` rather than `add` so a restart is not an error.
|
||||
ip link set "${GUEST_IFACE}" up &&
|
||||
ip addr replace "${GUEST_IP}/${GUEST_PREFIX}" dev "${GUEST_IFACE}" &&
|
||||
ip route replace default via "${GUEST_GATEWAY}" dev "${GUEST_IFACE}"
|
||||
eend $? "could not configure ${GUEST_IFACE}"
|
||||
}
|
||||
|
||||
stop() {
|
||||
if [ -e "/sys/class/net/${GUEST_IFACE}" ]; then
|
||||
ebegin "Bringing down ${GUEST_IFACE}"
|
||||
ip link set "${GUEST_IFACE}" down
|
||||
eend 0
|
||||
fi
|
||||
return 0
|
||||
}
|
||||
33
build/etc/init.d/nescope
Normal file
33
build/etc/init.d/nescope
Normal file
@@ -0,0 +1,33 @@
|
||||
#!/sbin/openrc-run
|
||||
|
||||
description="Nestri headless compositor"
|
||||
|
||||
nestri_export_env
|
||||
|
||||
: "${NESTRI_UID:=1000}"
|
||||
: "${NESTRI_USER:=nestri}"
|
||||
|
||||
command="/usr/bin/nescope"
|
||||
# No command after `--`: plain-compositor mode. nescope comes up and waits
|
||||
# for something to connect rather than wrapping a payload — starting one is
|
||||
# nesinit's job, and nesinit is not open code yet. See build/README.md.
|
||||
command_user="${NESTRI_USER}:${NESTRI_USER}"
|
||||
command_background="yes"
|
||||
pidfile="/run/nestri/nescope.pid"
|
||||
output_log="/nestri/logs/nescope.log"
|
||||
error_log="/nestri/logs/nescope.log"
|
||||
respawn="yes"
|
||||
respawn_delay="2"
|
||||
respawn_max="2"
|
||||
|
||||
export XDG_RUNTIME_DIR="/run/user/${NESTRI_UID}"
|
||||
|
||||
depend() {
|
||||
need xdg-runtime
|
||||
use neshub
|
||||
after xdg-runtime
|
||||
}
|
||||
|
||||
start_pre() {
|
||||
checkpath -d -m 0755 -o "${NESTRI_USER}:${NESTRI_USER}" /run/nestri
|
||||
}
|
||||
39
build/etc/init.d/neshub
Normal file
39
build/etc/init.d/neshub
Normal file
@@ -0,0 +1,39 @@
|
||||
#!/sbin/openrc-run
|
||||
|
||||
description="Nestri media hub"
|
||||
|
||||
nestri_export_env
|
||||
|
||||
: "${NESTRI_UID:=1000}"
|
||||
: "${NESTRI_USER:=nestri}"
|
||||
|
||||
command="/usr/bin/neshub"
|
||||
# Unprivileged. The old nestri-guest-hub ran as root and mounted the
|
||||
# session's filesystem itself; the open neshub does neither — per its own
|
||||
# README it only muxes the Unix sockets the other components dial into one
|
||||
# QUIC endpoint. Whatever ends up owning session mounts (nesinit, presumably)
|
||||
# is a separate, still-closed piece.
|
||||
command_user="${NESTRI_USER}:${NESTRI_USER}"
|
||||
command_background="yes"
|
||||
pidfile="/run/nestri/neshub.pid"
|
||||
|
||||
# Where neshub's output goes. /nestri/logs is a virtiofs share mounted from
|
||||
# /etc/fstab at boot, before this service starts, so a hub that fails
|
||||
# immediately still leaves a record, and the record survives the VM.
|
||||
output_log="/nestri/logs/neshub.log"
|
||||
error_log="/nestri/logs/neshub.log"
|
||||
respawn="yes"
|
||||
respawn_delay="2"
|
||||
respawn_max="2" # NO infinite — if it fails, it fails for a reason
|
||||
|
||||
export XDG_RUNTIME_DIR="/run/user/${NESTRI_UID}"
|
||||
|
||||
depend() {
|
||||
need xdg-runtime
|
||||
use net
|
||||
after xdg-runtime
|
||||
}
|
||||
|
||||
start_pre() {
|
||||
checkpath -d -m 0755 -o "${NESTRI_USER}:${NESTRI_USER}" /run/nestri
|
||||
}
|
||||
93
build/etc/init.d/neswire
Normal file
93
build/etc/init.d/neswire
Normal file
@@ -0,0 +1,93 @@
|
||||
#!/sbin/openrc-run
|
||||
|
||||
description="Nestri pipewire audio sink"
|
||||
|
||||
nestri_export_env
|
||||
|
||||
: "${NESTRI_UID:=1000}"
|
||||
: "${NESTRI_USER:=nestri}"
|
||||
|
||||
command="/usr/bin/neswire"
|
||||
command_user="${NESTRI_USER}:${NESTRI_USER}"
|
||||
command_background="yes"
|
||||
pidfile="/run/nestri/neswire.pid"
|
||||
output_log="/nestri/logs/neswire.log"
|
||||
error_log="/nestri/logs/neswire.log"
|
||||
respawn="yes"
|
||||
respawn_delay="2"
|
||||
respawn_max="2"
|
||||
|
||||
export XDG_RUNTIME_DIR="/run/user/${NESTRI_UID}"
|
||||
export DBUS_SESSION_BUS_ADDRESS="unix:path=/run/user/${NESTRI_UID}/bus"
|
||||
|
||||
depend() {
|
||||
# wireplumber is a hard dependency, not a nicety: start_post below pins
|
||||
# the default sink through the `default` metadata object, and
|
||||
# WirePlumber is what owns that object. Started concurrently, the pin
|
||||
# lands in an object pw-metadata created itself, which is destroyed the
|
||||
# moment it exits.
|
||||
need xdg-runtime dbus dbus-session pipewire wireplumber
|
||||
use neshub
|
||||
after pipewire wireplumber neshub
|
||||
}
|
||||
|
||||
start_pre() {
|
||||
checkpath -d -m 0755 -o "${NESTRI_USER}:${NESTRI_USER}" /run/nestri
|
||||
}
|
||||
|
||||
# Point the graph at neswire's sink, by name.
|
||||
#
|
||||
# `neswire` registers itself as media.class = Audio/Sink, node.name = neswire
|
||||
# ("Neswire Cloud Gaming Audio Sink"). With the hardware monitors off it is
|
||||
# the only sink, so WirePlumber's find-best hook should land on it anyway --
|
||||
# this makes it explicit rather than a consequence of there being nothing
|
||||
# else, so adding a second sink later cannot silently steal the default.
|
||||
#
|
||||
# `default.configured.audio.sink` is the metadata WirePlumber's find-selected
|
||||
# hook reads, and it takes a name; `wpctl set-default` takes a numeric object
|
||||
# id that changes every boot, which is why this uses pw-metadata instead.
|
||||
#
|
||||
# Not fatal if it fails: find-best still has one candidate. A game playing
|
||||
# into the wrong sink is silent, and a warning here is the only place that
|
||||
# would say so.
|
||||
start_post() {
|
||||
local i=0
|
||||
while [ $i -lt 50 ]; do
|
||||
pw-dump 2>/dev/null | grep -q '"node.name": "neswire"' && break
|
||||
sleep 0.1
|
||||
i=$((i+1))
|
||||
done
|
||||
if ! pw-dump 2>/dev/null | grep -q '"node.name": "neswire"'; then
|
||||
ewarn "neswire started but its sink never appeared in the graph"
|
||||
return 0
|
||||
fi
|
||||
|
||||
# Wait for WirePlumber to own the `default` metadata before writing to it.
|
||||
#
|
||||
# `need wireplumber` only guarantees its script returned, not that it has
|
||||
# built its objects. Writing too early is silently useless rather than an
|
||||
# error: pw-metadata creates the object, sets the key, exits 0, and the
|
||||
# object dies with the client. So wait for the object to exist, and say
|
||||
# so if it never does.
|
||||
i=0
|
||||
while [ $i -lt 50 ]; do
|
||||
pw-metadata -n default >/dev/null 2>&1 && break
|
||||
sleep 0.1
|
||||
i=$((i+1))
|
||||
done
|
||||
if ! pw-metadata -n default >/dev/null 2>&1; then
|
||||
ewarn "no 'default' metadata: WirePlumber is not running, sink not pinned"
|
||||
return 0
|
||||
fi
|
||||
|
||||
pw-metadata -n default 0 default.configured.audio.sink '{ "name": "neswire" }' \
|
||||
>/dev/null 2>&1
|
||||
|
||||
# Read it back. A write that did not stick is the failure this whole
|
||||
# sequence exists to catch, and it is invisible unless checked.
|
||||
if pw-metadata -n default 2>/dev/null | grep -q "neswire"; then
|
||||
einfo "default sink pinned to neswire"
|
||||
else
|
||||
ewarn "pinned neswire as default sink but it did not stick"
|
||||
fi
|
||||
}
|
||||
45
build/etc/init.d/pipewire
Normal file
45
build/etc/init.d/pipewire
Normal file
@@ -0,0 +1,45 @@
|
||||
#!/sbin/openrc-run
|
||||
|
||||
description="PipeWire multimedia daemon (system mode for nestri)"
|
||||
|
||||
nestri_export_env
|
||||
|
||||
: "${NESTRI_UID:=1000}"
|
||||
: "${NESTRI_USER:=nestri}"
|
||||
|
||||
command="/usr/bin/pipewire"
|
||||
command_user="${NESTRI_USER}:${NESTRI_USER}"
|
||||
command_background="yes"
|
||||
pidfile="/run/pipewire/pipewire.pid"
|
||||
|
||||
export XDG_RUNTIME_DIR="/run/user/${NESTRI_UID}"
|
||||
export DBUS_SESSION_BUS_ADDRESS="unix:path=/run/user/${NESTRI_UID}/bus"
|
||||
|
||||
depend() {
|
||||
need xdg-runtime dbus
|
||||
use dbus
|
||||
}
|
||||
|
||||
start_pre() {
|
||||
checkpath -d -m 0755 -o "${NESTRI_USER}:${NESTRI_USER}" /run/pipewire
|
||||
}
|
||||
|
||||
# `need pipewire` only waits for this script to return, and with
|
||||
# command_background that is the moment start-stop-daemon forks -- not the
|
||||
# moment PipeWire is accepting connections. With rc_parallel="YES" every
|
||||
# client (wireplumber, neswire) then races the socket and a client that
|
||||
# loses simply exits.
|
||||
#
|
||||
# dbus-session already solved exactly this for the bus socket. Same shape
|
||||
# here.
|
||||
start_post() {
|
||||
local i=0
|
||||
while [ ! -S "/run/user/${NESTRI_UID}/pipewire-0" ] && [ $i -lt 50 ]; do
|
||||
sleep 0.1
|
||||
i=$((i+1))
|
||||
done
|
||||
[ -S "/run/user/${NESTRI_UID}/pipewire-0" ] || {
|
||||
eerror "PipeWire socket never appeared"
|
||||
return 1
|
||||
}
|
||||
}
|
||||
20
build/etc/init.d/wireplumber
Normal file
20
build/etc/init.d/wireplumber
Normal file
@@ -0,0 +1,20 @@
|
||||
#!/sbin/openrc-run
|
||||
|
||||
description="WirePlumber session manager for PipeWire"
|
||||
|
||||
nestri_export_env
|
||||
|
||||
: "${NESTRI_UID:=1000}"
|
||||
: "${NESTRI_USER:=nestri}"
|
||||
|
||||
command="/usr/bin/wireplumber"
|
||||
command_user="${NESTRI_USER}:${NESTRI_USER}"
|
||||
command_background="yes"
|
||||
pidfile="/run/pipewire/wireplumber.pid"
|
||||
|
||||
export XDG_RUNTIME_DIR="/run/user/${NESTRI_UID}"
|
||||
|
||||
depend() {
|
||||
need pipewire
|
||||
after pipewire
|
||||
}
|
||||
44
build/etc/init.d/xdg-runtime
Normal file
44
build/etc/init.d/xdg-runtime
Normal file
@@ -0,0 +1,44 @@
|
||||
#!/sbin/openrc-run
|
||||
|
||||
description="Create runtime directories (XDG_RUNTIME_DIR, X11 socket dir..)"
|
||||
|
||||
NESTRI_UID="${NESTRI_UID:-1000}"
|
||||
NESTRI_USER="${NESTRI_USER:-nestri}"
|
||||
|
||||
depend() {
|
||||
need localmount
|
||||
before dbus pipewire
|
||||
}
|
||||
|
||||
start() {
|
||||
ebegin "Preparing runtime directories"
|
||||
|
||||
if ! getent passwd "${NESTRI_USER}" >/dev/null 2>&1; then
|
||||
eerror "User ${NESTRI_USER} does not exist"
|
||||
return 1
|
||||
fi
|
||||
|
||||
# Per-user XDG runtime dir
|
||||
mkdir -p "/run/user/${NESTRI_UID}"
|
||||
chown "${NESTRI_USER}:${NESTRI_USER}" "/run/user/${NESTRI_UID}"
|
||||
chmod 0700 "/run/user/${NESTRI_UID}"
|
||||
|
||||
# X11 socket dir (Xwayland + any X clients expect this)
|
||||
mkdir -p /tmp/.X11-unix
|
||||
chown root:root /tmp/.X11-unix
|
||||
chmod 1777 /tmp/.X11-unix
|
||||
|
||||
# ICE socket dir - some toolkits look for it
|
||||
mkdir -p /tmp/.ICE-unix
|
||||
chown root:root /tmp/.ICE-unix
|
||||
chmod 1777 /tmp/.ICE-unix
|
||||
|
||||
eend $?
|
||||
}
|
||||
|
||||
stop() {
|
||||
ebegin "Removing runtime directories"
|
||||
rm -rf "/run/user/${NESTRI_UID}"
|
||||
# Don't rm /tmp/.X11-unix on stop - other things may be using it
|
||||
eend 0
|
||||
}
|
||||
Reference in New Issue
Block a user