48c31fa24f
Some checks are pending
Checks / Spelling (push) Waiting to run
Checks / Python Linters (push) Waiting to run
Checks / Shell Linters (push) Waiting to run
Checks / 📦 Packit config lint (push) Waiting to run
Checks / 🔍 Check for valid snapshot urls (push) Waiting to run
Checks / 🔍 Check JSON files for formatting consistency (push) Waiting to run
Generate / Documentation (push) Waiting to run
Generate / Test Data (push) Waiting to run
Tests / Unittest (push) Waiting to run
Tests / Assembler test (legacy) (push) Waiting to run
Tests / Smoke run: unittest as normal user on default runner (push) Waiting to run
- Add build status tracking with state machine - Implement build logging and monitoring system - Add build progress tracking and cancellation support - Create artifact management system with SQLite database - Fix stage file extensions for proper Python imports - Enhance resource allocation with actual resource tracking - Add comprehensive testing for all components |
||
|---|---|---|
| .devcontainer | ||
| .github | ||
| artifacts/metadata | ||
| assemblers | ||
| build-logs | ||
| data | ||
| devices | ||
| docs | ||
| inputs | ||
| mounts | ||
| osbuild | ||
| runners | ||
| schemas | ||
| schutzbot | ||
| selinux | ||
| sources | ||
| stages | ||
| test | ||
| tools | ||
| .bandit | ||
| .editorconfig | ||
| .git-blame-ignore-revs | ||
| .gitignore | ||
| .gitlab-ci.yml | ||
| .mypy.ini | ||
| .packit.yaml | ||
| .ruff.toml | ||
| artifact_manager.py | ||
| artifacts.db | ||
| build_orchestrator.py | ||
| CODEOWNERS | ||
| LICENSE | ||
| Makefile | ||
| osbuild.spec | ||
| README.md | ||
| requirements.txt | ||
| samples | ||
| Schutzfile | ||
| setup-apt-cacher.sh | ||
| setup-build-env.sh | ||
| setup.cfg | ||
| setup.py | ||
| test-apt-stage.py | ||
| test-build-orchestration.py | ||
| test-debian-atomic-manifest.json | ||
| test-debian-manifest.json | ||
| test-debian-stages.py | ||
| test-resource-allocation.py | ||
| tox.ini | ||
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
- Website: https://www.osbuild.org
- Bug Tracker: https://github.com/osbuild/osbuild/issues
- Discussions: https://github.com/orgs/osbuild/discussions
- Matrix: #image-builder on fedoraproject.org
- Changelog: https://github.com/osbuild/osbuild/releases
Principles
- OSBuild stages are never broken, only deprecated. The same manifest should always produce the same output.
- OSBuild stages should be explicit whenever possible instead of e.g. relying on the state of the tree.
- Pipelines are independent, so the tree is expected to be empty at the beginning of each.
- Manifests are expected to be machine-generated, so OSBuild has no convenience functions to support manually created manifests.
- The build environment is confined against accidental misuse, but this should not be considered a security boundary.
- 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.0python >= 3.6
Additionally, the built-in stages require:
bash >= 5.0coreutils >= 8.31curl >= 7.68qemu-img >= 4.2.0rpm >= 4.15tar >= 1.32util-linux >= 235skopeopython3-librepo
At build-time, the following software is required:
python-docutils >= 0.13pkg-config >= 0.29
Testing requires additional software:
pytest
Running locally
The main binary is safe to run on your development machine with:
python3 -m osbuild --libdir .
To build an image:
python3 -m osbuild --libdir . ./test/data/manifests/fedora-boot.json
Every osbuild run uses a cache for downloaded files (sources) and, optionally,
checkpoints of artifacts built by stages and pipelines. By default, this is
kept in .osbuild (in the current working directory). The location of this
directory can be specified using the --cache option.
For more information about the options and arguments, read man pages.
Build
Osbuild is a python script so it is not compiled. To verify changes made to the code use included makefile rules:
make lintto run linter on top of the codemake test-allto run base set of testssudo make test-runto 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:
sudo dnf builddep osbuild.spec
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
- web: https://github.com/osbuild/osbuild
- https:
https://github.com/osbuild/osbuild.git - ssh:
git@github.com:osbuild/osbuild.git
License
- Apache-2.0
- See LICENSE file for details.