Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,8 @@ sudo install -m 0755 bpfcompat-linux-amd64 /usr/local/bin/bpfcompat
bpfcompat version
```

![Installing bpfcompat from a prebuilt release binary](docs/images/install/install-release-binary.png)

**2. From source.** Builds both the CLI and the validator and gives a binary
stamped with the real version:

Expand All @@ -164,6 +166,8 @@ make build && make validator-static
./bin/bpfcompat version
```

![Installing bpfcompat from source](docs/images/install/install-from-source.png)

**3. `go install` (CLI only).** Note the module path is **lowercase** and the
command **must** point at the `cmd/bpfcompat` subpackage — the module root has
no `main` package, so `go install github.com/Kernel-Guard/bpfcompat@latest`
Expand All @@ -178,6 +182,17 @@ This installs the orchestrator CLI only (it reports version `0.1.0-dev` because
still need the validator binary (from a release or `make validator-static`) and
a kernel matrix — use option 1 or 2 for that.

![Installing bpfcompat with go install](docs/images/install/install-go-install.png)

### What a run looks like

Once installed, `bpfcompat test` boots each kernel in a disposable VM and reports
a per-kernel pass/fail matrix — here the `ringbuf_modern` example across three
kernels, correctly failing on 5.4 (ring buffer support lands in 5.8) and passing
on 6.1 and 6.8:

![A bpfcompat validation run across three kernels](docs/images/install/live-validation.png)

## Prerequisites

For the main QEMU path:
Expand Down
Binary file added docs/images/install/install-from-source.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/install/install-go-install.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/install/install-release-binary.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/install/live-validation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.