-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
18 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,31 +1,35 @@ | ||
| --- | ||
| custom_edit_url: https://github.com/osbuild/image-builder/blob/main/README.md | ||
| --- | ||
| Image Builder | ||
| ============= | ||
| # Image Builder console.redhat.com Middleware | ||
|
|
||
| Image Builder 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/). | ||
| <!-- | ||
| [//]: # ( DO NOT MODIFY THIS FILE! ) | ||
| [//]: # ( This content is generated by `scripts/pull_readmes.py` ) | ||
| [//]: # ( Rather change the source of this: https://github.com/osbuild/image-builder/blob/main/README.md ) | ||
| --> | ||
|
|
||
| Image Builder is intended to be run within the | ||
| "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) platform. | ||
|
|
||
| ### Project | ||
|
|
||
| * **Website**: https://www.osbuild.org | ||
| * **Bug Tracker**: https://github.com/osbuild/image-builder/issues | ||
| * **Bug Tracker**: https://github.com/osbuild/image-builder-crc/issues | ||
| * **Discussions**: https://github.com/orgs/osbuild/discussions | ||
| * **Matrix**: [#image-builder on fedoraproject.org](https://matrix.to/#/#image-builder:fedoraproject.org) | ||
| * **Changelog**: https://github.com/osbuild/image-builder/releases | ||
| * **Changelog**: https://github.com/osbuild/image-builder-crc/releases | ||
|
|
||
| ### OpenAPI spec | ||
|
|
||
| The latest OpenAPI specification: | ||
|
|
||
| * [raw YAML](https://github.com/osbuild/image-builder/blob/main/internal/v1/api.yaml) | ||
| * [on-line version](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/osbuild/image-builder/main/internal/v1/api.yaml) | ||
| * [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 | ||
|
|
||
|
|
@@ -57,9 +61,9 @@ 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` | ||
| - **web**: https://github.com/osbuild/image-builder-crc | ||
| - **https**: `https://github.com/osbuild/image-builder-crc.git` | ||
| - **ssh**: `[email protected]:osbuild/image-builder-crc.git` | ||
|
|
||
| ## License | ||
|
|
||
|
|
||