diff --git a/docs/devctr-image.md b/docs/devctr-image.md index 2532c6341485..76ae552188e6 100644 --- a/docs/devctr-image.md +++ b/docs/devctr-image.md @@ -35,7 +35,7 @@ registry. The Firecracker CI suite must also be updated to use the new image. ```bash docker login --username AWS --password \ - $(aws ecr-public get-login-password) public.ecr.aws + $(aws ecr-public get-login-password --region us-east-1) public.ecr.aws ``` 1. Navigate to the Firecracker directory. Verify that you have the latest diff --git a/docs/getting-started.md b/docs/getting-started.md index 5156594fa75e..5fb1e5e051e7 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -314,6 +314,17 @@ arguments is available via: tools/devtool --help ``` +### Alternative: Building Firecracker without devtool + +It is possible to build Firecracker without invoking `devtool` by instead +running `cargo build`. However, binaries generated like this should not +be used in production and are considered experimental. + +Note that the default target for Firecracker is `x86_64-unknown-linux-musl` +(set in `.cargo/config`). If you want to build an ARM binary, you need to +pass `--target aarch64-unknown-linux-musl` to `cargo build`, even if +compiling on an ARM machine. Otherwise it will try to build an `x86_64` binary. + ### Alternative: Building Firecracker using glibc The toolchain that Firecracker is tested against and that is recommended for @@ -331,9 +342,8 @@ arch=`uname -m` cargo build --target ${arch}-unknown-linux-gnu ``` -That being said, Firecracker binaries linked with glibc or built without -`devtool` are always considered experimental and should not be used in -production. +That being said, Firecracker binaries linked with glibc are always considered +experimental and should not be used in production. ## Running the Integration Test Suite