README.md

Image Builder

Image Builder serves as an HTTP API on top of Osbuild Composer, and serves as the backend for Image Builder Frontend.

Image Builder is intended to be run within the console.redhat.com platform.

Project

• Website: https://www.osbuild.org
• Bug Tracker: https://github.com/osbuild/image-builder/issues
• Discussions: https://github.com/orgs/osbuild/discussions
• Matrix: #image-builder on fedoraproject.org
• Mailing List: [email protected]
• Changelog: https://github.com/osbuild/image-builder/releases

OpenAPI spec

The latest OpenAPI specification:

• raw YAML
• on-line version

Contributing

Please refer to the hacking guide to learn more.

Build

Project building and testing project is based on predefined make targets:

• make build to trigger Go builder

Run Tests

To run the tests locally just call

make unit-tests

Before pushing something for a pull request you should run this check to avoid problems with required github actions

make push-check

Installation

To run the project use make run target

Repository

• web: https://github.com/osbuild/image-builder
• https: https://github.com/osbuild/image-builder.git
• ssh: [email protected]:osbuild/image-builder.git

License

• Apache-2.0
• See LICENSE file for details.