diff options
| author | Claude <noreply@anthropic.com> | 2026-09-02 21:11:01 -0500 |
|---|---|---|
| committer | Claude <noreply@anthropic.com> | 2026-09-02 21:11:01 -0500 |
| commit | 9f3f9ee638e0a82960446f74345e9ee99bfec474 (patch) | |
| tree | 4028a24c0b9530f603153e715dee3badcb86166d /USER_GUIDE.md | |
| parent | f10cd386fd85386303253287d3e0c5e2a7d52124 (diff) | |
Rename the default base snapshot from "ready" to "default"
"ready" read as a status word rather than a label for what's actually a
mutable pointer to "the current recommended base image," re-tagged as it
evolves - the exact operation we did twice this session. "default" names
that role directly: it's the value --base-snapshot falls back to, nothing
more claimed.
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Diffstat (limited to 'USER_GUIDE.md')
| -rw-r--r-- | USER_GUIDE.md | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/USER_GUIDE.md b/USER_GUIDE.md index d81ae5d..587a625 100644 --- a/USER_GUIDE.md +++ b/USER_GUIDE.md @@ -293,7 +293,7 @@ Unmount devfs and snapshot once the image can actually build and run apps: ``` # umount /skiff/base/dev -# zfs snapshot zroot/skiff/base@ready +# zfs snapshot zroot/skiff/base@default # zfs create -o mountpoint=none zroot/skiff/appbase # zfs create -o mountpoint=none zroot/skiff/appdata # mkdir -p /skiff/apps @@ -320,7 +320,8 @@ Keeping the OS layer and the app's data on separate datasets is what lets `skiff rebuild` (see [Rebuilding a jail](#rebuilding-a-jail)) destroy and reclone the former without any risk to the latter. -`ready` is the snapshot every app's dataset gets cloned from. Re-snapshot +`default` is the snapshot every app's dataset gets cloned from unless +`--base-snapshot` says otherwise. Re-snapshot under a new tag after patching the base (e.g. `security-2026-08`) and pass `--base-snapshot` to `new-app` to pick it up. @@ -531,8 +532,8 @@ Current `skiff` versions self-heal this automatically (checkout runs ### Rebuilding a jail ``` -# skiff rebuild --app myapp [--base-snapshot ready] [--iface vtnet0] -# skiff rebuild --all [--base-snapshot ready] [--iface vtnet0] +# skiff rebuild --app myapp [--base-snapshot default] [--iface vtnet0] +# skiff rebuild --all [--base-snapshot default] [--iface vtnet0] ``` Every app's jail is really two independent ZFS datasets: an **OS @@ -612,7 +613,7 @@ Carried over from the project's own README, plus what testing surfaced: ``` skiff new-app --name <app> --ip <ip> [--port 8080] [--health-path /healthz] - [--base-snapshot ready] [--iface vtnet0] + [--base-snapshot default] [--iface vtnet0] skiff deploy --app <app> --new <sha> [--ref refs/heads/main] (normally invoked by the post-receive hook, not by hand) @@ -620,8 +621,8 @@ skiff deploy --app <app> --new <sha> [--ref refs/heads/main] skiff rollback --app <app> --list skiff rollback --app <app> --to <snapshot-tag> -skiff rebuild --app <app> [--base-snapshot ready] [--iface vtnet0] -skiff rebuild --all [--base-snapshot ready] [--iface vtnet0] +skiff rebuild --app <app> [--base-snapshot default] [--iface vtnet0] +skiff rebuild --all [--base-snapshot default] [--iface vtnet0] skiff config set --app <app> KEY=VALUE [KEY=VALUE...] skiff config unset --app <app> KEY [KEY...] |