Skip to content

Commit d25343e

Browse files
authored
chore: add VM documentation (#1779)
1 parent 1865d37 commit d25343e

File tree

3 files changed

+32
-2
lines changed

3 files changed

+32
-2
lines changed

README.md

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ Easily go from container to VM / ISO-on-a-USB / RAW image!
1616
- [Requirements](#requirements)
1717
- [Installation](#installation)
1818
- [Usage](#usage)
19+
- [Advanced Usage](#advanced-usage)
1920
- [Preferences](#preferences)
2021
- [Known Issues](#known-issues)
2122
- [Contributing](#contributing)
@@ -87,8 +88,6 @@ You can also pull our example image based on the [`httpd`](https://gitlab.com/bo
8788

8889
![](https://raw.githubusercontent.com/podman-desktop/podman-desktop-extension-bootc/main/docs/img/clicking_pull.gif)
8990

90-
After building, read our [Virtual Machine Guide](https://github.com/containers/podman-desktop-extension-bootc/blob/main/docs/vm_guide.md) on how to launch your image and access your HTTP server.
91-
9291
## Use Case
9392

9493
Go from a [bootc](https://bootc-dev.github.io/bootc/) compatible derived container build to a disk image format:
@@ -185,6 +184,37 @@ RUN echo "root:root" | chpasswd
185184
186185
![](https://raw.githubusercontent.com/podman-desktop/podman-desktop-extension-bootc/main/docs/img/bootc_building.gif)
187186

187+
3. **Testing the image locally (macOS and Linux):**
188+
189+
> You can test the image locally on both macOS and Linux using the "Create VM" button on the "Disk Images" page. Windows support is upcoming.
190+
191+
![](https://raw.githubusercontent.com/podman-desktop/podman-desktop-extension-bootc/main/docs/img/vm.gif)
192+
193+
## Advanced usage
194+
195+
![](/docs/img/balena_etcher.png)
196+
197+
### Booting the image
198+
199+
After building, there are multiple ways you can _use_ the outputting image format.
200+
201+
- **Virtually:** Use the built-in support in the extension that uses [macadam](https://github.com/crc-org/macadam), see our [usage](#usage) guide.
202+
- **Third-party software:** Launch the image using your preferred virtualization software, such as VMware, VirtualBox, virt-manager (libvirt), QEMU, or GNOME Boxes.
203+
- **USB flash drive:** Use tools like [balenaEtcher](https://www.balena.io/etcher/), [Rufus](https://rufus.ie/) or [Fedora MediaWriter](https://github.com/FedoraQt/MediaWriter) to flash the image to a USB stick. Then boot from it on real hardware.
204+
205+
### Using the `bootc` CLI tool
206+
207+
The `bootc` CLI command is the "bread-and-butter" of all bootc-derived images.
208+
209+
Once booted into the system, you can manage it using the `bootc` CLI:
210+
211+
- **Status:** `bootc status` shows the current image and version.
212+
- **Upgrade:** `bootc upgrade` pulls the latest OCI image to apply next reboot.
213+
- **Fetch:** `bootc fetch` pre-downloads an update without applying it.
214+
- **Install:** `bootc install --target /dev/sdX` writes the OS to a block device, good for when "live booting" on a USB flash drive for testing.
215+
216+
See [bootc-dev.github.io/bootc](https://bootc-dev.github.io/bootc) for more information.
217+
188218
## Preferences
189219

190220
Preferences such as the default `bootc-builder-image` as well as timeouts can be adjusted within the **Preferences** section of Podman Desktop.

docs/img/balena_etcher.png

318 KB
Loading

docs/img/vm.gif

802 KB
Loading

0 commit comments

Comments
 (0)