Skip to content

Commit 4025747

Browse files
[minor] note to use vdev-dir in setup if it makes sense (#8735)
Added to how-to-run doc. We've only used this in deploy scripts.
1 parent bacc044 commit 4025747

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

docs/how-to-run.adoc

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -227,6 +227,27 @@ If you're using an existing external network, you likely don't need to specify a
227227
--physical-link igb0 # The physical link for your external network.
228228
----
229229

230+
When running `cargo xtask virtual-hardware create`, consider using the
231+
`--vdev-dir` option to specify where the tool will create files that will back
232+
the virtual U2/M2 devices:
233+
234+
```bash
235+
cargo xtask virtual-hardware create \
236+
--vdev-dir /scratch \
237+
--gateway-ip 192.168.1.199 \
238+
--pxa-start 192.168.1.20 \
239+
--pxa-end 192.168.1.40
240+
```
241+
242+
If the directory is changed, the `vdevs` field in
243+
`smf/sled-agent/non-gimlet/config.toml` needs to be updated to point to the
244+
new location.
245+
246+
Why is this useful? Separating vdev storage allows you to granularly control how
247+
you want to manage storage resources. For example, you can use a separate disk
248+
or partition for vdevs, which can be useful for performance and alleviating hard
249+
disk stress.
250+
230251
If you're running on a bench Gimlet, you may not need (or want) most of what `cargo xtask virtual-hardware create` does, but you do still need SoftNPU. You can tweak what resources are created with the `--scope` flag.
231252

232253
Later, you can clean up the resources created by `cargo xtask virtual-hardware create` with:

0 commit comments

Comments
 (0)