images

module

v0.107.0 Latest Latest Go to latest Published: Dec 20, 2024 License: Apache-2.0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

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:

go
gpgme-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 import pkg/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 import pkg/upload/koji
osbuild-depsolve-dnf
runtime dependency for the unit tests and projects that import pkg/dnfjson. or to run cmd/gen-manifests and cmd/build
osbuild (and subpackages)
runtime dependencies for cmd/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
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-composer-image-definitions
osbuild-mock-openid-provider
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.
osbuild-playground
osbuild-upload-azure
osbuild-upload-container
osbuild-upload-gcp
osbuild-upload-generic-s3
osbuild-upload-oci
otk/osbuild-gen-partition-table
otk/osbuild-make-fstab-stage
otk/osbuild-make-grub2-inst-stage
otk/osbuild-make-ostree-source
otk/osbuild-make-partition-mounts-devices
otk/osbuild-make-partition-stages
otk/osbuild-resolve-containers
otk/osbuild-resolve-ostree-commit
internal
assertx
buildconfig
cmdutil
common
environment
mocks/rpmrepo
otkdisk
otkostree
target
test
testdisk
testregistry
worker/clienterrors
workload
pkg
arch
artifact
blueprint Package blueprint contains primitives for representing weldr blueprints	Package blueprint contains primitives for representing weldr blueprints
cert
cloud/awscloud
cloud/gcp
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)
customizations/anaconda
customizations/bootc
customizations/fdo
customizations/fsnode
customizations/ignition
customizations/kickstart
customizations/oscap
customizations/remotefile
customizations/shell
customizations/subscription
customizations/users
datasizes
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.
distro
distro/distro_test_common
distro/fedora
distro/rhel
distro/rhel/rhel10
distro/rhel/rhel7
distro/rhel/rhel8
distro/rhel/rhel9
distro/test_distro
distrofactory
distroidparser
distrosort
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.
image
imagefilter
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.
ostree
ostree/mock_ostree_repo
ostree/test_mtls_server
pathpolicy
platform
policies
reporegistry
rhsm
rhsm/facts
rpmmd
runner
sbom
upload/azure
upload/koji
upload/oci
upload/vmware
test
data/repositories

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL