https://github.com/osbuild/image-builder-crc
Middleware service for console.redhat.com, between osbuild/image-builder-frontend and osbuild/osbuild-composer.
https://github.com/osbuild/image-builder-crc
Last synced: over 1 year ago
JSON representation
Middleware service for console.redhat.com, between osbuild/image-builder-frontend and osbuild/osbuild-composer.
- Host: GitHub
- URL: https://github.com/osbuild/image-builder-crc
- Owner: osbuild
- License: apache-2.0
- Created: 2020-03-26T14:49:37.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2025-04-05T07:00:38.000Z (over 1 year ago)
- Last Synced: 2025-04-05T15:49:13.966Z (over 1 year ago)
- Language: Go
- Homepage:
- Size: 20.2 MB
- Stars: 54
- Watchers: 17
- Forks: 46
- Open Issues: 44
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Image Builder console.redhat.com Middleware
"Image Builder **C**onsole.**R**edhat.**C**om" serves as
an HTTP API on top of [Osbuild Composer](https://github.com/osbuild/osbuild-composer),
and serves as the backend for [Image Builder Frontend](https://github.com/osbuild/image-builder-frontend/).
Image Builder Middleware is intended to be run within the
[console.redhat.com](https://console.redhat.com/insights/image-builder) platform.
### Project
* **Website**:
* **Bug Tracker**:
* **Discussions**: https://github.com/orgs/osbuild/discussions
* **Matrix**: [#image-builder on fedoraproject.org](https://matrix.to/#/#image-builder:fedoraproject.org)
* **Changelog**:
### OpenAPI spec
The latest OpenAPI specification:
* [raw YAML](https://github.com/osbuild/image-builder-crc/blob/main/internal/v1/api.yaml)
* [on-line version](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/osbuild/image-builder-crc/main/internal/v1/api.yaml)
### Contributing
Please refer to the [hacking guide](HACKING.md) 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
```sh
make unit-tests
```
Before pushing something for a pull request you should run this check to avoid problems with required github actions
```sh
make push-check
```
### Installation
To run the project use `make run` target
## Repository
- **web**:
- **https**: `https://github.com/osbuild/image-builder-crc.git`
- **ssh**: `git@github.com:osbuild/image-builder-crc.git`
## License
- **Apache-2.0**
- See LICENSE file for details.