README
¶
Images
Project
- Website: https://www.osbuild.org
- Bug Tracker: https://github.com/osbuild/images/issues
- Matrix (chat): Image Builder channel on Fedora Chat
- Changelog: https://github.com/osbuild/images/releases
Principles
- The image definitions API is internal and can therefore be broken. The blueprint API is the stable API.
- Nonsensical manifests should not compile (at the Golang level).
- OSBuild units (stages, sources, inputs, mounts, devices) should be directly mapped into Go objects.
- Image definitions don’t test distributions that are end-of-life. Respective code-paths should be dropped.
- Image definitions need to support the oldest supported target distribution.
Contributing
Please refer to the developer guide to learn about our workflow, code style and more.
The build-requirements for Fedora and rpm-based distributions are:
gpgme-devel,btrfs-progs-devel,device-mapper-devel
Repository:
- web: https://github.com/osbuild/images
- https:
https://github.com/osbuild/images.git - ssh:
git@github.com:osbuild/images.git
Pull request gating
Each pull request against images starts a series of automated
tests. Tests run via GitHub Actions and GitLab CI. Each push to the pull request
will launch theses tests automatically.
License:
- Apache-2.0
- See LICENSE file for details.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
build
Standalone executable for building a test image.
|
Standalone executable for building a test image. |
|
gen-manifests
Standalone executable for generating all test manifests in parallel.
|
Standalone executable for generating all test manifests in parallel. |
|
list-images
Standalone executable that lists all supported combinations of distribution, architecture, and image type.
|
Standalone executable that lists all supported combinations of distribution, architecture, and image type. |
|
osbuild-package-sets
Simple tool to dump a JSON object containing all package sets for a specific distro x arch x image type.
|
Simple tool to dump a JSON object containing all package sets for a specific distro x arch x image type. |
|
internal
|
|
|
pkg
|
|
|
blueprint
Package blueprint contains primitives for representing weldr blueprints
|
Package blueprint contains primitives for representing weldr blueprints |
|
container
package container implements a client for a container registry.
|
package container implements a client for a container registry. |
|
crypt
Copied from https://github.com/amoghe/go-crypt/blob/b3e291286513a0c993f7c4dd7060d327d2d56143/crypt_r.go Original sources are under MIT license: The MIT License (MIT)
|
Copied from https://github.com/amoghe/go-crypt/blob/b3e291286513a0c993f7c4dd7060d327d2d56143/crypt_r.go Original sources are under MIT license: The MIT License (MIT) |
|
disk
Package disk contains data types and functions to define and modify disk-related and partition-table-related entities.
|
Package disk contains data types and functions to define and modify disk-related and partition-table-related entities. |
|
dnfjson
Package dnfjson is an interface to the dnf-json Python script that is packaged with the osbuild-composer project.
|
Package dnfjson is an interface to the dnf-json Python script that is packaged with the osbuild-composer project. |
|
manifest
Package manifest is used to define an osbuild manifest as a series of pipelines with content.
|
Package manifest is used to define an osbuild manifest as a series of pipelines with content. |
|
osbuild
Package osbuild provides primitives for representing and (un)marshalling OSBuild (schema v2) types.
|
Package osbuild provides primitives for representing and (un)marshalling OSBuild (schema v2) types. |
Click to show internal directories.
Click to hide internal directories.