Merge pull request #8 from aws-samples/dev

add instructions for ARM support

Author: bnusunny

.cargo/config

@@ -1,2 +1,5 @@
 [target.x86_64-unknown-linux-musl]
 linker = "x86_64-unknown-linux-musl-gcc"
+
+[target.aarch64-unknown-linux-musl]
+linker = "aarch64-unknown-linux-musl-gcc"

.github/workflows/pipeline.yml

@@ -31,5 +31,8 @@ jobs:
       - name: Linting
         run: cargo fmt -- --check && cargo clippy -- -Dwarnings
 
-      - name: Build
-        run: DOCKER_BUILDKIT=1 docker build -f Dockerfile.x86 -t aws-lambda-adapter:latest .
+      - name: Build x86_64
+        run: docker build -f Dockerfile --build-arg ARCH=x86_64 -t aws-lambda-adapter:latest-x86_64 .
+
+      - name: Build arm64
+        run: docker build -f Dockerfile --build-arg ARCH=aarch64 -t aws-lambda-adapter:latest-aarch64 .

Dockerfile

@@ -0,0 +1,16 @@
+FROM public.ecr.aws/amazonlinux/amazonlinux:2 as build-stage
+ARG ARCH=x86_64
+RUN rpm --rebuilddb && yum install -y yum-plugin-ovl openssl-devel
+RUN yum groupinstall -y "Development tools"
+RUN curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
+RUN source $HOME/.cargo/env && rustup target add ${ARCH}-unknown-linux-musl
+RUN curl -k -o /${ARCH}-linux-musl-cross.tgz https://musl.cc/${ARCH}-linux-musl-cross.tgz \
+        && tar zxf /${ARCH}-linux-musl-cross.tgz \
+        && ln -s /${ARCH}-linux-musl-cross/bin/${ARCH}-linux-musl-gcc /usr/local/bin/${ARCH}-unknown-linux-musl-gcc
+WORKDIR /app
+ADD . /app
+RUN source $HOME/.cargo/env && CC=${ARCH}-unknown-linux-musl-gcc cargo build --release --target=${ARCH}-unknown-linux-musl --features vendored
+
+FROM scratch AS package-stage
+ARG ARCH=x86_64
+COPY --from=build-stage /app/target/${ARCH}-unknown-linux-musl/release/bootstrap /opt/bootstrap

Dockerfile.mac

@@ -1,2 +1,3 @@
 FROM scratch
-COPY target/x86_64-unknown-linux-musl/release/bootstrap /opt/bootstrap
+ARG ARCH=x86_64
+COPY target/${ARCH}-unknown-linux-musl/release/bootstrap /opt/bootstrap

Dockerfile.x86

@@ -1,11 +1,18 @@
 clean:
 	rm -rf target
 
-build:
+build-x86:
 	aws ecr-public get-login-password --region us-east-1 | docker login --username AWS --password-stdin public.ecr.aws
-	DOCKER_BUILDKIT=1 docker build -f Dockerfile.x86 -t aws-lambda-adapter:latest .
+	docker build --build-arg ARCH=x86_64 -t aws-lambda-adapter:latest-x86_64 .
+
+build-arm:
+	aws ecr-public get-login-password --region us-east-1 | docker login --username AWS --password-stdin public.ecr.aws
+	docker build --build-arg ARCH=aarch64 -t aws-lambda-adapter:latest-aarch64 .
+
+build: build-x86 build-arm
+	docker tag aws-lambda-adapter:latest-x86_64 aws-lambda-adapter:latest
 
 build-mac:
 	CC=x86_64-unknown-linux-musl-gcc cargo build --release --target=x86_64-unknown-linux-musl --features vendored
 	aws ecr-public get-login-password --region us-east-1 | docker login --username AWS --password-stdin public.ecr.aws
-	DOCKER_BUILDKIT=1 docker build -f Dockerfile.mac -t aws-lambda-adapter:latest .
+	docker build -f Dockerfile.mac --build-arg ARCH=x86_64 -t aws-lambda-adapter:latest .

Makefile

@@ -32,13 +32,16 @@ $ cd aws-lambda-adapter
 
 ### Compiling with Docker
 On x86_64 Windows, Linux and macOS, you can run one command to compile Lambda Adapter with docker.
-The Dockerfile is [here](Dockerfile.x86). [AWS CLI](https://aws.amazon.com/cli/) should have been installed and configured.
+The Dockerfile is [here](Dockerfile.x86). [AWS CLI v2](https://docs.aws.amazon.com/cli/latest/userguide/install-cliv2.html) should have been installed and configured.
 
 ```shell
 $ make build
 ```
 
-Once the build completes, it creates a docker image called "aws-lambda-adapter:latest". AWS Lambda Adapter binary is packaged as '/opt/bootstrap' inside the docker image.
+Once the build completes, it creates two docker images: 
+- "aws-lambda-adapter:latest-x86_64" for x86_64.
+- "aws-lambda-adapter:latest-aarch64" for arm64.
+AWS Lambda Adapter binary is packaged as '/opt/bootstrap' inside each docker image. "aws-lambda-adapter:latest" is tagged to the same image as "aws-lambda-adapter:latest-x86_64". 
 
 ### Compiling on macOS
 
@@ -54,6 +57,7 @@ And we have to install macOS cross-compiler toolchains. `messense/homebrew-macos
 ```shell
 $ brew tap messense/macos-cross-toolchains
 $ brew install x86_64-unknown-linux-musl
+$ brew install aarch64-unknown-linux-musl
 ```
 
 And we need to inform Cargo that our project uses the newly-installed linker when building for the `x86_64-unknown-linux-musl` platform.
@@ -62,22 +66,29 @@ Create a new directory called `.cargo` in your project folder and a new file cal
 ```shell
 $ mkdir .cargo
 $ echo '[target.x86_64-unknown-linux-musl]
-linker = "x86_64-unknown-linux-musl-gcc"' > .cargo/config
+linker = "x86_64-unknown-linux-musl-gcc"
+
+[target.aarch64-unknown-linux-musl] 
+linker = "aarch64-unknown-linux-musl-gcc"'> .cargo/config
 ```
 
 Now we can cross compile AWS Lambda Adapter.
 
 ```shell
 $ CC=x86_64-unknown-linux-musl-gcc cargo build --release --target=x86_64-unknown-linux-musl --features vendored
+$ CC=aarch64-unknown-linux-musl-gcc cargo build --release --target=aarch64-unknown-linux-musl --features vendored
 ```
 
-Lambda Adapter binary will be placed at `target/x86_64-unknown-linux-musl/release/bootstrap`.
+Lambda Adapter binary for x86_64 will be placed at `target/x86_64-unknown-linux-musl/release/bootstrap`. 
+Lambda Adapter binary for arm64 will be placed at `target/aarch64-unknown-linux-musl/release/bootstrap`. 
 
 Finally, run the following command to package lambda adapter into a docker image named "aws-lambda-adapter:latest".
 
 ```shell
 $ aws ecr-public get-login-password --region us-east-1 | docker login --username AWS --password-stdin public.ecr.aws
-$ DOCKER_BUILDKIT=1 docker build -f Dockerfile.mac -t aws-lambda-adapter:latest .
+$ docker build -f Dockerfile.mac --build-arg ARCH=x86_64 -t aws-lambda-adapter:latest-x86_64 .
+$ docker build -f Dockerfile.mac --build-arg ARCH=aarch64 -t aws-lambda-adapter:latest-aarch64 .
+$ docker tag aws-lambda-adapter:latest-x86_64 aws-lambda-adapter:latest
 ```
 
 ## How to use it?
@@ -106,6 +117,7 @@ COPY --from=aws-lambda-adapter:latest /opt/bootstrap /opt/bootstrap
 ENTRYPOINT ["/opt/bootstrap"]
 ```
 
+To support Graviton2, change `aws-lambda-adapter:latest` to `aws-lambda-adapter:latest-arm64`. 
 
 The readiness check port/path and traffic port can be configured using environment variables.