debian-forge/README.md
Alexander Larsson 46a228df38 Add support for installing containers in images
This adds a stage called org.osbuild.skopeo that installs docker and
oci archive files into the container storage of the tree being
constructed.

The source can either be a file from another pipeline, for example one
created with the existing org.osbuild.oci-archive stage, or it can
be using the new org.osbuild.skopeo source and org.osbuild.containers
input, which will download an image from a registry and install that.

There is an optional option in the install stage that lets you
configure a custom storage location, which allows the use of the
additionalimagestores option in the container storage.conf
to use a read-only image stores (instead of /var/lib/container).

Note: skopeo fails to start if /etc/containers/policy.json is
not available, so we bind mount it from the build tree to the
buildroot if available.
2022-02-10 14:43:17 +01:00

83 lines
2.2 KiB
Markdown

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>
* **IRC**: #osbuild on [Libera.Chat](https://libera.chat/)
* **Changelog**: <https://github.com/osbuild/osbuild/releases>
#### Contributing
Please refer to the [developer guide](https://www.osbuild.org/guides/developer-guide/developer-guide.html) to learn about our workflow, code style and more.
### Requirements
The requirements for this project are:
* `bubblewrap >= 0.4.0`
* `python >= 3.7`
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`
### Install
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:
```sh
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:
```sh
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.