OSBUILD-COMPOSER(7)

📦
version 176 · 4 versions
, in fedora 43

✨ OSBUILD-COMPOSER(7) ✨

okay bestie, welcome to the manual page for osbuild-composer — aka the OSBuild Composer Service 💖 — straight out of section 7 (Miscellaneous). Grab a snack, this one's short but it's iconic. 🫶

🌸 NAME 🌸

osbuild-composer — the OSBuild Composer Service 💅

✨ DESCRIPTION ✨

So, the composer project? It's a whole set of HTTP services for composing operating system images. No cap. It builds on top of the pipeline execution engine of osbuild [1], and it defines its own class of images that it supports building. Main character energy tbh. 👑

There are multiple APIs you can use to access a composer service. This includes support for the lorax-composer [2] API — which means it can serve as a drop-in replacement for lorax-composer. Not me being compatible with everything, we love to see it. 😌

You can control a composer instance either:

  • directly via the provided APIs, or
  • through higher-level user-interfaces from external projects.

That second one includes stuff like a Cockpit Module [3] or using the composer-cli [4] command-line tool. Options on options, fr fr. 🌈

🦋 Frontends 🦋

Composer does not ship with frontends itself. Like, zero. However, several external frontends for Composer already exist. These include:

  • Cockpit Composer — This module for Cockpit [5] allows a great level of control of a Composer instance running on a cockpit-managed machine. 💻
  • Composer CLI — This command-line tool originated in the lorax [2] project, but can be used with Composer just as well. Terminal girlies rise. 🎀

🔥 RUNNING 🔥

To deploy a composer instance, all you need is to

# systemctl start osbuild-composer.socket

periodt. That's it. That's the whole deployment. 💀✨

Now you can access the service using composer-cli, for example:

# composer-cli status show

or using Cockpit with the Cockpit Composer module from a browser: http://localhost:9090 🌐

👀 SEE ALSO 👀

osbuild(1), osbuild-manifest(5)

📝 NOTES 📝

  1. OSBuild: <https://www.osbuild.org>
  2. Lorax Composer: <https://github.com/weldr/lorax>
  3. Cockpit Composer: <https://github.com/osbuild/cockpit-composer>
  4. Composer CLI: <https://weldr.io/lorax/composer-cli.html>
  5. Cockpit Project: <https://www.cockpit-project.org/>

and that's the whole vibe check, bestie 🧚 — this was osbuild-composer(7) from the Miscellaneous section, so if you ever forget it, just know the manual page name is right there waiting for you like a little signature at the bottom of the page. mwah 💋

📦 where this page comes from