No description
Find a file
Simon de Vlieger bc99513c0a stages/test: kickstart different messages
On Python 3.6 we're getting a *different* error message from other
versions in CI. Let's accept both versions.

Signed-off-by: Simon de Vlieger <supakeen@redhat.com>
2025-06-16 09:31:49 -07:00
.devcontainer Add support for using librepo to download packages 2025-01-14 08:19:16 +01:00
.github Tests: fix packit config validation 2025-04-22 21:15:21 +02:00
assemblers Fix pylint issue E0606: possibly-used-before-assignment 2024-11-25 10:09:18 +01:00
data devices: add custom udev rule inhibitor mechanism 2021-12-09 00:44:21 +00:00
devices devices/loopback: add read-only option 2024-09-18 08:54:34 +02:00
docs doc: document the new json-sequence monitor 2024-03-13 17:27:39 +01:00
inputs Fix pylint issue E0606: possibly-used-before-assignment 2024-11-25 10:09:18 +01:00
mounts mounts: implement new org.osbuild.bind mount 2024-04-11 17:40:21 +02:00
osbuild solver/dnf5: switch base exception type 2025-06-16 09:23:25 -07:00
runners runners: Add AlmaLinux runner links to permit AlmaLinux as a host 2025-04-01 10:35:18 +02:00
schemas schema: metadata at the top level 2024-10-29 08:24:33 +01:00
schutzbot schutbot: update terraform ref 2025-05-16 16:56:15 +02:00
selinux SELinux: apply osbuild_exec_t to /usr/bin/osbuild-image-info 2024-12-18 12:50:32 +01:00
sources source/containers-storage: error message 2025-06-16 09:22:28 -07:00
stages stages/test: kickstart different messages 2025-06-16 09:31:49 -07:00
test Avoid the multiprocessing forkserver method 2025-06-16 12:06:34 +02:00
tools Tools/inline-source.py: support specifying data encoding 2025-05-13 10:27:36 +02:00
.bandit lint: provide bandit configuration 2023-04-23 21:44:46 +02:00
.editorconfig editorconfig: include markdown specifications 2020-10-23 16:29:50 +02:00
.git-blame-ignore-revs git: ignore isort commit 2022-09-12 13:32:51 +02:00
.gitignore test: regenerate X509 test certs 2024-11-22 10:15:50 +01:00
.gitlab-ci.yml github: drop Fedora 40, add Fedora 42 2025-05-16 16:56:15 +02:00
.mypy.ini sbom/spdx: use compliant license expressions 2025-02-27 13:31:19 +01:00
.packit.yaml Packit: build RPMs in COPR for c10s and c9s on all arches 2024-06-17 11:43:40 +02:00
.ruff.toml meta: rename -meta.json to .meta.json 2024-03-14 13:37:57 +01:00
CODEOWNERS CODEOWNERS: Assign ownership for CoreOS-related files 2024-12-05 09:28:59 +01:00
LICENSE Revert "Fill in the license template" 2019-11-18 12:23:10 +01:00
Makefile Makefile: run tox parallel without the spinner 2024-08-07 17:27:35 +02:00
osbuild.spec spec: Don't use tomli on Fedora, fix comment 2025-06-12 16:38:55 +02:00
README.md README: remove mailing list 2025-01-17 14:11:16 +01:00
requirements.txt Makefile: use pytest for nicer output 2020-12-04 18:24:48 +01:00
samples samples: replace with symlink to test data 2021-07-12 18:44:50 +02:00
Schutzfile schutzfile: Update snapshots to 20250605 2025-06-16 13:39:30 +02:00
setup.cfg Lint/pylint: disable too-many-positional-arguments check 2024-11-25 10:09:18 +01:00
setup.py Post release version bump 2025-06-04 08:35:40 +00:00
tox.ini sbom/spdx: use compliant license expressions 2025-02-27 13:31:19 +01:00

OSBuild

Build-Pipelines for Operating System Artifacts

OSBuild is a pipeline-based build system for operating system artifacts. It defines a universal pipeline description and a build system to execute them, producing artifacts like operating system images, working towards an image build pipeline that is more comprehensible, reproducible, and extendable.

See the osbuild(1) man-page for details on how to run osbuild, the definition of the pipeline description, and more.

Project

Principles

  1. OSBuild stages are never broken, only deprecated. The same manifest should always produce the same output.
  2. OSBuild stages should be explicit whenever possible instead of e.g. relying on the state of the tree.
  3. Pipelines are independent, so the tree is expected to be empty at the beginning of each.
  4. Manifests are expected to be machine-generated, so OSBuild has no convenience functions to support manually created manifests.
  5. The build environment is confined against accidental misuse, but this should not be considered a security boundary.
  6. OSBuild may only use Python language features supported by the oldest target distribution.

Contributing

Please refer to the developer guide to learn about our workflow, code style and more.

Requirements

The requirements for this project are:

  • bubblewrap >= 0.4.0
  • python >= 3.6

Additionally, the built-in stages require:

  • bash >= 5.0
  • coreutils >= 8.31
  • curl >= 7.68
  • qemu-img >= 4.2.0
  • rpm >= 4.15
  • tar >= 1.32
  • util-linux >= 235
  • skopeo
  • python3-librepo

At build-time, the following software is required:

  • python-docutils >= 0.13
  • pkg-config >= 0.29

Testing requires additional software:

  • pytest

Build

Osbuild is a python script so it is not compiled. To verify changes made to the code use included makefile rules:

  • make lint to run linter on top of the code
  • make test-all to run base set of tests
  • sudo make test-run to run extended set of tests (takes long time)

Also keep in mind that some tests require those prerequisites, otherwise they are skipped

sudo dnf install -y systemd-boot-unsigned erofs-utils pykickstart podman xfsprogs

Installation

Installing osbuild requires to not only install the osbuild module, but also additional artifacts such as tools (i.e: osbuild-mpp) sources, stages, schemas and SELinux policies.

For this reason, doing an installation from source is not trivial and the easier way to install it is to create the set of RPMs that contain all these components.

This can be done with the rpm make target, i.e:

make rpm

A set of RPMs will be created in the ./rpmbuild/RPMS/noarch/ directory and can be installed in the system using the distribution package manager, i.e:

sudo dnf install ./rpmbuild/RPMS/noarch/*.rpm

Repository

License

  • Apache-2.0
  • See LICENSE file for details.