mirror of
https://github.com/vhaudiquet/ecrou.git
synced 2026-11-12 22:22:44 +00:00
vhaudiquet
6a631a3707
SPEC records the two macOS facts the code bends around (bare-soname dlopens needing startup-time DYLD paths; the hypervisor entitlement) and the packaging decisions; README gains the brew install and the from-source sign step.
66 lines
1.7 KiB
Markdown
66 lines
1.7 KiB
Markdown
<p align="center">
|
|
<img src=".github/img/logo.svg" width="150" alt="écrou logo">
|
|
</p>
|
|
<h1 align="center">ecrou</h1>
|
|
<p align="center">a small microVM runtime based on <a href="https://github.com/libkrun/libkrun">libkrun</a></p>
|
|
|
|
## Try ecrou in the terminal
|
|
|
|
### Installation
|
|
|
|
Linux (strictly confined snap, KVM required):
|
|
```
|
|
sudo snap install ecrou
|
|
sudo snap connect ecrou:kvm
|
|
```
|
|
|
|
macOS (Apple Silicon, Homebrew):
|
|
```
|
|
brew tap vhaudiquet/ecrou https://github.com/vhaudiquet/homebrew-ecrou
|
|
brew install ecrou
|
|
```
|
|
|
|
The macOS build loads libkrun from the
|
|
[`libkrun/homebrew-krun`](https://github.com/libkrun/homebrew-krun) tap
|
|
at runtime and boots through Hypervisor.framework; the formula signs
|
|
the binary with the hypervisor entitlement macOS requires, so the
|
|
install needs no extra steps. Building from source instead:
|
|
|
|
```
|
|
brew install libkrun/homebrew-krun/libkrun e2fsprogs
|
|
cargo build --release -p ecrou-cli
|
|
codesign --force --sign - --entitlements packaging/macos/ecrou.entitlements target/release/ecrou
|
|
```
|
|
|
|
### Usage
|
|
|
|
```
|
|
$ ecrou run -it ubuntu
|
|
root@ecrou-vm-m2glhl:/#
|
|
```
|
|
|
|
## Embed ecrou into your project
|
|
|
|
ecrou is both a library and a tiny CLI frontend around it. The library is embeddable into any project, allowing to use microVMs easily.
|
|
|
|
### Rust
|
|
|
|
ecrou is a Rust library, which can just be called:
|
|
```rust
|
|
use ecrou::vm::RunOptions;
|
|
use ecrou::NoProgress;
|
|
|
|
fn main() -> ecrou::Result<std::process::ExitCode> {
|
|
let code = ecrou::vm::run(
|
|
&RunOptions {
|
|
image: "ubuntu:resolute".into(),
|
|
command: vec!["uname".into(), "-a".into()],
|
|
..RunOptions::default()
|
|
},
|
|
&NoProgress,
|
|
)?;
|
|
Ok(std::process::ExitCode::from(code.clamp(0, 255) as u8))
|
|
}
|
|
```
|
|
|