From c9244dfb0936abafd3d4fd037f360d6680d6692d Mon Sep 17 00:00:00 2001 From: Colin Walters Date: Thu, 6 Nov 2025 17:20:49 -0500 Subject: [PATCH] docs: Fix various errors Remove references to non-existent commands and incorrect options: - Remove non-existent `bcvk libvirt create` command from README - Remove non-existent `bcvk libvirt restart` command - Remove incorrect `--autostart` flag from libvirt-run examples - Remove unsupported disk formats (VHD, VMDK) from disk-images.md and really trim down to be clear it just wraps bootc install. - Remove non-existent `--partition` option - Fix `--size` to correct `--disk-size` flag throughout Fix incorrect references: - Fix binary name from `bck` to `bcvk` in docs/HACKING.md and Justfile - Fix repository URL from cgwalters/bcvk to bootc-dev/bcvk Fix incomplete content: - Complete incomplete sentence in README about ephemeral VMs - Populate empty docs/src/HACKING.md with redirect to ../HACKING.md - Fix path in docs/src/contributing.md Assisted-by: Claude Code (Sonnet 4.5) Signed-off-by: Colin Walters --- Justfile | 2 +- README.md | 6 ++-- docs/HACKING.md | 4 +-- docs/src/HACKING.md | 2 ++ docs/src/building.md | 2 +- docs/src/contributing.md | 2 +- docs/src/disk-images.md | 69 ++------------------------------------ docs/src/libvirt-manage.md | 1 - docs/src/libvirt-run.md | 1 - 9 files changed, 11 insertions(+), 78 deletions(-) diff --git a/Justfile b/Justfile index 739d863..30b4747 100644 --- a/Justfile +++ b/Justfile @@ -94,5 +94,5 @@ archive: build # Install the binary to ~/.local/bin install: build - cp target/release/bck ~/.local/bin/ + cp target/release/bcvk ~/.local/bin/ diff --git a/README.md b/README.md index 618bf30..18d33a5 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,8 @@ bcvk ephemeral run-ssh quay.io/fedora/fedora-bootc:42 ``` Everything with `bcvk ephemeral` creates a podman container that reuses the -host virtualization stack, and +host virtualization stack, making it simple to test bootc containers without +requiring root privileges or dedicated VM infrastructure. ### Creating a persistent bootable disk image from a container image ```bash @@ -90,9 +91,6 @@ bcvk libvirt rm my-fedora-vm bcvk to-disk quay.io/fedora/fedora-bootc:42 /tmp/fedora.img bcvk libvirt upload /tmp/fedora.img --name fedora-base -# Create a domain from uploaded image -bcvk libvirt create fedora-base --name my-vm --memory 8192 - # Run with custom filesystem and network settings bcvk libvirt run --filesystem xfs --network bridge quay.io/centos-bootc/centos-bootc:stream10 ``` diff --git a/docs/HACKING.md b/docs/HACKING.md index 2f9ad51..271bcef 100644 --- a/docs/HACKING.md +++ b/docs/HACKING.md @@ -34,9 +34,9 @@ Integration tests require QEMU/KVM to be fully working as they launch actual VMs ## Running -Ensure the entrypoint script is in `$PATH`, i.e. that `bck` works. +Ensure the entrypoint script is in `$PATH`, i.e. that `bcvk` works. -Then you can invoke `bck`. +Then you can invoke `bcvk`. ## Code formatting diff --git a/docs/src/HACKING.md b/docs/src/HACKING.md index a34d83d..c35bc3d 100644 --- a/docs/src/HACKING.md +++ b/docs/src/HACKING.md @@ -1 +1,3 @@ # HACKING + +See [../HACKING.md](../HACKING.md) for development instructions. diff --git a/docs/src/building.md b/docs/src/building.md index 854ba89..85ced76 100644 --- a/docs/src/building.md +++ b/docs/src/building.md @@ -35,7 +35,7 @@ sudo systemctl enable --now libvirtd ## Clone and Build ```bash -git clone https://github.com/cgwalters/bcvk.git +git clone https://github.com/bootc-dev/bcvk.git cd bcvk cargo build --release ``` diff --git a/docs/src/contributing.md b/docs/src/contributing.md index cfc3ff8..57470f5 100644 --- a/docs/src/contributing.md +++ b/docs/src/contributing.md @@ -1,3 +1,3 @@ # Contributing -We welcome contributions to bcvk! Please see [docs/HACKING.md](../HACKING.md) for detailed development instructions. \ No newline at end of file +We welcome contributions to bcvk! Please see [../HACKING.md](../HACKING.md) for detailed development instructions. \ No newline at end of file diff --git a/docs/src/disk-images.md b/docs/src/disk-images.md index a17d81c..336b3af 100644 --- a/docs/src/disk-images.md +++ b/docs/src/disk-images.md @@ -1,69 +1,4 @@ # Disk Images -The `to-disk` command creates bootable disk images from bootc containers. - -## Supported Formats - -```bash -# Raw disk image (default) -bcvk to-disk quay.io/fedora/fedora-bootc:42 output.img - -# QCOW2 (compressed, for QEMU/KVM) -bcvk to-disk --format qcow2 quay.io/fedora/fedora-bootc:42 output.qcow2 - -# VHD (Hyper-V, Azure) -bcvk to-disk --format vhd quay.io/fedora/fedora-bootc:42 output.vhd - -# VMDK (VMware) -bcvk to-disk --format vmdk quay.io/fedora/fedora-bootc:42 output.vmdk -``` - -## Configuration Options - -```bash -# Disk size -bcvk to-disk --size 50G quay.io/fedora/fedora-bootc:42 output.img - -# Filesystem type -bcvk to-disk --filesystem xfs quay.io/fedora/fedora-bootc:42 output.img -bcvk to-disk --filesystem ext4 quay.io/fedora/fedora-bootc:42 output.img - -# Partitioning scheme -bcvk to-disk --partition gpt quay.io/fedora/fedora-bootc:42 output.img -bcvk to-disk --partition mbr quay.io/fedora/fedora-bootc:42 output.img -``` - -## Common Use Cases - -### Cloud Deployment - -```bash -# AWS/GCP (raw format) -bcvk to-disk --format raw --size 30G quay.io/fedora/fedora-bootc:42 cloud.img - -# Azure (VHD format) -bcvk to-disk --format vhd --size 30G quay.io/fedora/fedora-bootc:42 azure.vhd -``` - -### Bare Metal - -```bash -# Create bootable USB/SD card image -bcvk to-disk --size 16G quay.io/fedora/fedora-bootc:42 usb.img -sudo dd if=usb.img of=/dev/sdX bs=4M status=progress -``` - -### Virtualization - -```bash -# QEMU/KVM -bcvk to-disk --format qcow2 quay.io/fedora/fedora-bootc:42 vm.qcow2 -qemu-system-x86_64 -hda vm.qcow2 -m 2048 -enable-kvm - -# VMware -bcvk to-disk --format vmdk quay.io/fedora/fedora-bootc:42 vm.vmdk - -# VirtualBox (requires conversion) -bcvk to-disk --format raw quay.io/fedora/fedora-bootc:42 vm.img -VBoxManage convertfromraw vm.img vm.vdi -``` \ No newline at end of file +The `to-disk` command creates disk images from bootc containers. +It is a wrapper for [bootc install to-disk](https://bootc-dev.github.io/bootc/man/bootc-install-to-disk.8.html). diff --git a/docs/src/libvirt-manage.md b/docs/src/libvirt-manage.md index 3b321ac..4b423c4 100644 --- a/docs/src/libvirt-manage.md +++ b/docs/src/libvirt-manage.md @@ -9,7 +9,6 @@ bcvk libvirt run --name myvm quay.io/fedora/fedora-bootc:42 # Manage state bcvk libvirt start myvm bcvk libvirt stop myvm -bcvk libvirt restart myvm # Remove VM bcvk libvirt rm myvm diff --git a/docs/src/libvirt-run.md b/docs/src/libvirt-run.md index f270a40..43367e7 100644 --- a/docs/src/libvirt-run.md +++ b/docs/src/libvirt-run.md @@ -13,7 +13,6 @@ bcvk libvirt run \ --name production-api \ --memory 8192 \ --cpus 4 \ - --autostart \ quay.io/myapp/api:v1.0 # Development setup with SSH