Add adoption-focused examples, contract docs, and CLI polish
This commit is contained in:
parent
227983a877
commit
0aa5e25dc1
18 changed files with 560 additions and 2 deletions
32
docs/host-requirements.md
Normal file
32
docs/host-requirements.md
Normal file
|
|
@ -0,0 +1,32 @@
|
|||
# Host Requirements
|
||||
|
||||
`pyro-mcp` currently targets Linux x86_64 hosts.
|
||||
|
||||
## Required
|
||||
|
||||
- KVM available at `/dev/kvm`
|
||||
- support for Firecracker microVMs
|
||||
- sufficient disk for the bundled runtime images
|
||||
|
||||
## Required For Guest Networking
|
||||
|
||||
- `/dev/net/tun`
|
||||
- `ip`
|
||||
- `nft` or `iptables`
|
||||
- host IP forwarding enabled
|
||||
- privilege to create TAP devices and NAT rules
|
||||
|
||||
The current implementation uses `sudo -n` for host networking commands when a networked run is requested.
|
||||
|
||||
## Validate The Host
|
||||
|
||||
```bash
|
||||
pyro doctor
|
||||
```
|
||||
|
||||
Check these fields in the output:
|
||||
|
||||
- `runtime_ok`
|
||||
- `kvm`
|
||||
- `networking.tun_available`
|
||||
- `networking.ip_forward_enabled`
|
||||
Loading…
Add table
Add a link
Reference in a new issue