Skip to content

Commit 9b2f073

Browse files
authored
README: update image docs (#73)
this patch gives us a better foundation for documenting the new images in #64.
1 parent 26ff91e commit 9b2f073

File tree

1 file changed

+31
-13
lines changed

1 file changed

+31
-13
lines changed

README.md

Lines changed: 31 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -152,26 +152,46 @@ $ cargo build
152152
$ sudo [RUST_BACKTRACE=1] IMAGE_DEPS_DIR=$(nix eval --raw .\#image-deps) LIB_MONITOR_DIR=. target/debug/monitor
153153
```
154154

155-
Windows 10 runner
155+
Minimal test images
156+
-------------------
157+
158+
A useful image for hacking on the monitor locally, since it only takes around a minute to build.
159+
160+
This is a **libvirt/KVM**-based image, compatible with Linux amd64 servers only:
161+
162+
- `servo-ubuntu2204-rust`
163+
164+
Windows 10 images
156165
-----------------
157166

158-
Runners created from this image preinstall all dependencies (including those specified in the main repo, like GStreamer and Chocolatey deps), preload the main repo, and prebuild Servo in the release profile.
167+
Runners created from these images preinstall all dependencies (including those specified in the main repo, like GStreamer and Chocolatey deps), preload the main repo, and prebuild Servo in the release profile.
168+
169+
This is a **libvirt/KVM**-based image, compatible with Linux amd64 servers only:
159170

160-
Building the base vm image is handled automatically by the monitor.
171+
- `servo-windows10`
161172

162-
Ubuntu runner
163-
-------------
173+
Ubuntu 22.04 images
174+
-------------------
164175

165-
Runners created from this image preinstall all dependencies (including those specified in the main repo, like mach bootstrap deps), preload the main repo, and prebuild Servo in the release profile.
176+
Runners created from these images preinstall all dependencies (including those specified in the main repo, like mach bootstrap deps), preload the main repo, and prebuild Servo in the release profile.
166177

167-
Building the base vm image is handled automatically by the monitor.
178+
These are **libvirt/KVM**-based images, compatible with Linux amd64 servers only:
168179

169-
macOS 13/14/15 runner
170-
---------------------
180+
- `servo-ubuntu2204` (ci0, ci1, and ci2 only)
181+
- `servo-ubuntu2204-bench` (ci3 and ci4 only)
171182

172-
Runners created from this image preinstall all dependencies (including those specified in the main repo, like mach bootstrap deps), preload the main repo, and prebuild Servo in the release profile.
183+
macOS 13/14/15 x64 images
184+
-------------------------
173185

174-
To prepare a server for macOS 13/14/15 guests, build a clean image, replacing “13” with the macOS version as needed:
186+
Runners created from these images preinstall all dependencies (including those specified in the main repo, like mach bootstrap deps), preload the main repo, and prebuild Servo in the release profile.
187+
188+
These are **libvirt/KVM**-based images, compatible with Linux amd64 servers only:
189+
190+
- `servo-macos13`
191+
- `servo-macos14`
192+
- `servo-macos15`
193+
194+
Automating the macOS installer is difficult without paid tooling, but we can get close enough with some once-per-server setup. To prepare a server for macOS 13/14/15 guests, build a clean image, replacing “13” with the macOS version as needed:
175195

176196
- Clone the OSX-KVM repo: `git clone --recursive https://github.com/kholia/OSX-KVM.git /var/lib/libvirt/images/OSX-KVM`
177197
- Download the BaseSystem.dmg: `( cd /var/lib/libvirt/images/OSX-KVM; ./fetch-macOS-v2.py )`
@@ -250,5 +270,3 @@ Remote deployment tip. If you’ve deployed the clean image, but now the base im
250270
- Change `<source file="..."/>` to `<source dev="/dev/null"/>`
251271
- Save and quit (nano): Ctrl+X, Y, Enter
252272
- Restart the monitor: `systemctl restart monitor`
253-
254-
Building the base vm image is handled automatically by the monitor.

0 commit comments

Comments
 (0)