From b87d3d78ec41fe1e83b6fb5edaa133f9f28f4b27 Mon Sep 17 00:00:00 2001 From: Lukas Zapletal Date: Tue, 6 May 2025 14:52:19 +0200 Subject: [PATCH] docs: add README to cmd/ --- cmd/README | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 cmd/README diff --git a/cmd/README b/cmd/README new file mode 100644 index 000000000..9a0a071e9 --- /dev/null +++ b/cmd/README @@ -0,0 +1,36 @@ +Binaries +======== + +osbuild-composer: The main binary, the service that maintains the queue and schedules all +jobs. This is started as the main process by systemd or container runtime. + +osbuild-worker: The worker binary that handles jobs from the job queue locally. + +osbuild-worker-executor: The binary that runs osbuild to build an image on an isolated VM. + +osbuild-koji: Submits builds to Koji. + +osbuild-jobsite-*: Provides an isolated set of services to run builds in. They can be separated +from the rest of the system through network segmentation or other means. The jobsite and what's +in it are only available to things inside it. + +Service binaries +================ + +osbuild-service-maintenance: Vacuum the database and remove old jobs. Also used to cleanup +cloud instances. + +Development and test tools +========================== + +gen-manifests +mock-dnf-json +osbuild-auth-tests +osbuild-composer-cli-tests +osbuild-composer-dbjobqueue-tests +osbuild-dnf-json-tests +osbuild-image-tests +osbuild-koji-tests +osbuild-mock-openid-provider +osbuild-store-dump +osbuild-upload-*