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
| Name | Description |
|---|---|
| build | Build OSTree and image base artifacts from previously fetched packages |
| clean | Delete all build artifacts |
| fetch | Fetch and import the latest packages |
| init | Setup the current working directory for CoreOS Assembler and clone the given project URL as Git config |
| kola | Run tests with kola |
| list | List builds available locally |
| run | Run a CoreOS instance in QEMU with access to a root shell |
| shell | Get an interactive shell or run a command in a CoreOS Assembler container |
| virt-install | “Install” a CoreOS system with libvirt |
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 | Generate the Live ISO |
| buildextend-{dasd,metal,metal4k,qemu,secex} | Generate artifacts for the given platforms |
| buildextend-{aliyun,aws,azure,digitalocean,exoscale,gcp,vultr} | Generate artifacts for the given platforms |
| buildextend-{azurestack,ibmcloud,openstack,vmware} | Generate artifacts for the given platforms |
| {aliyun,aws}-replicate | Replicate images on the platforms (AMIs for AWS) |
Misc commands
Those less commonly used commands are listed here:
| Name | Description |
|---|---|
| basearch | Convenient wrapper for getting the base architecture |
| build-validate | Validate the checksum of a given build |
| buildfetch | Fetches the bare minimum from external servers to create the next build |
| buildupload | Upload a build which later can be partially re-downloaded with cmd-buildfetch |
| compress | Compresses all images in a build |
| dev-synthesize-osupdate | Synthesize an OS update by modifying ELF files in a “benign” way (adding an ELF note) |
| dev-synthesize-osupdatecontainer | Wrapper for dev-synthesize-osupdate that operates on an oscontainer for OpenShift |
| koji-upload | Performs the required steps to make COSA a Koji Content Generator |
| meta | Helper for interacting with a builds meta.json |
| oc-adm-release | Publish an oscontainer as the machine-os-content in an OpenShift release series |
| offline-update | Given a disk image and a coreos-assembler build, use supermin to update the disk image to the target OSTree commit “offline” |
| prune | This script removes previous builds. DO NOT USE on production pipelines |
| coreos-prune | Prune resources as sepcified in policy.yaml |
| sign | Implements signing with RoboSignatory via fedora-messaging |
| supermin-shell | Get a supermin shell |
| tag | Operate on the tags in builds.json |
| test-coreos-installer | Automate an end-to-end run of coreos-installer with the metal image |