Skip to content

Commit

Permalink
chore(docs): RHIDP-1351 add doc about multi-arch support / how to bui…
Browse files Browse the repository at this point in the history
…ld this repo locally (#1166)

Signed-off-by: Nick Boldt <nboldt@redhat.com>
  • Loading branch information
nickboldt committed Jul 17, 2024
1 parent 50b56b9 commit 1bf4b0f
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,3 +78,19 @@ You can find the Backstage Showcase app running at <https://showcase.janus-idp.i
For more information on our plugin offerings, consult the [Janus IDP Backstage Plugins](https://github.com/janus-idp/backstage-plugins) repo.

Want to know more about Backstage, consult the [documentation](https://backstage.io/docs/overview/what-is-backstage) and [GitHub](https://github.com/backstage/backstage) repo.

## Multi-arch support

RHDH is currently only available for amd64/x86_64.

For additional architecture support, please vote for https://issues.redhat.com/browse/RHIDP-1351 with your reason for needing additional arches.

If you want an image that runs on Mac M1 (arm64/aarch64) or another architecture, you will need to build it yourself.

### Building locally

Check out this repo, choose the branch or tag you want to use, then build an image:

```
podman build -f docker/Dockerfile . -t janus-idp/backstage-showcase:local
```
31 changes: 31 additions & 0 deletions docker/README.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Building this repo as a container image

## Multi-arch support

RHDH is currently only available for amd64/x86_64.

If you want an image that runs on Mac M1 (arm64/aarch64) or another architecture, you will need to build it yourself.

## Building locally

Check out this repo, choose the branch or tag you want to use, then build an image:

```
podman build -f docker/Dockerfile . -t janus-idp/backstage-showcase:local
```

## Downstream builds

Downstream dockerfile and configuration can be found here:

* link:../.rhdh/docker/[.rhdh/docker]
Downstream sources use the above folder to transform sources in this repo to something that can be built within the Red Hat build pipeline.

*_Red Hat VPN access required._*

* https://gitlab.cee.redhat.com/rhidp/rhdh
For more info on building downstream with the Red Hat build pipeline, see the docs.

* https://gitlab.cee.redhat.com/rhidp/rhdh/-/blob/rhdh-1-rhel-9/docs/RHDH-FAQ.adoc?ref_type=heads

0 comments on commit 1bf4b0f

Please sign in to comment.