Skip to content

Docs: Add osbuild to documentation #4413

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
angelcerveraroldan wants to merge 4 commits into
base: main
Choose a base branch
from
+12 −26
Open

Docs: Add osbuild to documentation #4413

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5da48cb
Add `cosa osbuild qemu` command
angelcerveraroldan Jan 13, 2026
9579ea1
Add osbuild to main commands
angelcerveraroldan Jan 13, 2026
ae63b09
Remove buildextend commands
angelcerveraroldan Jan 13, 2026
b799ac0
Better wording
angelcerveraroldan Jan 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 10 additions & 11 deletions docs/building-fcos.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,25 +185,24 @@ repository.

## Performing a build

First, we fetch all the metadata and packages:
We will now build the bootable container (ostree) and image base artifacts, which
can later be used to produce images for specific target platforms. Each build generates
a new directory in `$PWD/builds/`.

```
$ cosa fetch
$ cosa build
```

And now we can build from these inputs:
Next, rerun `cosa build` and notice the system correctly
deduces that nothing changed.

At this point we can generate a platform-specific image, we will generate a
qemu image by running:

```
$ cosa build
$ cosa osbuild qemu
```

Each build will create a new directory in `$PWD/builds/`, containing the
generated OSTree commit (as a tarball) and the qemu VM image.

Next, rerun `cosa build` and notice the system correctly
deduces that nothing changed. You can run `cosa fetch`
again to check for updated RPMs.

## Running

```
Expand Down
17 changes: 2 additions & 15 deletions docs/cosa.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,13 @@ supported arguments.

| Name | Description |
| ---- | ----------- |
| [build](https://github.com/coreos/coreos-assembler/blob/main/src/cmd-build) | Build OSTree and image base artifacts from previously fetched packages
| [build](https://github.com/coreos/coreos-assembler/blob/main/src/cmd-build) | Build OSTree from previously fetched packages
| [clean](https://github.com/coreos/coreos-assembler/blob/main/src/cmd-clean) | Delete all build artifacts
| [fetch](https://github.com/coreos/coreos-assembler/blob/main/src/cmd-fetch) | Fetch and import the latest packages
| [init](https://github.com/coreos/coreos-assembler/blob/main/src/cmd-init) | Setup the current working directory for CoreOS Assembler and clone the given project URL as Git config
| [kola](https://github.com/coreos/coreos-assembler/blob/main/src/cmd-kola) | Run tests with [kola](kola.md)
| [list](https://github.com/coreos/coreos-assembler/blob/main/src/cmd-list) | List builds available locally
| [osbuild](https://github.com/coreos/coreos-assembler/blob/main/src/cmd-osbuild) | Create an image for a given platform
| [run](https://github.com/coreos/coreos-assembler/blob/main/src/cmd-run) | Run a CoreOS instance in QEMU with access to a root shell
| [shell](https://github.com/coreos/coreos-assembler/blob/main/src/cmd-shell) | Get an interactive shell or run a command in a CoreOS Assembler container
| [virt-install](https://github.com/coreos/coreos-assembler/blob/main/src/cmd-virt-install) | "Install" a CoreOS system with libvirt
Expand All @@ -33,20 +34,6 @@ not produce an image with your changes):
| [build-fast](https://github.com/coreos/coreos-assembler/blob/main/src/cmd-build-fast) | Creates a new QCOW2 image from an existing build and updates the ostree commit with local overrides. This will only change files located in the final root (i.e. part of an ostree commit).
| [buildinitramfs-fast](https://github.com/coreos/coreos-assembler/blob/main/src/cmd-buildinitramfs-fast) | Create a new QCOW2 image from an existing build and updates the initramfs with local overrides. This will not re-run dracut to rebuild the initramfs.

## buildextend commands

By default, the `build` command will build an OSTree and a QEMU image as base
artifacts. Those commands extend those artifacts to make them functional on
other platforms or cloud providers:

| Name | Description |
| ---- | ----------- |
| [buildextend-live](https://github.com/coreos/coreos-assembler/blob/main/src/cmd-buildextend-live) | Generate the Live ISO
| [buildextend-{dasd,metal,metal4k,qemu,secex}](https://github.com/coreos/coreos-assembler/blob/main/src/cmd-buildextend-metal) | Generate artifacts for the given platforms
| [buildextend-{aliyun,aws,azure,digitalocean,exoscale,gcp,vultr}](https://github.com/coreos/coreos-assembler/blob/main/src/cmd-ore-wrapper) | Generate artifacts for the given platforms
| [buildextend-{azurestack,ibmcloud,openstack,vmware}](https://github.com/coreos/coreos-assembler/blob/main/src/cmd-artifact-disk) | Generate artifacts for the given platforms
| [{aliyun,aws}-replicate](https://github.com/coreos/coreos-assembler/blob/main/src/cmd-ore-wrapper) | Replicate images on the platforms (AMIs for AWS)
Comment on lines -44 to -49
Copy link
Member

@jbtrystram jbtrystram Jan 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

these need to be replaced with their osbuild equivalent


## Misc commands

Those less commonly used commands are listed here:
Expand Down
Loading