No description
Find a file
Michael Vogt 4e3fc6a625 osbuild: pytoml is deprecated, replace with toml
Pytoml is no longer being maintained: https://github.com/avakar/pytoml
The author suggest switching to toml.

We already use the
```
try:
    import toml
except ModuleNotFoundError:
    import pytoml as toml
```
pattern in stages/org.osbuild.containers.storage.conf so use it in the tests too to prefer "toml" instead of pytoml.
2023-12-12 14:06:50 -08:00
.devcontainer devcontainer: include packit, boto3 & more tools 2021-08-17 10:42:03 +02:00
.github tests: run the test_stages category in parallel 2023-11-08 08:10:34 +01:00
assemblers tox: add tox 2023-08-01 15:01:13 +02:00
data devices: add custom udev rule inhibitor mechanism 2021-12-09 00:44:21 +00:00
devices devices/loopback: make setting sector_size meaningful 2023-11-29 10:37:08 +01:00
docs docs: tweak the man-page a bit to make the example more useful 2023-11-17 17:23:40 +01:00
inputs inputs/ostree: leverage util/ostree library code 2023-10-16 20:26:10 +02:00
mounts mounts/org.osbuild.btrfs: add support for compression 2023-08-25 12:35:56 +02:00
osbuild fscache: add new FsCache._last_used() helper 2023-12-12 22:57:21 +01:00
runners runners: clean up temp files before exiting the runner 2023-11-28 11:50:31 +01:00
schemas schemas/osbuild2: mark version as required 2022-07-25 16:01:48 +02:00
schutzbot ci: update terraform hash 2023-12-08 14:29:52 +01:00
selinux docs: document osbuild and selinux integration 2021-10-01 11:02:32 +02:00
sources osbuild/util/ostree: create setup_remote function 2023-10-16 20:26:10 +02:00
stages osbuild: pytoml is deprecated, replace with toml 2023-12-12 14:06:50 -08:00
test fscache: add new FsCache._last_used() helper 2023-12-12 22:57:21 +01:00
tools osbuild-mpp: conditional losetup 2023-11-30 14:16:57 +01: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 tox: add tox 2023-08-01 15:01:13 +02:00
.gitlab-ci.yml rpmbuild: add fedora-40 2023-12-06 10:11:32 +01:00
.mypy.ini osbuild: fix optional-types 2022-07-13 17:31:37 +02:00
.packit.yaml Packit: make COPR builds for new releases in a dedicated project 2023-11-30 14:23:15 +01:00
.ruff.toml tox: add tox 2023-08-01 15:01:13 +02:00
LICENSE Revert "Fill in the license template" 2019-11-18 12:23:10 +01:00
Makefile Makefile: Update helper notes 2023-12-05 11:46:16 +01:00
osbuild.spec Post release version bump 2023-12-06 08:15:39 +00:00
README.md Readme: Update project build information 2023-12-05 11:46: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 rpmbuild: add fedora-40 2023-12-06 10:11:32 +01:00
setup.cfg tox: add tox 2023-08-01 15:01:13 +02:00
setup.py Post release version bump 2023-12-06 08:15:39 +00:00
tox.ini osbuild: pytoml is deprecated, replace with toml 2023-12-12 14:06:50 -08: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

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

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)

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.