From 99a026756c406d1c7f60c5c9f6685adcab1229e7 Mon Sep 17 00:00:00 2001 From: iulianbarbu Date: Tue, 17 Sep 2019 12:10:23 +0300 Subject: [PATCH] Updated Firecracker doc. README.md documentation was falling behind current Firecracker implementation. Now, Firecracker supports AMD and ARM CPUs, and the after the build, created binaries will reside to a different directory than the one specified in the current documentation. Affected: README.md, docs/getting-started.md Signed-off-by: iulianbarbu --- README.md | 13 +++++++------ docs/getting-started.md | 13 ++++++++----- 2 files changed, 15 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 412fe45d5c4..84e03df806f 100644 --- a/README.md +++ b/README.md @@ -19,10 +19,10 @@ the Linux Kernel Virtual Machine (KVM) to create and run microVMs. Firecracker has a minimalist design. It excludes unnecessary devices and guest-facing functionality to reduce the memory footprint and attack surface area of each microVM. This improves security, decreases the startup time, and increases -hardware utilization. Firecracker currently supports Intel CPUs, with planned -AMD and Arm support. Firecracker will also be integrated with popular container -runtimes. - +hardware utilization. Firecracker currently supports Intel, AMD (beta) and Arm +(beta) CPUs. Firecracker can also be integrated in container runtimes. Checkout +[Kata Containers with Firecracker.](https://github.com/kata-containers/documentation/wiki/Initial-release-of-Kata-Containers-with-Firecracker-support) + Firecracker was developed at Amazon Web Services to accelerate the speed and efficiency of services like [AWS Lambda](https://aws.amazon.com/lambda/) and [AWS Fargate](https://aws.amazon.com/fargate/). Firecracker is open @@ -43,10 +43,11 @@ development container) as follows: git clone https://github.com/firecracker-microvm/firecracker cd firecracker tools/devtool build +toolchain="$(uname -m)-unkown-linux-musl" ``` -The Firecracker binary will be placed at `build/debug/firecracker`. For more -information on building, testing, and running Firecracker, go to the +The Firecracker binary will be placed at `build/cargo_target/${toolchain}/debug/firecracker`. +For more information on building, testing, and running Firecracker, go to the [quickstart guide](docs/getting-started.md). The overall security of Firecracker microVMs, including the ability to meet the diff --git a/docs/getting-started.md b/docs/getting-started.md index cf5dc33f7bc..273406db20b 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -295,12 +295,15 @@ git checkout tags/v0.10.1 Within the Firecracker repository root directory: 1. with the default musl target: ```tools/devtool build``` -1. using the gnu target: ```tools/devtool build -l gnu``` +2. using the gnu target: ```tools/devtool build -l gnu``` -This will build and place the two Firecracker binaries at -`build/debug/firecracker` and `build/debug/jailer`. The default build profile -is `debug`. If you want to build the release binaries (optimized and stripped -of debug info), use the `--release` option: +This will build and place the two Firecracker binaries at: +- `build/cargo_target/${toolchain}/debug/firecracker` and +- `build/cargo_target/${toolchain}/debug/jailer`. + +The default build profile is `debug`. If you want to build +the release binaries (optimized and stripped of debug info), +use the `--release` option: ```bash tools/devtool build --release