Make host setup complete in one run, and let the installer run it #66
7 changed files with 368 additions and 45 deletions
69
CHANGELOG.md
69
CHANGELOG.md
|
|
@ -3,6 +3,75 @@
|
||||||
History before 0.5.0 lives in git and in [drill/RUNS.md](drill/RUNS.md),
|
History before 0.5.0 lives in git and in [drill/RUNS.md](drill/RUNS.md),
|
||||||
which records not just what changed but what each drill run proved.
|
which records not just what changed but what each drill run proved.
|
||||||
|
|
||||||
|
## Unreleased
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
|
||||||
|
- **`box setup-host` finishes in one run** (#63). When it had to add you to
|
||||||
|
`incus-admin` it stopped there and told you to re-login and re-run — an
|
||||||
|
`exit 0` that reported success having built none of the stack: no `boxnet`,
|
||||||
|
no ACL, no `box-net` profile, no firewall. It now re-execs itself under
|
||||||
|
`sg incus-admin` and completes in that one invocation. The membership check
|
||||||
|
was also asking the wrong question: `id -nG "$USER"` reads the group
|
||||||
|
database, which lists the group the moment `usermod` returns, so a
|
||||||
|
same-session re-run passed the check with credentials that still lacked the
|
||||||
|
group and died further down on a bare permission error from `incus`. Argless
|
||||||
|
`id -nG` asks the process what it actually holds.
|
||||||
|
|
||||||
|
- **`setup-host` works as root, with or without `sudo`** — every privileged
|
||||||
|
call was a hardcoded `sudo`, so on a minimal root image (no `sudo` package)
|
||||||
|
it died on `sudo: command not found` before doing anything. Privilege is now
|
||||||
|
resolved once: nothing at UID 0, `sudo` otherwise, and a clear error if
|
||||||
|
neither is possible. This is what made `install.sh`'s root path real rather
|
||||||
|
than nominal.
|
||||||
|
- **`setup-host` grants `incus-admin` to the human, not to root** — under
|
||||||
|
`sudo install.sh` it would have added `root` to the group: a no-op (UID 0
|
||||||
|
opens the socket regardless) that also left the actual user locked out of
|
||||||
|
their own boxes. It now derives the login user from `SUDO_USER`.
|
||||||
|
- **`box-firewall.service` now reports its state honestly** — the unit is
|
||||||
|
`Type=oneshot` and was missing `RemainAfterExit=yes`, so it went
|
||||||
|
`inactive (dead)` the instant it succeeded: a host whose isolation was
|
||||||
|
perfectly live read as one whose firewall unit had died. drill.sh sends you
|
||||||
|
to `systemctl status box-firewall` to diagnose exactly that, and
|
||||||
|
setup-host.sh's own comment already asserted the unit "is RemainAfterExit" —
|
||||||
|
it was not. Found by running the drill on a real host and mistrusting the
|
||||||
|
green: `nft list table bridge box` showed the drop live while the unit read
|
||||||
|
dead. `restart` was and remains correct either way.
|
||||||
|
- **`setup-host`'s apt calls can no longer hang** — a fresh cloud image has
|
||||||
|
`apt-daily`/`unattended-upgrades` holding the dpkg lock, and a plain
|
||||||
|
`apt-get install` waits on it silently and indefinitely. Now bounded
|
||||||
|
(`DPkg::Lock::Timeout=300`) and non-interactive, which matters because
|
||||||
|
`install.sh` runs it with nobody watching.
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
|
||||||
|
- **`drill.sh` proves the new contract instead of masking it** — the drill ran
|
||||||
|
`setup-host` itself right after installing, so the stack existed by its own
|
||||||
|
hand and a run passed identically whether or not `install.sh` had done a
|
||||||
|
thing; a fresh run converged the stack three times, while the messages still
|
||||||
|
described the pre-#63 "first pass may only add you to the group" behaviour.
|
||||||
|
It now asserts the post-install stack in-group before touching the host, and
|
||||||
|
runs `setup-host` exactly once more — after the clean, which deliberately
|
||||||
|
unsets `dns.mode` and so has to be converged back. `DRILL_OWNS_SETUP=1`
|
||||||
|
hands sequencing back to the drill. Pre-setup tripwires now read *before*
|
||||||
|
`install.sh`, since that is what triggers setup now.
|
||||||
|
- **`install.sh` asks, sets up the host, and no-ops on re-run** (#64) — it now
|
||||||
|
prompts *"Install box?"*, then on a fresh host installs the tree and asks a
|
||||||
|
second question, *"Set up this machine as a box host now?"*, running the whole
|
||||||
|
isolation stack if you say yes (previously it only printed a warning and left
|
||||||
|
you a command, so the install reported success and `box new` died on a host
|
||||||
|
with no Incus). Prompts read `/dev/tty`, since under `curl | bash` the script
|
||||||
|
itself is stdin; `BOX_YES=1` answers yes unattended (required where there is
|
||||||
|
no terminal), `BOX_SKIP_SETUP_HOST=1` declines the host-setup step.
|
||||||
|
- **`install.sh` never overwrites an existing install** — if box is already
|
||||||
|
installed it says so and changes nothing, so a stray re-run can no longer
|
||||||
|
clobber a working tree or rebuild the host stack under live boxes. Upgrading
|
||||||
|
is explicit: uninstall (`rm -rf ~/.local/share/box ~/.local/bin/box`, boxes
|
||||||
|
preserved first) and install fresh. This replaces the earlier version-diff
|
||||||
|
refusal with a simpler rule that dissolves the same class of errors. The
|
||||||
|
version-aware upgrade that migrates boxes instead is #67; a portable
|
||||||
|
`box export` so a box survives its own deletion is #70.
|
||||||
|
|
||||||
## 0.5.0 — 2026-07-15
|
## 0.5.0 — 2026-07-15
|
||||||
|
|
||||||
The release the project was renamed in: the repo is `heavy-duty/box`, matching
|
The release the project was renamed in: the repo is `heavy-duty/box`, matching
|
||||||
|
|
|
||||||
31
README.md
31
README.md
|
|
@ -40,14 +40,37 @@ design rationale.
|
||||||
curl -fsSL https://raw.githubusercontent.com/heavy-duty/box/main/install.sh | bash
|
curl -fsSL https://raw.githubusercontent.com/heavy-duty/box/main/install.sh | bash
|
||||||
```
|
```
|
||||||
|
|
||||||
Installs the tree to `~/.local/share/box` and links `box` onto your
|
It asks first — **"Install box?"** — then, if box is not already installed,
|
||||||
`PATH`. Re-run any time to upgrade — upgrading from a pre-0.4.0 install also
|
downloads the tree to `~/.local/share/box`, links `box` onto your `PATH`, and
|
||||||
retires the old `claudebox` symlink. (No `git clone` needed.)
|
asks a second question: **"Set up this machine as a box host now?"** Say yes and
|
||||||
|
it builds the whole isolation stack for you (it may ask for `sudo`); say no and
|
||||||
|
you can run `box setup-host` later. (No `git clone` needed.)
|
||||||
|
|
||||||
|
**Re-running is a safe no-op.** If box is already installed, the installer tells
|
||||||
|
you so and changes nothing — a stray re-run can never clobber your install or
|
||||||
|
rebuild the stack under your boxes. Upgrading is therefore explicit: uninstall
|
||||||
|
what you have and install fresh. Preserve any boxes first — `box down <box>`,
|
||||||
|
copy out anything you need (a portable `box export` is
|
||||||
|
[#70](https://github.com/heavy-duty/box/issues/70)), then `box rm <box>`
|
||||||
|
(which deletes the box *and* its snapshots) — then:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
rm -rf ~/.local/share/box ~/.local/bin/box # uninstall
|
||||||
|
curl -fsSL https://raw.githubusercontent.com/heavy-duty/box/main/install.sh | bash
|
||||||
|
```
|
||||||
|
|
||||||
|
A version-aware upgrade that migrates boxes instead of asking you to is
|
||||||
|
[#67](https://github.com/heavy-duty/box/issues/67). For unattended installs
|
||||||
|
(CI, images), `BOX_YES=1` answers every prompt yes and `BOX_SKIP_SETUP_HOST=1`
|
||||||
|
declines the host-setup step.
|
||||||
|
|
||||||
## One-time host setup (Ubuntu 24.04 / Debian 13)
|
## One-time host setup (Ubuntu 24.04 / Debian 13)
|
||||||
|
|
||||||
|
The installer already does this. Run it directly to set up a host you
|
||||||
|
installed with `BOX_SKIP_SETUP_HOST=1`, or to re-apply the stack by hand:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
box setup-host # run twice if it adds you to incus-admin (re-login between)
|
box setup-host # one run is enough
|
||||||
```
|
```
|
||||||
|
|
||||||
Idempotent. Installs Incus and creates the isolation stack: the `boxnet` NAT
|
Idempotent. Installs Incus and creates the isolation stack: the `boxnet` NAT
|
||||||
|
|
|
||||||
7
bin/box
7
bin/box
|
|
@ -387,10 +387,11 @@ EOF
|
||||||
Prepare this host to mint boxes — one time. Installs Incus and builds the
|
Prepare this host to mint boxes — one time. Installs Incus and builds the
|
||||||
isolation stack: the boxnet NAT bridge (resolver pinned), the box-isolate
|
isolation stack: the boxnet NAT bridge (resolver pinned), the box-isolate
|
||||||
ACL, the box-net profile, and the firewall rules, all re-applied at boot.
|
ACL, the box-net profile, and the firewall rules, all re-applied at boot.
|
||||||
Idempotent — safe to re-run after a box upgrade to pick up stack changes.
|
Idempotent — safe to re-run after a box upgrade to pick up stack changes;
|
||||||
|
install.sh runs it for you, so this is for re-applying by hand.
|
||||||
|
|
||||||
If it has to add you to the incus-admin group it will say so and exit; log
|
One run is enough. If it has to add you to the incus-admin group it re-runs
|
||||||
back in (or 'sg incus-admin') and run it again.
|
itself under that group — no re-login, no second invocation.
|
||||||
|
|
||||||
box setup-host
|
box setup-host
|
||||||
EOF
|
EOF
|
||||||
|
|
|
||||||
109
drill/drill.sh
109
drill/drill.sh
|
|
@ -172,6 +172,47 @@ EOF
|
||||||
fi
|
fi
|
||||||
|
|
||||||
phase "Installing box ($REPO@$REF)"
|
phase "Installing box ($REPO@$REF)"
|
||||||
|
|
||||||
|
# Sudo, up front and out loud. Later calls run unattended, and a password
|
||||||
|
# prompt swallowed by a '-qq' redirect looks exactly like a hang. This now
|
||||||
|
# has to precede the install too: install.sh runs the host setup itself, so
|
||||||
|
# the first thing needing root is no longer further down — it is inside the
|
||||||
|
# very next command.
|
||||||
|
sudo -v || { echo "drill: need sudo (the host setup installs packages and firewall rules)"; exit 1; }
|
||||||
|
|
||||||
|
# Pre-setup observations must be READ BEFORE install.sh, because install.sh
|
||||||
|
# is now what runs setup-host. Read after it and setup has already had its
|
||||||
|
# chance to act, so the observation says nothing.
|
||||||
|
# setup-host.sh installs nftables itself when neither nft nor UFW exists
|
||||||
|
# (a stock Debian 13 cloud image ships neither). This is a tripwire: if it
|
||||||
|
# fires, that fix regressed.
|
||||||
|
fw_absent_pre=0
|
||||||
|
if ! command -v nft >/dev/null 2>&1 && ! command -v ufw >/dev/null 2>&1; then
|
||||||
|
fw_absent_pre=1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# DRILL_OWNS_SETUP=1 opts out of the installer's automatic setup and puts the
|
||||||
|
# drill back in charge of sequencing it (install, then clean, then converge).
|
||||||
|
# The DEFAULT deliberately does not: a drill that runs setup-host itself right
|
||||||
|
# after installing cannot tell you whether install.sh did its job, because the
|
||||||
|
# drill's own call would build the stack either way. The default path exercises
|
||||||
|
# what a user actually runs, and asserts the result in-group below.
|
||||||
|
OWNS="${DRILL_OWNS_SETUP:-0}"
|
||||||
|
if [ "$OWNS" = 1 ]; then
|
||||||
|
export BOX_SKIP_SETUP_HOST=1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# The installer is a no-op when box is already installed — upgrading is
|
||||||
|
# uninstall-then-install, by design. The drill re-proves a tree from scratch
|
||||||
|
# every run, so it does the uninstall itself: clear any prior tree and symlink
|
||||||
|
# before installing, or install.sh would correctly refuse to touch them.
|
||||||
|
rm -rf "$HOME/.local/share/box" "$HOME/.local/bin/box"
|
||||||
|
|
||||||
|
# The installer prompts (install? set up host?) and reads /dev/tty. The drill
|
||||||
|
# runs unattended with no tty, so it answers yes to everything via BOX_YES.
|
||||||
|
# OWNS still suppresses the setup prompt via BOX_SKIP_SETUP_HOST above.
|
||||||
|
export BOX_YES=1
|
||||||
|
|
||||||
BOX_REPO="$REPO" BOX_REF="$REF" \
|
BOX_REPO="$REPO" BOX_REF="$REF" \
|
||||||
bash -c "$(curl -fsSL "https://raw.githubusercontent.com/$REPO/$REF/install.sh")" \
|
bash -c "$(curl -fsSL "https://raw.githubusercontent.com/$REPO/$REF/install.sh")" \
|
||||||
|| { echo "install failed"; exit 1; }
|
|| { echo "install failed"; exit 1; }
|
||||||
|
|
@ -195,17 +236,10 @@ EOF
|
||||||
inf "installed tree confirms: $got"
|
inf "installed tree confirms: $got"
|
||||||
|
|
||||||
phase "Host setup (Incus, boxnet, ACL, profile, firewall)"
|
phase "Host setup (Incus, boxnet, ACL, profile, firewall)"
|
||||||
# setup-host.sh installs nftables itself when neither nft nor UFW exists
|
if [ "$fw_absent_pre" = 1 ]; then
|
||||||
# (a stock Debian 13 cloud image ships neither). This guard is a tripwire:
|
|
||||||
# if it fires, that fix regressed.
|
|
||||||
if ! command -v nft >/dev/null 2>&1 && ! command -v ufw >/dev/null 2>&1; then
|
|
||||||
note "neither nft nor ufw present pre-setup — setup-host.sh must install nftables itself (it fixed this once; watch that it still does)"
|
note "neither nft nor ufw present pre-setup — setup-host.sh must install nftables itself (it fixed this once; watch that it still does)"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# Sudo, up front and out loud. Later calls run unattended, and a password
|
|
||||||
# prompt swallowed by a '-qq' redirect looks exactly like a hang.
|
|
||||||
sudo -v || { echo "drill: need sudo (the host setup installs packages and firewall rules)"; exit 1; }
|
|
||||||
|
|
||||||
# apt's lock is held by apt-daily / unattended-upgrades on a fresh cloud
|
# apt's lock is held by apt-daily / unattended-upgrades on a fresh cloud
|
||||||
# image, and 'apt-get -qq >/dev/null' waits for it in COMPLETE SILENCE —
|
# image, and 'apt-get -qq >/dev/null' waits for it in COMPLETE SILENCE —
|
||||||
# which is how run 5 looked stuck for minutes right after this header.
|
# which is how run 5 looked stuck for minutes right after this header.
|
||||||
|
|
@ -224,16 +258,57 @@ EOF
|
||||||
inf "incus already installed — skipping apt"
|
inf "incus already installed — skipping apt"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
inf "running setup-host.sh (first pass: may only add you to incus-admin)…"
|
# No setup-host call here any more. It used to run a full "first pass" that
|
||||||
~/.local/share/box/host/setup-host.sh || true
|
# the comment described as "may only add you to incus-admin" — behaviour that
|
||||||
# The group we were just added to isn't in this shell's credentials yet.
|
# no longer exists (setup-host converges in one run now, #63) and that, since
|
||||||
|
# install.sh runs setup itself (#64), was simply the stack being built a
|
||||||
|
# second time before the drill had asserted the first.
|
||||||
|
if [ "$OWNS" = 1 ]; then
|
||||||
|
# We opted out of the installer's setup, so nobody has joined us to the
|
||||||
|
# group yet. usermod ONLY: the stack build waits until after the clean
|
||||||
|
# below, which is the entire reason for owning the sequence.
|
||||||
|
inf "DRILL_OWNS_SETUP=1 — the drill owns the host setup"
|
||||||
|
id -nG | grep -qw incus-admin || sudo usermod -aG incus-admin "$USER"
|
||||||
|
else
|
||||||
|
inf "install.sh ran the host setup — asserting what it left, in-group, next"
|
||||||
|
fi
|
||||||
|
# setup-host's own sg re-exec was a CHILD of install.sh; this shell's
|
||||||
|
# credentials are untouched, so we still have to enter the group ourselves —
|
||||||
|
# once, for the remainder of the drill.
|
||||||
inf "re-entering inside the incus-admin group…"
|
inf "re-entering inside the incus-admin group…"
|
||||||
exec sg incus-admin -c "IN_GROUP=1 BOX_REPO='$REPO' BOX_REF='$REF' KEEP=$KEEP bash '$SELF' --in-group"
|
exec sg incus-admin -c "IN_GROUP=1 DRILL_OWNS_SETUP='$OWNS' BOX_REPO='$REPO' BOX_REF='$REF' KEEP=$KEEP bash '$SELF' --in-group"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
export PATH="$HOME/.local/bin:$PATH"
|
export PATH="$HOME/.local/bin:$PATH"
|
||||||
KEEP="${KEEP:-0}"
|
KEEP="${KEEP:-0}"
|
||||||
|
|
||||||
|
# PROVE THE INSTALLER'S CONTRACT (#64) — first, before the clean or anything
|
||||||
|
# else on this host mutates the stack, and before the drill runs setup-host
|
||||||
|
# itself further down. That ordering is the whole point: the old flow ran
|
||||||
|
# setup-host immediately after installing, so the stack existed by the drill's
|
||||||
|
# own hand and the run passed identically whether or not install.sh had done a
|
||||||
|
# thing. This is read-only, so it is safe with a previous run's boxes still
|
||||||
|
# attached.
|
||||||
|
if [ "${DRILL_OWNS_SETUP:-0}" != 1 ]; then
|
||||||
|
phase "Asserting the stack that install.sh built"
|
||||||
|
missing=""
|
||||||
|
incus network show boxnet >/dev/null 2>&1 || missing="$missing boxnet"
|
||||||
|
incus network acl show box-isolate >/dev/null 2>&1 || missing="$missing box-isolate"
|
||||||
|
incus profile show box-net >/dev/null 2>&1 || missing="$missing box-net"
|
||||||
|
# Last thing setup-host does, so it doubles as "it ran to the end".
|
||||||
|
sudo nft list table bridge box >/dev/null 2>&1 || missing="$missing nft-bridge-box"
|
||||||
|
if [ -n "$missing" ]; then
|
||||||
|
echo "drill: FATAL — install.sh reported success but left an INCOMPLETE stack:$missing" >&2
|
||||||
|
echo " install.sh is supposed to run the host setup itself (#64), and setup-host" >&2
|
||||||
|
echo " is supposed to converge in one run (#63). One of those did not happen." >&2
|
||||||
|
echo " reproduce with the output visible:" >&2
|
||||||
|
echo " ~/.local/share/box/host/setup-host.sh" >&2
|
||||||
|
echo " or hand setup back to the drill: DRILL_OWNS_SETUP=1 $SELF" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
ok "install.sh left a complete host stack (boxnet, box-isolate, box-net, nft bridge drop) — no second setup needed"
|
||||||
|
fi
|
||||||
|
|
||||||
# CLEAN BEFORE SETUP, not after. setup-host.sh reconfigures the network's ACLs,
|
# CLEAN BEFORE SETUP, not after. setup-host.sh reconfigures the network's ACLs,
|
||||||
# and a previous run's boxes are still ATTACHED to that network — 'incus network
|
# and a previous run's boxes are still ATTACHED to that network — 'incus network
|
||||||
# set' then has to push the change onto every live NIC, which is how run 6
|
# set' then has to push the change onto every live NIC, which is how run 6
|
||||||
|
|
@ -277,7 +352,15 @@ done
|
||||||
left="$(incus list --format csv --columns n 2>/dev/null | tr '\n' ' ')"
|
left="$(incus list --format csv --columns n 2>/dev/null | tr '\n' ' ')"
|
||||||
[ -n "$left" ] && inf "instances still on this host (not ours, left alone): $left"
|
[ -n "$left" ] && inf "instances still on this host (not ours, left alone): $left"
|
||||||
|
|
||||||
inf "running setup-host.sh (in-group pass: network, ACL, profile, firewall)…"
|
# This call stays, and it is NOT the install's setup repeated for its own sake:
|
||||||
|
# the clean above deliberately unsets dns.mode, which is part of the SHIPPED
|
||||||
|
# stack, and drops a previous run's phase-D mutations. Something has to put the
|
||||||
|
# host back together afterwards, and setup-host is that something — this is the
|
||||||
|
# "converge against a clean slate" the block above is ordered for. On the
|
||||||
|
# default path the install's setup has already been asserted, so what this
|
||||||
|
# proves is idempotency: a second run over a cleaned host is a no-op that
|
||||||
|
# restores the stack rather than a fresh build.
|
||||||
|
inf "running setup-host.sh (post-clean convergence: restores dns.mode and any reverted mutations)…"
|
||||||
if ! timeout -k 10 300 ~/.local/share/box/host/setup-host.sh; then
|
if ! timeout -k 10 300 ~/.local/share/box/host/setup-host.sh; then
|
||||||
echo "drill: setup-host.sh failed or timed out (>5 min)." >&2
|
echo "drill: setup-host.sh failed or timed out (>5 min)." >&2
|
||||||
echo " it should take seconds on a host that already has incus. usual causes:" >&2
|
echo " it should take seconds on a host that already has incus. usual causes:" >&2
|
||||||
|
|
|
||||||
|
|
@ -6,6 +6,13 @@ Wants=network.target
|
||||||
|
|
||||||
[Service]
|
[Service]
|
||||||
Type=oneshot
|
Type=oneshot
|
||||||
|
# The unit's state must mean "the rules are applied", because that is the
|
||||||
|
# question everyone asks it — drill.sh sends you to 'systemctl status
|
||||||
|
# box-firewall' to diagnose exactly that. Without this, a oneshot goes
|
||||||
|
# 'inactive (dead)' the moment it succeeds, so a host whose isolation is
|
||||||
|
# perfectly live reads as a host whose firewall unit died. setup-host.sh's
|
||||||
|
# comment already assumed this was set; it was not.
|
||||||
|
RemainAfterExit=yes
|
||||||
ExecStart=/usr/local/sbin/box-firewall
|
ExecStart=/usr/local/sbin/box-firewall
|
||||||
|
|
||||||
[Install]
|
[Install]
|
||||||
|
|
|
||||||
|
|
@ -3,17 +3,81 @@
|
||||||
# the box-net profile. Idempotent. Ubuntu 24.04 / Debian 13.
|
# the box-net profile. Idempotent. Ubuntu 24.04 / Debian 13.
|
||||||
set -euo pipefail
|
set -euo pipefail
|
||||||
|
|
||||||
here="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
|
self="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/$(basename "${BASH_SOURCE[0]}")"
|
||||||
|
here="$(dirname "$(dirname "$self")")"
|
||||||
|
|
||||||
if ! command -v incus >/dev/null; then
|
# How we reach root, decided once. 'sudo' cannot be hardcoded: at UID 0 it is
|
||||||
sudo apt-get update
|
# unnecessary, and on a minimal root image it is not installed at all — this
|
||||||
sudo apt-get install -y incus
|
# script died on 'sudo: command not found' before doing anything, which made
|
||||||
|
# install.sh's deliberate root path unusable on exactly the hosts it was for.
|
||||||
|
if [ "$(id -u)" -eq 0 ]; then
|
||||||
|
SUDO=""
|
||||||
|
elif command -v sudo >/dev/null 2>&1; then
|
||||||
|
SUDO="sudo"
|
||||||
|
else
|
||||||
|
echo "ERROR: host setup needs root and 'sudo' was not found." >&2
|
||||||
|
echo " re-run this as root: $self" >&2
|
||||||
|
exit 1
|
||||||
fi
|
fi
|
||||||
|
|
||||||
if ! id -nG "$USER" | grep -qw incus-admin; then
|
# apt, unattended-safe. install.sh now runs us without a human watching, and
|
||||||
sudo usermod -aG incus-admin "$USER"
|
# a fresh cloud image has apt-daily/unattended-upgrades holding the dpkg lock
|
||||||
echo "NOTE: added $USER to incus-admin — re-login (or 'sg incus-admin') and re-run."
|
# for the first minutes of its life — plain 'apt-get install' then waits on it
|
||||||
exit 0
|
# in complete silence, indefinitely. Bound the wait and never prompt.
|
||||||
|
# 'env', not a bare VAR=val prefix: bash recognises assignments at PARSE time,
|
||||||
|
# so with $SUDO empty (we are root) 'DEBIAN_FRONTEND=x apt-get' would have
|
||||||
|
# already been parsed as a plain word and bash would try to EXECUTE it —
|
||||||
|
# 'DEBIAN_FRONTEND=noninteractive: command not found'. env is immune.
|
||||||
|
apt_get() {
|
||||||
|
$SUDO env DEBIAN_FRONTEND=noninteractive apt-get -o DPkg::Lock::Timeout=300 "$@"
|
||||||
|
}
|
||||||
|
|
||||||
|
if ! command -v incus >/dev/null; then
|
||||||
|
apt_get update
|
||||||
|
apt_get install -y incus
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ "$(id -u)" -eq 0 ]; then
|
||||||
|
# Root needs no group: UID 0 opens /var/lib/incus/unix.socket regardless of
|
||||||
|
# who owns it, and there is nothing to re-exec into. The HUMAN needs it — and
|
||||||
|
# under 'sudo install.sh' that is SUDO_USER, not the root we are running as.
|
||||||
|
# Adding root to incus-admin would be a no-op that also left the actual user
|
||||||
|
# locked out of their own boxes.
|
||||||
|
# NOTE: 'id -nG "$name"' here is deliberate and NOT the bug fixed below. That
|
||||||
|
# bug was asking the DATABASE about our own process; this asks the database
|
||||||
|
# about someone else's account, which is the only thing it can be asked.
|
||||||
|
login_user="${SUDO_USER:-}"
|
||||||
|
if [ -n "$login_user" ] && [ "$login_user" != root ]; then
|
||||||
|
if ! id -nG "$login_user" | grep -qw incus-admin; then
|
||||||
|
usermod -aG incus-admin "$login_user"
|
||||||
|
echo "added $login_user to incus-admin — log out and back in for your shell to pick it up"
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
# Group membership is a property of THIS PROCESS's credentials, not of the group
|
||||||
|
# database — and the two disagree for exactly as long as it matters here.
|
||||||
|
# 'id -nG "$USER"' names a user, so it reads /etc/group and reports incus-admin
|
||||||
|
# the instant usermod returns; the running shell's own credentials still lack
|
||||||
|
# it, because supplementary groups are fixed at login. So the old check passed
|
||||||
|
# on a same-session re-run, sailed into the incus calls below, and died on a
|
||||||
|
# permission error that named neither the group nor the re-login. Argless
|
||||||
|
# 'id -nG' asks the process what it actually holds, which is what incus checks
|
||||||
|
# when it opens /var/lib/incus/unix.socket.
|
||||||
|
elif ! id -nG | grep -qw incus-admin; then
|
||||||
|
$SUDO usermod -aG incus-admin "$USER"
|
||||||
|
# Then finish the job rather than adjourning it. Exiting 0 here was a
|
||||||
|
# success-shaped no-op: no boxnet, no ACL, no box-net profile, no firewall —
|
||||||
|
# and the burden of knowing that on the reader of a NOTE (#63). 'sg' runs us
|
||||||
|
# again with the new group in our credentials, no re-login, one invocation.
|
||||||
|
# The guard makes that at most one hop: if sg somehow lands without the
|
||||||
|
# group, we fail loudly instead of forking forever.
|
||||||
|
if [ -z "${BOX_SETUP_HOST_REEXEC:-}" ]; then
|
||||||
|
echo "added $USER to incus-admin — re-running under the new group (no re-login needed)"
|
||||||
|
export BOX_SETUP_HOST_REEXEC=1
|
||||||
|
exec sg incus-admin -c "$(printf '%q ' bash "$self" "$@")"
|
||||||
|
fi
|
||||||
|
echo "ERROR: still not in incus-admin after usermod + sg." >&2
|
||||||
|
echo " log out and back in, then re-run: box setup-host" >&2
|
||||||
|
exit 1
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# Storage pool + base config (safe to re-run: skipped once the pool exists).
|
# Storage pool + base config (safe to re-run: skipped once the pool exists).
|
||||||
|
|
@ -28,7 +92,7 @@ fi
|
||||||
# says so.
|
# says so.
|
||||||
if ! incus storage show default >/dev/null 2>&1; then
|
if ! incus storage show default >/dev/null 2>&1; then
|
||||||
driver=btrfs
|
driver=btrfs
|
||||||
command -v mkfs.btrfs >/dev/null 2>&1 || sudo apt-get install -y btrfs-progs || driver=dir
|
command -v mkfs.btrfs >/dev/null 2>&1 || apt_get install -y btrfs-progs || driver=dir
|
||||||
if ! incus admin init --preseed <<PRESEED
|
if ! incus admin init --preseed <<PRESEED
|
||||||
storage_pools:
|
storage_pools:
|
||||||
- name: default
|
- name: default
|
||||||
|
|
@ -117,19 +181,19 @@ incus network set boxnet raw.dnsmasq \
|
||||||
# The no-UFW path drives nft directly, and a stock Debian 13 cloud image ships
|
# The no-UFW path drives nft directly, and a stock Debian 13 cloud image ships
|
||||||
# neither nftables nor UFW — install the dependency we are about to use.
|
# neither nftables nor UFW — install the dependency we are about to use.
|
||||||
if ! command -v ufw >/dev/null 2>&1 && ! command -v nft >/dev/null 2>&1; then
|
if ! command -v ufw >/dev/null 2>&1 && ! command -v nft >/dev/null 2>&1; then
|
||||||
sudo apt-get install -y nftables
|
apt_get install -y nftables
|
||||||
fi
|
fi
|
||||||
sudo install -m 755 "$here/host/box-firewall.sh" /usr/local/sbin/box-firewall
|
$SUDO install -m 755 "$here/host/box-firewall.sh" /usr/local/sbin/box-firewall
|
||||||
sudo install -m 644 "$here/host/box-firewall.service" /etc/systemd/system/
|
$SUDO install -m 644 "$here/host/box-firewall.service" /etc/systemd/system/
|
||||||
sudo systemctl daemon-reload
|
$SUDO systemctl daemon-reload
|
||||||
sudo systemctl enable box-firewall.service
|
$SUDO systemctl enable box-firewall.service
|
||||||
# RESTART, not 'enable --now'. The unit is RemainAfterExit, so once it has run
|
# RESTART, not 'enable --now'. The unit is RemainAfterExit, so once it has run
|
||||||
# it stays "active" forever — and 'enable --now' does nothing to an active unit.
|
# it stays "active" forever — and 'enable --now' does nothing to an active unit.
|
||||||
# Re-running setup-host after upgrading the tool therefore installed the new
|
# Re-running setup-host after upgrading the tool therefore installed the new
|
||||||
# rules to /usr/local/sbin and never applied them: the host kept the old
|
# rules to /usr/local/sbin and never applied them: the host kept the old
|
||||||
# firewall, silently, and the box→box hole stayed open through a release that
|
# firewall, silently, and the box→box hole stayed open through a release that
|
||||||
# claimed to close it. Restart re-runs the script, which is idempotent by design.
|
# claimed to close it. Restart re-runs the script, which is idempotent by design.
|
||||||
sudo systemctl restart box-firewall.service
|
$SUDO systemctl restart box-firewall.service
|
||||||
|
|
||||||
# Profile — box-net, the placement contract: the isolated NIC and the root
|
# Profile — box-net, the placement contract: the isolated NIC and the root
|
||||||
# disk, nothing a template controls (resources are stamped per-instance from
|
# disk, nothing a template controls (resources are stamped per-instance from
|
||||||
|
|
@ -143,7 +207,7 @@ incus profile edit box-net < "$here/profiles/box-net.yaml"
|
||||||
|
|
||||||
# The sibling drop is the one rule whose absence is invisible: everything keeps
|
# The sibling drop is the one rule whose absence is invisible: everything keeps
|
||||||
# working, and boxes can simply reach each other. Assert it landed.
|
# working, and boxes can simply reach each other. Assert it landed.
|
||||||
if sudo nft list table bridge box >/dev/null 2>&1; then
|
if $SUDO nft list table bridge box >/dev/null 2>&1; then
|
||||||
echo "Isolation: box-to-box drop is live (nft bridge table 'box')."
|
echo "Isolation: box-to-box drop is live (nft bridge table 'box')."
|
||||||
else
|
else
|
||||||
echo "WARNING: the box-to-box drop is NOT active — boxes can reach each other." >&2
|
echo "WARNING: the box-to-box drop is NOT active — boxes can reach each other." >&2
|
||||||
|
|
|
||||||
92
install.sh
92
install.sh
|
|
@ -17,10 +17,50 @@ log() { printf 'box-install: %s\n' "$*"; }
|
||||||
warn() { printf 'box-install: WARNING: %s\n' "$*" >&2; }
|
warn() { printf 'box-install: WARNING: %s\n' "$*" >&2; }
|
||||||
die() { printf 'box-install: ERROR: %s\n' "$*" >&2; exit 1; }
|
die() { printf 'box-install: ERROR: %s\n' "$*" >&2; exit 1; }
|
||||||
|
|
||||||
|
# Ask a yes/no question and echo the answer. The wrinkle: under the intended
|
||||||
|
# 'curl … | bash', THIS SCRIPT is stdin — so a plain 'read' would consume the
|
||||||
|
# installer's own remaining lines, not the user's keystroke. Prompts therefore
|
||||||
|
# read the terminal directly via /dev/tty. When there is no terminal at all (CI,
|
||||||
|
# a pipe with no tty), there is nobody to ask: BOX_YES=1 means "assume yes to
|
||||||
|
# every prompt" and is how automation and the drill drive this unattended;
|
||||||
|
# without it we refuse rather than silently assume consent.
|
||||||
|
confirm() { # $1 = question
|
||||||
|
[ -n "${BOX_YES:-}" ] && return 0
|
||||||
|
if ! { true >/dev/tty; } 2>/dev/null; then
|
||||||
|
die "no terminal to confirm on. Re-run with BOX_YES=1 to proceed non-interactively (assumes yes to all prompts)."
|
||||||
|
fi
|
||||||
|
local reply
|
||||||
|
printf 'box-install: %s [y/N] ' "$1" >/dev/tty
|
||||||
|
read -r reply </dev/tty || reply=""
|
||||||
|
case "$reply" in y|Y|yes|YES) return 0 ;; *) return 1 ;; esac
|
||||||
|
}
|
||||||
|
|
||||||
# --- prerequisites ---------------------------------------------------------
|
# --- prerequisites ---------------------------------------------------------
|
||||||
command -v curl >/dev/null 2>&1 || die "curl is required but was not found. Please install curl and re-run."
|
command -v curl >/dev/null 2>&1 || die "curl is required but was not found. Please install curl and re-run."
|
||||||
command -v tar >/dev/null 2>&1 || die "tar is required but was not found. Please install tar and re-run."
|
command -v tar >/dev/null 2>&1 || die "tar is required but was not found. Please install tar and re-run."
|
||||||
|
|
||||||
|
# --- confirm, then no-op if already installed ------------------------------
|
||||||
|
# Prompt BEFORE downloading anything: the first thing a curl|bash should do is
|
||||||
|
# ask whether you meant to. Then, if box is already installed, this run changes
|
||||||
|
# nothing and says so — a re-run is a safe no-op, which dissolves the whole
|
||||||
|
# "curl clobbered my working install / rebuilt the stack under my boxes" class
|
||||||
|
# of failures. Upgrading is deliberately NOT an in-place overwrite: you uninstall
|
||||||
|
# what you have (dealing with your boxes as you do) and install fresh.
|
||||||
|
confirm "Install box from $REPO@$REF?" || die "cancelled — nothing was changed."
|
||||||
|
|
||||||
|
if [ -e "$BINDIR/box" ] || [ -x "$DEST/bin/box" ]; then
|
||||||
|
cur="$(cat "$DEST/INSTALLED_FROM" 2>/dev/null || echo '<unknown source>')"
|
||||||
|
cur_ver="$(cat "$DEST/VERSION" 2>/dev/null || echo '?')"
|
||||||
|
log "box is already installed ($cur, version $cur_ver) — nothing to do."
|
||||||
|
log "To install a different version, remove the current one first:"
|
||||||
|
log " · preserve any boxes you care about — 'box down <box>', then keep them"
|
||||||
|
log " (a portable 'box export' is #70; for now copy what you need OUT via"
|
||||||
|
log " 'box shell'/'box exec'), and 'box rm <box>' when you are done"
|
||||||
|
log " · uninstall: rm -rf \"$DEST\" \"$BINDIR/box\""
|
||||||
|
log " · then re-run this installer"
|
||||||
|
exit 0
|
||||||
|
fi
|
||||||
|
|
||||||
# --- temp workspace --------------------------------------------------------
|
# --- temp workspace --------------------------------------------------------
|
||||||
TMPDIR="$(mktemp -d)"
|
TMPDIR="$(mktemp -d)"
|
||||||
cleanup() { rm -rf "$TMPDIR"; }
|
cleanup() { rm -rf "$TMPDIR"; }
|
||||||
|
|
@ -47,9 +87,10 @@ EXTRACTED="$(find "$TMPDIR" -mindepth 1 -maxdepth 1 -type d | head -n1)"
|
||||||
[ -n "$EXTRACTED" ] || die "could not find the extracted source directory in archive"
|
[ -n "$EXTRACTED" ] || die "could not find the extracted source directory in archive"
|
||||||
[ -f "$EXTRACTED/bin/box" ] || die "archive does not contain bin/box — is $REPO@$REF correct?"
|
[ -f "$EXTRACTED/bin/box" ] || die "archive does not contain bin/box — is $REPO@$REF correct?"
|
||||||
|
|
||||||
# --- atomically replace $DEST ---------------------------------------------
|
# --- install into $DEST ----------------------------------------------------
|
||||||
|
# Reached only on a host with no existing install (the no-op check above
|
||||||
|
# exits otherwise), so this is always a fresh tree, never an overwrite.
|
||||||
log "installing into $DEST"
|
log "installing into $DEST"
|
||||||
rm -rf "$DEST"
|
|
||||||
mkdir -p "$(dirname "$DEST")"
|
mkdir -p "$(dirname "$DEST")"
|
||||||
mv "$EXTRACTED" "$DEST"
|
mv "$EXTRACTED" "$DEST"
|
||||||
|
|
||||||
|
|
@ -84,16 +125,51 @@ case ":$PATH:" in
|
||||||
;;
|
;;
|
||||||
esac
|
esac
|
||||||
|
|
||||||
# --- environment check -----------------------------------------------------
|
|
||||||
if ! command -v incus >/dev/null 2>&1; then
|
|
||||||
warn "incus was not found. box needs Incus on the host."
|
|
||||||
warn " run the one-time host setup: $DEST/host/setup-host.sh"
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Record WHAT was installed, so a caller can assert it got what it asked for.
|
# Record WHAT was installed, so a caller can assert it got what it asked for.
|
||||||
# Without this, an installer invoked with stale env vars (the CLAUDEBOX_* names
|
# Without this, an installer invoked with stale env vars (the CLAUDEBOX_* names
|
||||||
# retired in 0.5.0) silently falls back to the defaults and installs main —
|
# retired in 0.5.0) silently falls back to the defaults and installs main —
|
||||||
# and the caller drills the wrong tree, believing it drilled its branch.
|
# and the caller drills the wrong tree, believing it drilled its branch.
|
||||||
|
# Written BEFORE host setup: this records the install, which has now happened,
|
||||||
|
# and it must not hinge on whether the host stack came up.
|
||||||
printf '%s@%s\n' "$REPO" "$REF" > "$DEST/INSTALLED_FROM"
|
printf '%s@%s\n' "$REPO" "$REF" > "$DEST/INSTALLED_FROM"
|
||||||
|
|
||||||
|
# --- host setup (second prompt) --------------------------------------------
|
||||||
|
# The tool is installed; the machine is not yet a box host. Offer to finish the
|
||||||
|
# job — build Incus and the isolation stack — rather than leave 'box new' to die
|
||||||
|
# later on a host with no boxnet and no profile (#64). This is its own decision:
|
||||||
|
# you might be installing the CLI on a workstation and hosting boxes elsewhere.
|
||||||
|
# BOX_SKIP_SETUP_HOST=1 answers "no" without prompting (image builds, a host set
|
||||||
|
# up by hand); BOX_YES answers "yes".
|
||||||
|
setup_ok=""
|
||||||
|
setup_declined=""
|
||||||
|
if [ -n "${BOX_SKIP_SETUP_HOST:-}" ]; then
|
||||||
|
log "skipping host setup (BOX_SKIP_SETUP_HOST is set)."
|
||||||
|
setup_declined=1
|
||||||
|
elif [ "$(id -u)" -ne 0 ] && ! command -v sudo >/dev/null 2>&1; then
|
||||||
|
warn "cannot set up the host: it needs root and sudo was not found."
|
||||||
|
warn " run this as root to finish: $DEST/host/setup-host.sh"
|
||||||
|
setup_declined=1
|
||||||
|
elif confirm "Set up this machine as a box host now? (installs Incus + the isolation stack; needs sudo)"; then
|
||||||
|
# </dev/null because under 'curl … | bash' this script IS stdin: a child that
|
||||||
|
# reads stdin eats the installer's own remaining lines. sudo is unaffected —
|
||||||
|
# it prompts on /dev/tty, so an interactive host can still authenticate.
|
||||||
|
# setup-host re-execs itself under sg incus-admin if it must add you to the
|
||||||
|
# group; that re-exec is a child here and completes the whole setup in one go.
|
||||||
|
if bash "$DEST/host/setup-host.sh" </dev/null; then
|
||||||
|
setup_ok=1
|
||||||
|
else
|
||||||
|
warn "host setup did not complete — box is installed, the host is not ready."
|
||||||
|
warn " fix the error above and re-run: box setup-host"
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
log "skipped host setup."
|
||||||
|
setup_declined=1
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ -n "$setup_ok" ]; then
|
||||||
log "done ($REPO@$REF) — try: box new --name test"
|
log "done ($REPO@$REF) — try: box new --name test"
|
||||||
|
elif [ -n "$setup_declined" ]; then
|
||||||
|
log "done ($REPO@$REF) — when you want this machine to host boxes: box setup-host"
|
||||||
|
else
|
||||||
|
log "done ($REPO@$REF) — finish with 'box setup-host', then: box new --name test"
|
||||||
|
fi
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue