|
| 1 | +.POSIX: |
| 2 | +.DEFAULT_GOAL: help |
| 3 | + |
| 4 | +REGISTRY ?= docker.io/zulip/docker-zulip |
| 5 | +REGISTRY_TAG ?= undefined |
| 6 | +PUSH_LATEST_TAG ?= 0 |
| 7 | +ifeq ($(PUSH_LATEST_TAG), 1) |
| 8 | + PUSH_LATEST_TAG_ARG = -t $(REGISTRY):latest |
| 9 | +else |
| 10 | + PUSH_LATEST_TAG_ARG = |
| 11 | +endif |
| 12 | +# Default to creating our own buildx context, as "default", using the native |
| 13 | +# "docker" driver, can result in errors like the following when using Linux |
| 14 | +# distros' Docker and not Docker Desktop: |
| 15 | +# |
| 16 | +# ERROR: multiple platforms feature is currently not supported for docker |
| 17 | +# driver. Please switch to a different driver (eg. "docker buildx create |
| 18 | +# --use") |
| 19 | +BUILDX_BUILDER ?= zulip |
| 20 | +BUILDX_PLATFORMS ?= linux/amd64,linux/arm64 |
| 21 | + |
| 22 | +.PHONY: help |
| 23 | +help: |
| 24 | + @echo "This Makefile wraps Docker and Docker BuildX to build multiarch Zulip images." \ |
| 25 | + "Make sure a recent Docker and BuildX are installed on your system - Docker Desktop users (on any OS) should be good to go, those using Linux distribution's builds of Docker will need to find the correct packages." |
| 26 | + @echo |
| 27 | + @echo "To use, set REGISTRY, REGISTRY_TAG, perhaps to 'local', and optionally override BUILDX_PLATFORMS." \ |
| 28 | + "Additionally, PUSH_LATEST_TAG can be set to 1 to additonally tag :local when pushing to the registry." \ |
| 29 | + "Then, run the build-multiarch-containers target. For example:" |
| 30 | + @echo |
| 31 | + @echo " make build-multiarch-containers REGISTRY=docker.example.com/myorg/zulip REGISTRY_TAG=local PUSH_LATEST_TAG=1" |
| 32 | + @echo |
| 33 | + @echo "By default, REGISTRY:REGISTRY_TAG will be built for linux/amd64 and linux/arm64. Adding other platforms to this list is unsupported and will almost certainly not work, but the list can be shrunk." |
| 34 | + @echo "REGISTRY must be set to something the builder has push access to, because BuildX images and manifests are not loaded into the host's Docker registry." |
| 35 | + @echo |
| 36 | + @echo "One can expect this step to take many multiples of the time it takes to build the Zulip image for just the native architecture." \ |
| 37 | + "If it takes 10 minutes to build the amd64 image by itself, expect cross-compiling the arm64 image to take 30-60 minutes on most currently-common hardware." \ |
| 38 | + "Currently, distributing the image builds to multiple machines (perhaps to allow the arm64 image to build on a native arm64 host for efficiency) is unsupported." |
| 39 | + @echo |
| 40 | + @echo "Assuming all goes well, REGISTRY:REGISTRY_TAG will point to a multiarch manifest referring to an image for each of BUILDX_PLATFORMS, which can then be rolled out to your infrastructure, used in Docker Compose, etc." |
| 41 | + @echo |
| 42 | + @echo "Please report bugs with this Makefile or anything it runs, or with running Zulip on arm64 in general, at https://github.com/zulip/docker-zulip and/or at https://chat.zulip.org" |
| 43 | + |
| 44 | +.PHONY: reset-qemu-static |
| 45 | +reset-qemu-static: |
| 46 | +# --credential yes is required to run sudo within qemu, without it the |
| 47 | +# effective UID after a call to sudo will not be 0 and sudo in cross-built |
| 48 | +# containers (eg. the arm64 build if running on an amd64 host) will fail |
| 49 | +# |
| 50 | +# see also: https://github.com/crazy-max/ghaction-docker-buildx/issues/213 |
| 51 | +# |
| 52 | +# We're allowing failures here (- prefix) for two main reasons: |
| 53 | +# |
| 54 | +# - BUILDX_PLATFORMS can be overridden to a single, native platform (meaning |
| 55 | +# this QEMU reset won't be necessary anyway) |
| 56 | +# - On ZFS<2.2 root filesystems, this incantation can fail due to Docker-side |
| 57 | +# dataset teardown issues as documented in |
| 58 | +# https://github.com/moby/moby/issues/40132. The QEMU reset may have |
| 59 | +# succeeded despite the Docker daemon errors, so we'll try to power through. |
| 60 | + -docker run --rm --privileged multiarch/qemu-user-static --reset -p yes --credential yes |
| 61 | + |
| 62 | +.PHONY: build-multiarch-containers |
| 63 | +ifeq ($(REGISTRY_TAG), undefined) |
| 64 | +build-multiarch-containers: |
| 65 | + $(error REGISTRY_TAG must be provided in environment or make incantation) |
| 66 | +else |
| 67 | +build-multiarch-containers: reset-qemu-static |
| 68 | + (docker buildx ls | grep "$(BUILDX_BUILDER)" 2>&1 >/dev/null) || docker buildx create --name $(BUILDX_BUILDER) --platform $(BUILDX_PLATFORMS) --bootstrap --use |
| 69 | + docker buildx build --platform $(BUILDX_PLATFORMS) -t $(REGISTRY):$(REGISTRY_TAG) $(PUSH_LATEST_TAG_ARG) --push . |
| 70 | +endif |
0 commit comments