README
¶
The CoreOS Assembler
This is the CoreOS Assembler (often abbreviated COSA) build environment. It is a collection of various tools used to build Fedora CoreOS style systems, including RHEL CoreOS. The goal is that everything needed to build and test the OS comes encapsulated in one (admittedly large) container.
A high level goal of this tool is to support two highly related use cases, and to keep them as similar as possible:
- Local development ("test a kernel change")
- Be a production build system orchestrated by an external tool (e.g. Jenkins)
See fedora-coreos-pipeline as an example pipeline.
The container itself is available on Quay.io at
quay.io/coreos-assembler/coreos-assembler. It includes the
following tools:
cosa: entrypoint for the COSA container and dispatcher to other commands:- To learn how to use COSA, see the Building Fedora CoreOS guide and the Working with CoreOS Assembler guide.
- To learn how to develop on COSA, see the CoreOS Assembler Design guide and the Working on CoreOS Assembler guide.
kola: for launching instances and running tests on themkolet: an agent for kola that runs on instancesore: for interfacing with cloud providersplume: for releasing Fedora CoreOS and Fedora Cloud
Building Fedora CoreOS
See the Building Fedora CoreOS guide to learn how to build Fedora CoreOS with COSA.
Building a custom OS with COSA
For more information about building a custom OS derived or based on Fedora CoreOS, see Custom OS.
Directories
¶
| Path | Synopsis |
|---|---|
|
See usage below
|
See usage below |
|
internal
|
|
|
pkg/bashexec
Package bashexec provides helpers to execute bash code.
|
Package bashexec provides helpers to execute bash code. |
|
pkg/cosash
Package cosash implements a "co-processing" proxy that is primarily designed to expose a Go API that is currently implemented by `src/cmdlib.sh`.
|
Package cosash implements a "co-processing" proxy that is primarily designed to expose a Go API that is currently implemented by `src/cmdlib.sh`. |
|
mantle
|
|
|
auth
Package auth provides Google oauth2 and Azure credential bindings for mantle.
|
Package auth provides Google oauth2 and Azure credential bindings for mantle. |
|
harness
Package harness provides a reusable test framework akin to the standard "testing" Go package.
|
Package harness provides a reusable test framework akin to the standard "testing" Go package. |
|
harness/_example
This example program illustrates how to create a custom test suite based on the harness package.
|
This example program illustrates how to create a custom test suite based on the harness package. |
|
lang
lang provides an assortment of Go language utilities
|
lang provides an assortment of Go language utilities |
|
lang/natsort
natsort implements Martin Pool's Natural Order String Comparison Original implementation: https://github.com/sourcefrog/natsort
|
natsort implements Martin Pool's Natural Order String Comparison Original implementation: https://github.com/sourcefrog/natsort |
|
network/mockssh
mockssh implements a basic ssh server for use in unit tests.
|
mockssh implements a basic ssh server for use in unit tests. |
|
network/ntp
NTP v4 (RFC 5905) http://tools.ietf.org/html/rfc5905
|
NTP v4 (RFC 5905) http://tools.ietf.org/html/rfc5905 |
|
system/exec
exec is extension of the standard os.exec package.
|
exec is extension of the standard os.exec package. |
|
pkg
|
|