Build for arm64 on amd64

[kiminuo]

Related to #345
Related to WalletWasabi/WalletWasabi#4051 (comment)
Discussion: Some discussion here: kiminuo#1

This PR just shows how to do a deterministic build for arm64 architecture. The hope is HWI's support for arm64 will improve a bit.

Setup

To set up your environment, install:

sudo apt install qemu-user-static 

Build for arm64

Use docker buildx to replicate deterministic build instructions for the arm64 build:

docker buildx build --no-cache --platform linux/arm64 -t hwi-builder -f contrib/build.Dockerfile .

# Note the use of "--without-gui".
docker run --platform linux/arm64 -it --rm --name hwi-builder -v $PWD:/opt/hwi  --workdir /opt/hwi hwi-builder /bin/bash -c "contrib/build_bin.sh --without-gui && contrib/build_dist.sh --without-gui"

i.e. the change is:

-docker build --no-cache -t hwi-builder -f contrib/build.Dockerfile .
-docker run -it --name hwi-builder -v $PWD:/opt/hwi --rm  --workdir /opt/hwi hwi-builder /bin/bash -c "contrib/build_bin.sh && contrib/build_dist.sh && contrib/build_wine.sh"
+docker buildx build --no-cache --platform linux/arm64 -t hwi-builder -f contrib/build.Dockerfile .
+docker run --platform linux/arm64 -it --rm --name hwi-builder -v $PWD:/opt/hwi  --workdir /opt/hwi hwi-builder /bin/bash -c "contrib/build_bin.sh --without-gui && contrib/build_dist.sh --without-gui"

Resources

• https://docs.docker.com/build/building/multi-platform/#building-multi-platform-images
• https://medium.com/@artur.klauser/building-multi-architecture-docker-images-with-buildx-27d80f7e2408

Limitations

No GUI support

So far I had no luck with building hwi-qt because I get the following error

Installing dependencies from lock file

Package operations: 14 installs, 0 updates, 0 removals

  • Installing shiboken2 (5.15.2): Failed

  RuntimeError

  Unable to find installation candidates for shiboken2 (5.15.2)

  at ~/.pyenv/versions/3.9.7/lib/python3.9/site-packages/poetry/installation/chooser.py:72 in choose_for
       68│ 
       69│             links.append(link)
       70│ 
       71│         if not links:
    →  72│             raise RuntimeError(
       73│                 "Unable to find installation candidates for {}".format(package)
       74│             )
       75│ 
       76│         # Get the best link

during execution of poetry install -E qt

That's why I use build_bin.sh --without-gui (see #655)

[kiminuo]

@achow101 Would you have a moment to review this PR please?

[achow101]

I've started doing arm64 builds on a raspi 4 that I have. Is this still relevant?

[kiminuo]

I've started doing arm64 builds on a raspi 4 that I have. Is this still relevant?

I believe so. But I can see there are some conflicts now.

[kiminuo]

PySide2 was not ready for arm64, I had issues with shiboken2 package (see). With #691, it might be fixed.

[kiminuo]

Just moved up in this file.

[kiminuo]

Do not run for arm64.

[kiminuo]

@achow101 It seems I succeeded in building an arm64 build using the instructions above - i.e.

docker buildx build --no-cache --platform linux/arm64 -t hwi-builder -f contrib/build.Dockerfile .

# Note the use of "--without-gui".
docker run --platform linux/arm64 -it --rm --name hwi-builder -v $PWD:/opt/hwi  --workdir /opt/hwi hwi-builder /bin/bash -c "contrib/build_bin.sh --without-gui && contrib/build_dist.sh --without-gui"

WDYT?

[achow101]

Can you update docs/development/release-process.rst with the instructions?

[kiminuo]

It seems like one can simplify it nowadays to:

Suggested change

	docker buildx build --no-cache --platform linux/arm64 -t hwi-builder-arm64 -f contrib/build.Dockerfile .
	docker build --no-cache --platform linux/arm64 -t hwi-builder-arm64 -f contrib/build.Dockerfile .

based on https://docs.docker.com/build/guide/multi-platform/. It should be available from API 1.38 (the latest is 1.43):

[kiminuo]

Can you update docs/development/release-process.rst with the instructions?

Updated. I added what I find to be safest but I can only test on Ubuntu 23.04. Maybe your system differs. So it would be great if you could try the instructions and pick what works for you.

[achow101]

ACK 3d3c02d