Skip to content

Commit 1d29776

Browse files
teohhanhuislp
authored andcommitted
Remove outdated mentions of muvm-server
Signed-off-by: Teoh Han Hui <[email protected]>
1 parent ee486ed commit 1d29776

2 files changed

Lines changed: 23 additions & 16 deletions

File tree

README.md

Lines changed: 22 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,17 @@
11
# muvm - run programs from your system in a microVM
22

3-
`muvm` allows you to run arbitrary programs from your system in a microVM. It's comprised of three small programs:
3+
`muvm` allows you to run arbitrary programs from your system in a microVM. It's comprised of 2 small programs:
44

55
- `muvm`: links against [libkrun](https://github.com/containers/libkrun) to create the microVM.
66

7-
- `muvm-guest`: acts as an entrypoint inside the microVM to set up the environment for running your program.
8-
9-
- `muvm-server`: a server listening for requests to run additional programs. This allows you to run multiple graphical applications inside the same microVM.
7+
- `muvm-guest`: acts as an entrypoint inside the microVM to set up the environment for running your program. It spawns a server listening for requests to run additional programs. This allows you to run multiple graphical applications inside the same microVM.
108

119
## Using
1210

1311
``` sh
14-
Usage: muvm [-c=CPU_LIST]... [-e=ENV]... [--mem=MEM] [--vram=VRAM] [--passt-socket=PATH] [-p=
15-
SERVER_PORT] [-f=FEX_IMAGE]... COMMAND [COMMAND_ARGS]...
12+
Usage: muvm [-c=CPU_LIST]... [-e=ENV]... [--mem=MEM] [--vram=VRAM] [--passt-socket=PATH] [-f=
13+
FEX_IMAGE]... [-m] [-i] [-t] [--privileged] [-p=<[[IP:][HOST_PORT]:]GUEST_PORT[/PROTOCOL]>]... [
14+
--emu=EMU] COMMAND [COMMAND_ARGS]...
1615

1716
Available positional items:
1817
COMMAND the command you want to execute in the vm
@@ -34,19 +33,27 @@ Available options:
3433
Machine Monitor) will attempt to return as many pages as
3534
possible to the host.
3635
[default: 80% of total RAM]
37-
--vram=VRAM The amount of Video RAM, in MiB, that will be available to this
38-
microVM.
39-
The memory configured for the microVM will not be reserved
40-
immediately. Instead, it will be provided as the guest demands
41-
it, and will be returned to the host once the guest releases
42-
the underlying resources.
43-
[default: same as the total amount of RAM in the system]
36+
--vram=VRAM The amount of Video RAM, in MiB, that will reported by userspace in
37+
this microVM.
38+
The userspace drivers will report this amount as heap size
39+
to the clients running in the microVM.
40+
[default: 50% of total RAM]
4441
--passt-socket=PATH Instead of starting passt, connect to passt socket at PATH
45-
-p, --server-port=SERVER_PORT Set the port to be used in server mode
46-
[default: 3334]
4742
-f, --fex-image=FEX_IMAGE Adds an erofs file to be mounted as a FEX rootfs.
4843
May be specified multiple times.
4944
First the base image, then overlays in order.
45+
-m, --merged-rootfs Use merged rootfs for FEX (experimental)
46+
-i, --interactive Attach to the command's stdin/out after starting it
47+
-t, --tty Allocate a tty for the command
48+
--privileged Run the command as root inside the vm.
49+
This notably does not allow root access to the host fs.
50+
-p, --publish=<[[IP:][HOST_PORT]:]GUEST_PORT[/PROTOCOL]>
51+
Publish a guest’s port, or range of ports, to the host.
52+
The syntax is similar to podman/docker.
53+
--emu=EMU Which emulator to use for running x86_64 binaries.
54+
Valid options are "box" and "fex". If this argument is not
55+
present, muvm will try to use FEX, falling back to Box if it
56+
can't be found.
5057
-h, --help Prints help information
5158
```
5259

crates/muvm/src/monitor.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ pub fn spawn_monitor() {
3939
fn set_guest_pressure(pressure: GuestPressure) -> Result<()> {
4040
if pressure == GuestPressure::Critical {
4141
debug!("requesting the guest to drop its caches");
42-
// This is a fake command that tells muvm-server to write to "/proc/sys/vm/drop_caches"
42+
// This is a fake command that tells `muvm-guest` server to write to "/proc/sys/vm/drop_caches"
4343
let command = PathBuf::from("/muvmdropcaches");
4444
let command_args = vec![];
4545
let env = HashMap::new();

0 commit comments

Comments
 (0)