No description
Find a file
Achilleas Koutsou 45510aeb64 sources: new source: containers-storage
This source checks for the existence of a local container in the host's
containers-storage. The source first reads the host's
`/etc/containers/storage.conf` file for the storage config and then
checks if the user has imported the desired container into the local
store.

Unlike the org.osbuild.containers stource, the
org.osbuild.containers-storage source doesn't need any extra data other
than the image ID.  The ID is all that is used to retrieve the
container.  The location and other information regarding the storage are
read from the host configuration and are not encoded in the manifest
There's no need to use the name to resolve it like we do in other
sources because containers in the local storage can be directly
referenced by their image id (config digest).

Other data such as the name of the container will only be relevant in
the stage that will use the container as input.

The source items are objects instead of simple strings of checksums
because we might, in the future, want to add specific options for each
source.

The content_type for this source is `containers-storage`, which defines
the location in the store where the source will bind mount the host's
container storage for stages to read.  We make this different from the
containers content because it will be treated differently enough to need
a separate input type.

Co-authored-by: Gianluca Zuccarelli <gzuccare@redhat.com>
Co-Authored-By: Michael Vogt <michael.vogt@gmail.com>
2024-02-21 17:55:37 +01:00
.devcontainer devcontainer: install parted for test_mount_with_partition 2023-12-22 10:18:29 -05:00
.github test: drop -k from -k stages/test test matrix 2024-01-31 09:24:59 +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: enable partition scanning as an option 2023-12-22 10:18:29 -05:00
docs add --break for requesting a debug shell 2024-01-10 08:39:27 -08:00
inputs inputs/ostree: leverage util/ostree library code 2023-10-16 20:26:10 +02:00
mounts mount/ostree.deployment: Fix ostree deployment call 2024-02-12 11:25:11 -05:00
osbuild util/containers: read host config 2024-02-21 17:55:37 +01:00
runners runners: add debian runner (based on ubuntu1804) 2024-01-02 18:40:31 +01:00
schemas mounts: support mounting partitions 2023-12-22 10:18:29 -05:00
schutzbot CI: update terraform SHA 2024-01-31 12:34:57 +01:00
selinux docs: document osbuild and selinux integration 2021-10-01 11:02:32 +02:00
sources sources: new source: containers-storage 2024-02-21 17:55:37 +01:00
stages Stages/grub2.legacy: make config options a subset of grub2 stage 2024-02-21 17:51:28 +01:00
test stage/systemd-unit:stage to create systemd unit file 2024-02-16 11:55:11 +01:00
tools tools: make osbuild-depsolve-dnf5 pylint clean 2024-02-20 14:52:23 -08: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 Switch rpmbuild to RHEL 8.9/9.3 GA 2024-01-18 19:19:23 +01:00
.mypy.ini util/containers: read host config 2024-02-21 17:55:37 +01: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 osbuild: add "mypy-strict" check 2024-01-23 12:01:45 +01:00
osbuild.spec util/containers: read host config 2024-02-21 17:55:37 +01:00
README.md Fix developer guide link in README.md 2024-02-20 23:45:20 -08: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: Fedora-40 branched 2024-02-16 11:55:11 +01:00
setup.cfg tox: add tox 2023-08-01 15:01:13 +02:00
setup.py Post release version bump 2024-02-14 08:13:58 +00:00
tox.ini tox: add all non shell file in tools/ to lintables 2024-02-20 14:52:23 -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

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

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.