From 36e681b7d961479ab1999a0ae6f9257701491442 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Florian=20Sch=C3=BCller?= Date: Mon, 20 Jan 2025 19:10:03 +0100 Subject: [PATCH 1/2] user-guide/00-introduction: Describe image builder output formats Rework the Image Builder output formats table to contain a more concise description. --- docs/user-guide/00-introduction.md | 42 ++++++++++++++++-------------- 1 file changed, 22 insertions(+), 20 deletions(-) diff --git a/docs/user-guide/00-introduction.md b/docs/user-guide/00-introduction.md index 2a4f40557c..43aa3458ff 100644 --- a/docs/user-guide/00-introduction.md +++ b/docs/user-guide/00-introduction.md @@ -27,29 +27,31 @@ Image Builder can create images in multiple output formats shown in the followin **Table 1. Image Builder output formats** -| Description | CLI name | File extension | -| ------------- |:-------------:| ------------- | -| QEMU Image | qcow2 | .qcow2 | -| Disk Archive | tar | .tar | -| Amazon Web Services | raw | .raw | -| Microsoft Azure | vhd | .vhd | -| Google Cloud Platform | gce | .tar.gz | -| VMware vSphere | vmdk | .vmdk | -| VMware vSphere | ova | .ova | -| Openstack | openstack | .qcow2 | -| IoT Commit | iot-commit | .tar | -| IoT Container | iot-container | .tar | -| IoT Installer | iot-installer | .iso | -| IoT Raw Image| iot-raw-image | .raw.xz | -| IoT Simplified Installer | iot-simplified-installer | .iso | -| IoT AMI | iot-ami | .ami | -| IoT VMDK | iot-vmdk | .vmdk | -| Installer | image-installer | iso | -| Installer | live-installer | iso | -| Oracle Cloud Infrastructure | oci | .qcow2 | +| Name | CLI name | File extension | Description | +|-----------------------------------|:------------------------------------------------------:|----------------|------------------------------------------------------------------------------------------------------| +| QEMU Image | qcow2 | `.qcow2` | QCOW2 formatted disk image for use with QEMU/Libvirt. | +| Disk Archive | tar | `.tar` | Archive of the root filesystem without any bootloader or partition table. | +| Amazon Machine Image | ami | `.ami` | Disk image for use with AWS EC2. | +| Microsoft Azure | vhd | `.vhd` | Disk image for use with Microsoft Azure. | +| Google Cloud Platform | gce | `.tar.gz` | Disk image for use with Google Cloud Platform. | +| VMware vSphere | vmdk | `.vmdk` | VMDK formatted disk image for use with VMware vSphere. | +| VMware vSphere | ova | `.ova` | OVA formatted disk image for use with VMware vSphere. | +| Openstack | openstack | `.qcow2` | QCOW2 formatted disk image for use with OpenStack. | +| Edge/IoT[^1] Commit | edge-commit
iot-commit | `.tar` | OSTree commit archive. | +| Edge/IoT[^1] Container | edge-container
iot-container | `.tar` | Web server container that embeds and serves an ostree repository with the given single commit. | +| Edge/IoT[^1] Installer | edge-installer
iot-installer | `.iso` | OSTree-based Anaconda installer ISO for deploying IoT images. | +| Edge/IoT[^1] Raw Image | edge-raw-image
iot-raw-image | `.raw.xz` | Compressed raw disk image for OSTree-based IoT devices. | +| Edge/IoT[^1] Simplified Installer | edge-simplified-installer
iot-simplified-installer | `.iso` | OSTree-based installer ISO using coreos-installer for direct disk deployment using FIDO or ignition. | +| Edge/IoT[^1] AMI | edge-ami
iot-ami | `.ami` | OSTree-based Amazon Machine Image tailored for IoT deployments on AWS EC2. | +| Edge vSphere | edge-vsphere | `.vmdk` | OSTree-based VMDK formatted disk image for IoT deployments on VMware vSphere. | +| Image installer | image-installer | `.iso` | Anaconda ISO with an embedded pre-built OS archive. | +| Live installer | live-installer | `.iso` | Anaconda ISO with a live operating system. | +| Oracle Cloud Infrastructure Image | oci | `.qcow2` | QCOW2 formatted disk image for use with Oracle Cloud. This is identical to the qcow2 image. | To check the supported types, run the command: ``` $ composer-cli compose types ``` + +[^1]: Edge is the variant for CentOS and RHEL, while it's called IoT on Fedora. Technically the output format is the same for both. \ No newline at end of file From d23363badac0588f90404652d472f712d6cb6652 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Florian=20Sch=C3=BCller?= Date: Tue, 28 Jan 2025 15:01:58 +0100 Subject: [PATCH 2/2] docs/user-guide/00-introduction: fix hyperlink This documentation is actually part of osbuild.org --- docs/user-guide/00-introduction.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user-guide/00-introduction.md b/docs/user-guide/00-introduction.md index 43aa3458ff..534c84404a 100644 --- a/docs/user-guide/00-introduction.md +++ b/docs/user-guide/00-introduction.md @@ -2,7 +2,7 @@ With the Image Builder tool, you can create customized system images. Image builder automatically handles the setup details for each output type and is therefore easier to use and faster to work with than manual methods of image creation. You can access the Image Builder functionalities by using the [command-line interface](https://osbuild.org/docs/on-premises/commandline/), or the [Web UI](https://osbuild.org/docs/on-premises/installation/#web-ui) interface. With Image Builder, you can create system images that are prepared for deployment, including system images prepared for [clouds](https://osbuild.org/docs/user-guide/uploading-cloud-images/), and also images optimized for deployment on [edge](https://osbuild.org/docs/on-premises/commandline/building-ostree-images) servers. -This user guide refers primarily to the on [premises version of Image Builder](../on-premises/00-overview/index.md). While many of the concepts are transferable to the service, at this point please refer to Red Hat's official documentation. +This user guide refers primarily to the on [premises version of Image Builder](../on-premises/00-overview/index.md). While many of the concepts are transferable to the [service](../hosted/architecture/index.md). ### Image Builder terminology