Skip to content

Commit

Permalink
Skeleton docs for using propolis with crucible disks in isolation
Browse files Browse the repository at this point in the history
  • Loading branch information
jordanhendricks committed Aug 14, 2023
1 parent 0672564 commit 40d2fd5
Showing 1 changed file with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions docs/standalone-with-crucible.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Run propolis-standalone with crucible disks

This document serves as an overview for running propolis-standalone using
crucible disks.

## Background: Why standalone?

In the product, the userspace VMM component for instances is
[propolis-server](https://github.com/oxidecomputer/propolis/tree/master/bin/propolis-server),
which exposes API endpoints for the rest of the control plane to manage
instances. One can run propolis-server in isolation, such as for development,
and interact with its endpoints using a
client such as the [propolis
CLI](https://github.com/oxidecomputer/propolis/tree/master/bin/propolis-cli).


The
[standalone](https://github.com/oxidecomputer/propolis/tree/master/bin/propolis-standalone#propolis-standalone)
version of propolis is useful development tool to a VM up and running quickly
without having to hit any API endpoints. It takes an input a single TOML file,
sets up a unix domain socket that is connected to a VM's uart, and starts the
guests when the user connects to the socket. It also cleans up the VM gracefully
when the user sends CTRL+C to the running `propolis-standalone` program.

Beyond these differences, there are some differences in the state machine
related to the instance lifecycle as well as the emulation.

TODO: flesh out more of these differences, and maybe capture them in a
higher-level README.

## Requirements

TODO: document the following

- how to build each of propolis and crucible
- assuming we are running on bench gimlets, which files to copy


## Instructions

0 comments on commit 40d2fd5

Please sign in to comment.