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.

Sign up for GitHub

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

Jump to bottom

Update ARM build docs #723

Merged
merged 3 commits into from
Jun 12, 2024
Merged

Update ARM build docs #723

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fa1199d
Update build-for-arm.md
runesoerensen Jun 5, 2024
0fed941
Add PHP to list of buildpacks
runesoerensen Jun 5, 2024
92de27c
Merge branch 'main' into patch-2
AidanDelaney Jun 12, 2024
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
10 changes: 5 additions & 5 deletions content/docs/for-app-developers/how-to/special-cases/build-for-arm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ weight=1
<!--more-->

Building for the ARM architecture is now easier than ever! The `heroku/builder:24` builder supports both AMD64 and ARM64 architectures, and includes
multi-arch Java, Node.js, Python, Ruby, Scala and Go buildpacks. You can read more about Heroku's [Cloud Native Buildpacks here][heroku-buildpacks].
multi-arch Go, Java, Node.js, PHP, Python, Ruby and Scala buildpacks. You can read more about Heroku's [Cloud Native Buildpacks here][heroku-buildpacks].

### 1. Clone the [samples][samples] repository

Expand All @@ -22,17 +22,17 @@ git clone https://github.com/buildpacks/samples

### 2. Build the app

If you're using an ARM64 computer (such as an Apple Silicon Mac, or an AWS Graviton instance), you can produce an ARM64 OCI image with [pack][pack] simply by setting your builder to `heroku/builder:24`:
If you're using an ARM64 computer (such as an Apple Silicon Mac, or an AWS Graviton instance), you can build an ARM64 OCI image with [pack][pack] simply by setting your builder to `heroku/builder:24`:
```
pack build java-maven-sample --path samples/apps/java-maven/ --builder heroku/builder:24
```
<!--+- "{{execute}}"+-->

As `heroku/builder:24` is a multi-arch builder, it'll default to the current architecture, and an AMD64 image will be built when running `pack` on that architecture.
By default, `pack` uses the current architecture for multi-arch builders like `heroku/builder:24`, so an AMD64 image will be built on AMD64 systems.

If you want to build an ARM64 image from a different host architecture, you can use the arch-specific builder tag: `heroku/builder:24_linux-arm64`:
If you want to build an ARM64 image from a different host architecture, use the `--platform` parameter:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does building a linux/arm64 image on a linux/amd64 host would require some form of arm64 emulator? I know we can assemble the images. But does building work in the general case? For example, if I'm building a Python application that, in turn, needs to compile a C library?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If I understand you correctly, I think the answer to both your questions is yes -- building an linux/arm64 image on a linux/amd64 host does require an emulator capable of emulating/virtualizing a different architecture (like Docker :)), and building should generally work - also if a user needs to compile a C library.

Running pack build with the --builder heroku/builder:24 --platform linux/arm64 parameters is equivalent to using the arch-specific heroku/builder:24_linux-arm64 builder tag currently in the docs, and the builder will be the same either way.

However, the only reason to use --builder heroku/builder:24_linux-arm64 (and the reason we added arch-specific tags) was that pack build didn't allow specifying a --platform for multi-arch builders until just recently. It was a bit of a hack which, since the introduction of pack v0.34.0, is fortunately no longer necessary! :)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah great. I'll land this. But it would be also nice to have a list of builders that support ARM in this doc (simply because ARM support is still a little rare).

```
pack build java-maven-sample --path samples/apps/java-maven/ --builder heroku/builder:24_linux-arm64
pack build java-maven-sample --path samples/apps/java-maven/ --builder heroku/builder:24 --platform linux/arm64
```
<!--+- "{{execute}}"+-->

Expand Down
Loading