Skip to content

Commit 556b6e3

Browse files
committed
Minor polish to standalone-crucible doc
1 parent 8e498f8 commit 556b6e3

File tree

1 file changed

+15
-16
lines changed

1 file changed

+15
-16
lines changed

docs/standalone-with-crucible.md

+15-16
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,18 @@ crucible disks.
66
## Background: Why standalone?
77

88
In the product, the userspace VMM component for instances is
9-
[propolis-server](https://github.com/oxidecomputer/propolis/tree/master/bin/propolis-server),
10-
which exposes API endpoints for the rest of the control plane to manage
11-
instances. One can run propolis-server in isolation, such as for development,
12-
and interact with its endpoints using a
13-
client such as the [propolis
14-
CLI](https://github.com/oxidecomputer/propolis/tree/master/bin/propolis-cli).
15-
16-
17-
The
18-
[standalone](https://github.com/oxidecomputer/propolis/tree/master/bin/propolis-standalone#propolis-standalone)
19-
version of propolis is useful development tool to a VM up and running quickly
20-
without having to hit any API endpoints. It takes an input a single TOML file,
21-
sets up a unix domain socket that is connected to a VM's uart, and starts the
22-
guests when the user connects to the socket. It also cleans up the VM gracefully
23-
when the user sends CTRL+C to the running `propolis-standalone` program.
9+
[propolis-server](../bin/propolis-server), which exposes API endpoints for the
10+
rest of the control plane to manage instances. One can run propolis-server in
11+
isolation, such as for development, and interact with its endpoints using a
12+
client such as the [propolis CLI](../bin/propolis-cli).
13+
14+
15+
The [standalone](../bin/propolis-standalone) version of propolis is useful
16+
development tool to a VM up and running quickly without having to hit any API
17+
endpoints. It takes an input a single TOML file, sets up a unix domain socket
18+
that is connected to a VM's uart, and starts the guests when the user connects
19+
to the socket. It also cleans up the VM gracefully when the user sends CTRL+C
20+
to the running `propolis-standalone` program.
2421

2522
Beyond these differences, there are some differences in the state machine
2623
related to the instance lifecycle as well as the emulation.
@@ -49,6 +46,7 @@ TODO:
4946
### Onetime setup on the gimlet.
5047

5148
Setup for a virtual NIC to be used by the VM.
49+
5250
```
5351
dladm create-vnic -t -l igb0 -m 02:08:20:ac:e9:16 vnic_prop0
5452
```
@@ -109,7 +107,7 @@ standalone toml example
109107
This example file assumes you have used the above settings for block
110108
size, extent size, and extent count.
111109

112-
```
110+
```toml
113111
[main]
114112
name = "testvm"
115113
cpus = 4
@@ -151,6 +149,7 @@ pci-path = "0.6.0"
151149
```
152150

153151
Start propolis-standalone like this:
152+
154153
```
155154
propolis-standalone standalone.toml
156155
```

0 commit comments

Comments
 (0)