Skip to content

Commit 99a0267

Browse files
iulianbarbudianpopa
iulianbarbu
authored andcommitted
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 <[email protected]>
1 parent 1519297 commit 99a0267

File tree

2 files changed

+15
-11
lines changed

2 files changed

+15
-11
lines changed

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@ the Linux Kernel Virtual Machine (KVM) to create and run microVMs. Firecracker
1919
has a minimalist design. It excludes unnecessary devices and guest-facing
2020
functionality to reduce the memory footprint and attack surface area of each
2121
microVM. This improves security, decreases the startup time, and increases
22-
hardware utilization. Firecracker currently supports Intel CPUs, with planned
23-
AMD and Arm support. Firecracker will also be integrated with popular container
24-
runtimes.
25-
22+
hardware utilization. Firecracker currently supports Intel, AMD (beta) and Arm
23+
(beta) CPUs. Firecracker can also be integrated in container runtimes. Checkout
24+
[Kata Containers with Firecracker.](https://github.com/kata-containers/documentation/wiki/Initial-release-of-Kata-Containers-with-Firecracker-support)
25+
2626
Firecracker was developed at Amazon Web Services to accelerate the speed and
2727
efficiency of services like [AWS Lambda](https://aws.amazon.com/lambda/) and
2828
[AWS Fargate](https://aws.amazon.com/fargate/). Firecracker is open
@@ -43,10 +43,11 @@ development container) as follows:
4343
git clone https://github.com/firecracker-microvm/firecracker
4444
cd firecracker
4545
tools/devtool build
46+
toolchain="$(uname -m)-unkown-linux-musl"
4647
```
4748

48-
The Firecracker binary will be placed at `build/debug/firecracker`. For more
49-
information on building, testing, and running Firecracker, go to the
49+
The Firecracker binary will be placed at `build/cargo_target/${toolchain}/debug/firecracker`.
50+
For more information on building, testing, and running Firecracker, go to the
5051
[quickstart guide](docs/getting-started.md).
5152

5253
The overall security of Firecracker microVMs, including the ability to meet the

docs/getting-started.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -295,12 +295,15 @@ git checkout tags/v0.10.1
295295
Within the Firecracker repository root directory:
296296

297297
1. with the default musl target: ```tools/devtool build```
298-
1. using the gnu target: ```tools/devtool build -l gnu```
298+
2. using the gnu target: ```tools/devtool build -l gnu```
299299

300-
This will build and place the two Firecracker binaries at
301-
`build/debug/firecracker` and `build/debug/jailer`. The default build profile
302-
is `debug`. If you want to build the release binaries (optimized and stripped
303-
of debug info), use the `--release` option:
300+
This will build and place the two Firecracker binaries at:
301+
- `build/cargo_target/${toolchain}/debug/firecracker` and
302+
- `build/cargo_target/${toolchain}/debug/jailer`.
303+
304+
The default build profile is `debug`. If you want to build
305+
the release binaries (optimized and stripped of debug info),
306+
use the `--release` option:
304307

305308
```bash
306309
tools/devtool build --release

0 commit comments

Comments
 (0)