mirror of
https://github.com/vhaudiquet/ecrou.git
synced 2026-11-12 22:22:44 +00:00
vhaudiquet
f66024bfea
The one-command install edit had replaced the whole macOS section instead of just the install lines, dropping the from-source sign snippet; it is back, with the current entitlements path and libarchive in the brew line. Homebrew's tap-trust gate now leads the macOS install: dependencies from third-party taps stay refused until their tap is trusted once, and libkrun ships from its own tap.
73 lines
2.0 KiB
Markdown
73 lines
2.0 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 trust --tap libkrun/krun
|
|
brew install vhaudiquet/ecrou/ecrou
|
|
```
|
|
|
|
The `brew trust` step is Homebrew's tap-trust gate: dependencies from
|
|
third-party taps stay refused until their tap is trusted once, and
|
|
ecrou's engine, libkrun, ships from libkrun's own tap. The macOS
|
|
build loads libkrun from that 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 libarchive
|
|
cargo build --release -p ecrou-cli
|
|
codesign --force --sign - --entitlements packaging/homebrew/ecrou.entitlements \
|
|
target/release/ecrou
|
|
```
|
|
|
|
Every local build needs that last line: cargo output is ad-hoc signed
|
|
without the entitlement, and macOS refuses VM creation to it — `ecrou
|
|
probe` says so and prints the command.
|
|
|
|
### 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))
|
|
}
|
|
```
|
|
|