{"id":29675822,"url":"https://github.com/oxidecomputer/boot-image-tools","last_synced_at":"2026-06-23T13:33:36.166Z","repository":{"id":219720082,"uuid":"528809872","full_name":"oxidecomputer/boot-image-tools","owner":"oxidecomputer","description":"Oxide boot image tools and DLPI-based network boot server","archived":false,"fork":false,"pushed_at":"2025-12-29T23:39:14.000Z","size":56,"stargazers_count":4,"open_issues_count":2,"forks_count":0,"subscribers_count":18,"default_branch":"main","last_synced_at":"2026-01-02T06:57:13.097Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/oxidecomputer.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2022-08-25T10:56:39.000Z","updated_at":"2025-12-29T23:38:25.000Z","dependencies_parsed_at":"2024-01-29T11:15:43.763Z","dependency_job_id":"3d73cdcb-1003-4843-8c50-d465a2ee8367","html_url":"https://github.com/oxidecomputer/boot-image-tools","commit_stats":null,"previous_names":["oxidecomputer/boot-image-tools"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/oxidecomputer/boot-image-tools","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oxidecomputer%2Fboot-image-tools","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oxidecomputer%2Fboot-image-tools/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oxidecomputer%2Fboot-image-tools/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oxidecomputer%2Fboot-image-tools/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/oxidecomputer","download_url":"https://codeload.github.com/oxidecomputer/boot-image-tools/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oxidecomputer%2Fboot-image-tools/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34691988,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-23T02:00:07.161Z","response_time":65,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-07-22T23:38:49.868Z","updated_at":"2026-06-23T13:33:36.126Z","avatar_url":"https://github.com/oxidecomputer.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Oxide Helios: Image Boot Tools\n\nOxide computers boot from ramdisk images, obtained from a variety of sources\ndepending on the context in which the computer is presently operating.  The\nramdisk image contains a small ZFS pool, assembled by\n[illumos/image-builder](https://github.com/illumos/image-builder) at the\ndirection of the `helios-build` tool in\n[oxidecomputer/helios](https://github.com/oxidecomputer/helios).  This\nrepository contains tools for compressing those ramdisk image contents with an\nmetadata appropriate header, for inspecting images that exist already, and for\nserving them over a local network.\n\nSeveral components depend on the image format with which these tools operate:\n\n- On production Oxide systems, the ramdisk image is loaded at boot from an\n  internal NVMe device.  This is implemented in\n  [uts/oxide/boot_image/oxide_boot_disk.c](https://github.com/oxidecomputer/illumos-gate/blob/stlouis/usr/src/uts/oxide/boot_image/oxide_boot_disk.c)\n  in the operating system itself.  In this context the ramdisk image is often\n  described as the \"phase 2\" image; the Host OS ROM, a small NOR flash device,\n  holds the \"phase 1\" image that corresponds with the ramdisk image.\n\n- The `mkimage` program in this repository is used by the **Helios** build\n  process as a step in assembling the final shipping OS image artefact.\n\n- The `bootserver` program in this repository uses a local Ethernet device to\n  listen for broadcasts from an Oxide compute sled that is attempting to boot\n  from the network via a K.2 network card adapter.  The protocol used is\n  described in some detail in a command in\n  [uts/oxide/boot_image/oxide_boot_net.c](https://github.com/oxidecomputer/illumos-gate/blob/stlouis/usr/src/uts/oxide/boot_image/oxide_boot_net.c)\n  in the operating system itself.\n\n- The `lookimage` program in this repository can check that an image\n  is intact, using the checksums in the header, and allows the user to\n  inspect image metadata; e.g.,\n\n  ```\n  $ lookimage /ws/helios/image/output/zfs.img\n  image name = testing-tar\n  flags = 0x0 ((empty))\n  data size = 838860800\n  image size = 838860800\n  target size = 4294967296\n  image sum = c18d8f9ad39c04e5d84580e701ce5e36cc1a7dd13515639194ca4aecb01e17f0\n  dataset name = rpool/ROOT/ramdisk\n  ```\n\n- [Omicron](https://github.com/oxidecomputer/omicron), the Oxide control\n  plane, contains software that deploys these images onto Oxide compute sleds\n  in an Oxide rack as part of software update and system recovery.\n\n  When a compute sled is unable to boot from local storage, a recovery image as\n  created by these tools is sent by **Omicron** via the [Management Gateway\n  Service (MGS)](https://github.com/oxidecomputer/management-gateway-service)\n  to the **service processor (SP)** of the target sled, via the local\n  management network.  The **SP** runs\n  [Hubris](https://github.com/oxidecomputer/hubris), and is capable of\n  forwarding the image to the host CPU via an internal UART (using **IPCC**)\n  for boot.\n\n  Comments describing the recovery protocol appear in\n  [uts/oxide/boot_image/oxide_boot_sp.h](https://github.com/oxidecomputer/illumos-gate/blob/stlouis/usr/src/uts/oxide/boot_image/oxide_boot_sp.h)\n  and\n  [uts/oxide/boot_image/oxide_boot_sp.c](https://github.com/oxidecomputer/illumos-gate/blob/stlouis/usr/src/uts/oxide/boot_image/oxide_boot_sp.c).\n\n## Licence\n\nCopyright 2024 Oxide Computer Company\n\nUnless otherwise noted, all components are licenced under the [Mozilla Public\nLicense Version 2.0](./LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foxidecomputer%2Fboot-image-tools","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foxidecomputer%2Fboot-image-tools","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foxidecomputer%2Fboot-image-tools/lists"}