README
¶
Images
This repository is, primarily, a Go library for generating osbuild manifests
(more details here).
It also has some libraries for uploading artifacts to cloud platforms and Koji.
The binaries implemented in cmd/ are for development and testing purposes and not part of the library.
Project
- Website: https://www.osbuild.org
- Bug Tracker: https://github.com/osbuild/images/issues
- Discussions: https://github.com/orgs/osbuild/discussions
- 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.
See also the local developer documentation for useful information about working with this specific project.
The build-requirements of the Go library for Fedora and rpm-based distributions are:
gogpgme-devel
(see also Containerfile )
Other dependencies only needed in some cases are:
btrfs-progs-devel,device-mapper-devel
build dependencies for the unit tests and projects that importpkg/container, which even in that case can be skipped using exclude_graphdriver_btrfs and exclude_graphdriver_devicemapper (see bootc-image-builder).krb5-devel
build dependency for the unit tests and projects that importpkg/upload/kojiosbuild-depsolve-dnf
runtime dependency for the unit tests and projects that importpkg/dnfjson. or to runcmd/gen-manifestsandcmd/buildosbuild(and subpackages)
runtime dependencies forcmd/build.
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
|
|
|
boot-aws
command
|
|
|
build
command
Standalone executable for building a test image.
|
Standalone executable for building a test image. |
|
gen-manifests
command
Standalone executable for generating all test manifests in parallel.
|
Standalone executable for generating all test manifests in parallel. |
|
list-images
command
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-mock-openid-provider
command
|
|
|
osbuild-package-sets
command
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. |
|
osbuild-playground
command
|
|
|
osbuild-upload-azure
command
|
|
|
osbuild-upload-container
command
|
|
|
osbuild-upload-gcp
command
|
|
|
osbuild-upload-generic-s3
command
|
|
|
osbuild-upload-oci
command
|
|
|
otk/osbuild-gen-partition-table
command
|
|
|
otk/osbuild-make-fstab-stage
command
|
|
|
otk/osbuild-make-ostree-source
command
|
|
|
otk/osbuild-resolve-containers
command
|
|
|
data
|
|
|
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. |
|
test
|
|
Click to show internal directories.
Click to hide internal directories.