Expand description
Byssus creates live, read-only filesystem attachments between isolated workspaces.
The byssusd daemon watches membership directories and reconciles the
kernel mount table against them, creating and removing read-only bind
mounts beneath a configured target root. Mount propagation carries those
mounts into already-running containers.
This library holds everything shared by the byssusd daemon and the
byssus CLI. See docs/DESIGN.md in the repository for the full design
and security contract.
Modules§
- app
- Startup logic shared by
byssusdand thebyssusCLI. - cli
- Command-line definitions for
byssusdandbyssus. - config
- Configuration loading and validation.
- daemon
- The
byssusddaemon: startup, event loop, reload and shutdown. - fsops
- Descriptor-based filesystem operations confined beneath trusted roots.
- identity
- Kernel identity of a mount, used to prove Byssus created it.
- lock
- Exclusive lock on the state directory.
- logging
- Structured
key=value(logfmt) logging to stderr. - membership
- Classification of membership directory entries.
- mount
- Mount inspection, creation, attribute enforcement and removal.
- mountinfo
- Parser for
/proc/<pid>/mountinfo. - name
- Validation of member and group names.
- notify
- systemd service notifications (
sd_notifyprotocol). - privileges
- Privilege normalization.
- probe
- Kernel feature probes and environment checks.
- reconcile
- Reconciliation of desired membership against state and the kernel.
- report
- Human- and machine-readable reports for
byssus statusandbyssus dry-run. - runtime
- Opened runtime resources: root and membership directory descriptors.
- signals
- Synchronous signal handling with
signalfd. - state
- The state file: Byssus’s record of the mounts it created.
- sys
- Raw system calls that
rustixdoes not wrap. - template
- Relative path templates such as
{name}/workspace. - users
- Service user resolution from
/etc/passwdand/etc/group. - watcher
- inotify watches on membership directories.
Constants§
- VERSION
- The crate version, as recorded in
Cargo.toml.