CoreOS Assembler Command Line Reference

This is a short reference of cosa sub-commands available in a CoreOS Assembler container. See each commands --help output for more details about supported arguments.

Main commands

NameDescription
buildBuild an OCI bootable container
cleanDelete all build artifacts
fetchFetch and import the latest packages
initSetup the current working directory for CoreOS Assembler and clone the given project URL as Git config
kolaRun tests with kola
listList builds available locally
osbuildDerive the OCI container to a bootable disk image for a given platform
runRun a CoreOS instance in QEMU with access to a root shell
shellGet an interactive shell or run a command in a CoreOS Assembler container
virt-install“Install” a CoreOS system with libvirt

osbuild commands

By default, the build command will build an OS Bootable Container. The osbuild command will take the bootable container and create artifacts/images for various platforms, such as cloud providers.

NameDescription
osbuild qemuCreate a qemu image
osbuild liveCreate a live iso
osbuild <platform>Create an image for the specified platform
osbuild --supported-platformsList of all supported platforms

Misc commands

Those less commonly used commands are listed here:

NameDescription
basearchConvenient wrapper for getting the base architecture
build-validateValidate the checksum of a given build
buildfetchFetches the bare minimum from external servers to create the next build
builduploadUpload a build which later can be partially re-downloaded with cmd-buildfetch
compressCompresses all images in a build
dev-synthesize-osupdateSynthesize an OS update by modifying ELF files in a “benign” way (adding an ELF note)
dev-synthesize-osupdatecontainerWrapper for dev-synthesize-osupdate that operates on an oscontainer for OpenShift
koji-uploadPerforms the required steps to make COSA a Koji Content Generator
metaHelper for interacting with a builds meta.json
oc-adm-releasePublish an oscontainer as the machine-os-content in an OpenShift release series
offline-updateGiven a disk image and a coreos-assembler build, use supermin to update the disk image to the target OSTree commit “offline”
pruneThis script removes previous builds. DO NOT USE on production pipelines
coreos-prunePrune resources as sepcified in policy.yaml
signImplements signing with RoboSignatory via fedora-messaging
supermin-shellGet a supermin shell
tagOperate on the tags in builds.json
test-coreos-installerAutomate an end-to-end run of coreos-installer with the metal image

Table of contents