Skip to content

MARKDOWN SOURCE

Raw
# Project instructions: mini-container

Build a small educational Linux container runtime demonstrating namespaces, cgroups v2, and chroot/root filesystem setup. It should launch a user-selected process from a supplied root filesystem and clearly document required Linux capabilities and safety boundaries.

## Rules for this project

- This project is independent: keep all source, tests, and configuration inside `projects/mini-container`. Do not import or copy code from another showcase.
- Use Rust `1.98.1`, pinned in this directory's `mise.toml`.
- Manage toolchains and external build tools with `mise.toml`. Pin every Rust crate to an exact version (`=x.y.z`) in `Cargo.toml`, commit `Cargo.lock`, and use locked Cargo commands. Mise does not replace Cargo's crate manifest/lockfile.
- Provide `mise run install` and `mise run run` tasks. Add a check task and run Clippy with `all` and `pedantic` enabled; fix warnings rather than suppressing them broadly.
- Implement kernel interactions directly using Rust libraries/syscalls. The runtime must not invoke Docker, Podman, nsenter, chroot, or other installed container/helper binaries. Executing the user-selected payload inside the configured root filesystem is expected.
- Fail safely when prerequisites or privileges are missing. Never run privileged tests implicitly; include unprivileged unit tests, explicit safety warnings, and a README describing limitations and manual Linux setup.

Project instructions: mini-container

Build a small educational Linux container runtime demonstrating namespaces, cgroups v2, and chroot/root filesystem setup. It should launch a user-selected process from a supplied root filesystem and clearly document required Linux capabilities and safety boundaries.

Rules for this project

  • This project is independent: keep all source, tests, and configuration inside projects/mini-container. Do not import or copy code from another showcase.
  • Use Rust 1.98.1, pinned in this directory's mise.toml.
  • Manage toolchains and external build tools with mise.toml. Pin every Rust crate to an exact version (=x.y.z) in Cargo.toml, commit Cargo.lock, and use locked Cargo commands. Mise does not replace Cargo's crate manifest/lockfile.
  • Provide mise run install and mise run run tasks. Add a check task and run Clippy with all and pedantic enabled; fix warnings rather than suppressing them broadly.
  • Implement kernel interactions directly using Rust libraries/syscalls. The runtime must not invoke Docker, Podman, nsenter, chroot, or other installed container/helper binaries. Executing the user-selected payload inside the configured root filesystem is expected.
  • Fail safely when prerequisites or privileges are missing. Never run privileged tests implicitly; include unprivileged unit tests, explicit safety warnings, and a README describing limitations and manual Linux setup.