Skip to content

Commit

Permalink
doc tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
iliana committed May 14, 2024
1 parent 1f7320d commit d5341bb
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions docs/releng.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,10 @@ is always functional. You can also run the process locally with

== Process overview

`cargo xtask releng` performs all of these steps in parallel (with
the temporary exception of artifact downloads handled by
`tools/install_builder_prerequisites.sh`):

. `tools/install_builder_prerequisites.sh` downloads several artifacts
(via the `tools/ci_*` scripts) that are necessary to build Omicron;
many of these are ultimately packaged by `omicron-package`. These
Expand All @@ -49,9 +53,11 @@ is always functional. You can also run the process locally with
packages them into a series of illumos zones and tarballs. (It can
also manage installation and uninstallation of these zones; see
how-to-run.adoc.)
. Some of the packaged artifacts are installed directly in the OS
images; `cargo xtask releng` unpacks these into a temporary directory
that is overlaid onto the OS image in the next step.
. Some of the illumos zones are distributed with the OS images (because
they are reliant on OS-specific APIs), and some are distributed
separately. `cargo xtask releng` unpacks the zones for the OS image
into a temporary directory that is overlaid onto the OS image in the
next step.
. `helios-build` from the https://github.com/oxidecomputer/helios[Helios]
repository then builds two images: the *host* image, which is used
during normal operation, and the *trampoline* (or *recovery*) image,
Expand All @@ -63,10 +69,6 @@ is always functional. You can also run the process locally with
can be uploaded to Wicket to perform an upgrade of the rack while the
control plane is not running.

`cargo xtask releng` performs all of these steps in parallel (with
the temporary exception of artifact downloads handled by
`tools/install_builder_prerequisites.sh`.)

== Beyond `cargo xtask releng`

Currently we use TUF repos generated in CI (by `cargo xtask releng`)
Expand Down

0 comments on commit d5341bb

Please sign in to comment.