Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: rename image-builder to image-builder-crc (HMS-5504) #152

Merged
merged 1 commit into from
Feb 13, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
custom_edit_url: https://github.com/osbuild/image-builder/blob/main/HACKING.md
custom_edit_url: https://github.com/osbuild/image-builder-crc/blob/main/HACKING.md
---
# Image Builder contributing guide

<!--
[//]: # ( 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/HACKING.md )
[//]: # ( Rather change the source of this: https://github.com/osbuild/image-builder-crc/blob/main/HACKING.md )
-->

Please refer to the [developer guide](https://www.osbuild.org/docs/developer-guide/index) to learn about our workflow, code style and more.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
custom_edit_url: https://github.com/osbuild/image-builder/blob/main/README.md
custom_edit_url: https://github.com/osbuild/image-builder-crc/blob/main/README.md
---
# Image Builder console.redhat.com Middleware

<!--
[//]: # ( 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 )
[//]: # ( Rather change the source of this: https://github.com/osbuild/image-builder-crc/blob/main/README.md )
-->

"Image Builder **C**onsole.**R**edhat.**C**om" serves as
Expand Down
4 changes: 2 additions & 2 deletions docs/hosted/architecture/01-image-builder-crc.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The actual image build requests are passed on to `composer`, which is outside th

## Technology Stack
The service is written in Golang, and the list of dependencies can be found in
[go.mod](https://github.com/osbuild/image-builder/blob/main/go.mod).
[go.mod](https://github.com/osbuild/image-builder-crc/blob/main/go.mod).

The `ubi8/go-toolset:latest` container is used as a builder, and `ubi8/ubi-minimal:latest` to run the
binary. The container images are located here: https://quay.io/repository/cloudservices/image-builder.
Expand Down Expand Up @@ -82,7 +82,7 @@ Image Builder is currently being load tested on a weekly basis with failure thre
SLIs. The load tests happen against stage CRC. An example can be found
[here](https://gitlab.com/osbuild/ci/image-builder/-/jobs/1541382293).

More information can be found [upstream](https://github.com/osbuild/image-builder/blob/main/test/README.md).
More information can be found [upstream](https://github.com/osbuild/image-builder-crc/blob/main/test/README.md).

## Capacity
The needed capacity might grow a little bit in all directions (DB and number of pods), but any growth should
Expand Down
6 changes: 3 additions & 3 deletions docs/hosted/architecture/architecture.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions docs/hosted/architecture/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ The architecture documents in this section comply with the AppSRE contract.

Our [developer guide](../../developer-guide/00-index.md) is a great starting point to learn about our workflow, code style and more!

If you want to contribute to our frontend or backend, here are guides on how to get the respective stack set up for development:
If you want to contribute to our frontend or middleware (aka `image-builder-crc`), here are guides on how to get the respective stack set up for development:
* [image-builder-frontend](https://github.com/RedHatInsights/image-builder-frontend#frontend-development)
* [image-builder-backend](https://github.com/RedHatInsights/image-builder-frontend/blob/main/devel/README.md)
* [image-builder-crc](https://github.com/RedHatInsights/image-builder-frontend/blob/main/devel/README.md)

### How to reach out to us

Expand All @@ -42,7 +42,7 @@ If you want to contribute to our frontend or backend, here are guides on how to
* 🟢 Performance tests are open.
* 🟢 Functional tests are open.
* 🟢 The dependencies are open source.
* 🟢 Deployment metadata is open. [[1]](https://github.com/osbuild/osbuild-composer/blob/main/templates/composer.yml) [[2]](https://github.com/osbuild/image-builder/blob/main/templates/image-builder.yml)
* 🟢 Deployment metadata is open. [[1]](https://github.com/osbuild/osbuild-composer/blob/main/templates/composer.yml) [[2]](https://github.com/osbuild/image-builder-crc/blob/main/templates/image-builder.yml)
#### 🟢 Contribution workflow
* 🟢 External contributors can follow the same workflow as team members.
* 🟢 [The workflow is publicly documented.](../../developer-guide/01-general/workflow.md)
Expand Down
4 changes: 2 additions & 2 deletions readme-list
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ osbuild-composer/main/CONTRIBUTING.md:docs/developer-guide/02-projects/osbuild-c
osbuild-composer/main/DEPLOYING.md:docs/developer-guide/02-projects/osbuild-composer/DEPLOYING.md
osbuild-composer/main/test/README.md:docs/developer-guide/02-projects/osbuild-composer/test/README.md
# Image Builder
image-builder/main/README.md:docs/developer-guide/02-projects/image-builder/index.md
image-builder/main/HACKING.md:docs/developer-guide/02-projects/image-builder/HACKING.md
image-builder-crc/main/README.md:docs/developer-guide/02-projects/image-builder-crc/index.md
image-builder-crc/main/HACKING.md:docs/developer-guide/02-projects/image-builder-crc/HACKING.md
# Image Builder Frontend
image-builder-frontend/main/README.md:docs/developer-guide/02-projects/image-builder-frontend/index.md
# Cockpit composer
Expand Down
Loading