Skip to content
Secure and fast microVMs for serverless computing.
Rust Python Shell C
Branch: master
Clone or download

Latest commit

gc-plp and aghecenco tests: Fix pylint 2.5.2 errors
This commit fixes a few styling errors that pylint 2.5.2. is throwing.
- 'import-error' problems can be safely ignored because otherwise the
tests would not run successfully.
- 'too-few-public-methods' is thrown because the classes inherit an
upper class and pylint does not like a class which doesn't do anything
with its members even if it's inherited.

Signed-off-by: Gabriel Ionescu <gbi@amazon.com>
Latest commit b3869fa May 21, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.cargo build: Rust 1.39 update Nov 29, 2019
.github PR template: shorten & add rust-vmm checkbox Mar 11, 2020
docs doc: improvements to network-setup.md May 20, 2020
resources kernel_config: remane kernel config files Apr 2, 2020
src devices: vsock: reregister with evmgr on restore May 20, 2020
tests tests: Fix pylint 2.5.2 errors May 21, 2020
tools devtool: log UTC timestamp at start of test Apr 24, 2020
.gitignore Remove Cargo.lock from .gitignore Nov 27, 2018
.mailmap Release v0.21.0 Feb 18, 2020
CHANGELOG.md jailer: chmod 700 folders inside jail May 13, 2020
CHARTER.md docs: rename files to the GitHub standard names Dec 4, 2018
CODE_OF_CONDUCT.md Fixed a bunch of whitespace errors Nov 29, 2019
CONTRIBUTING.md docs: refresh documentation Dec 2, 2019
CREDITS.md Release v0.21.0 Feb 18, 2020
Cargo.lock Remove dependency of utils crate on dumbo May 20, 2020
Cargo.toml build: workspace cleanup Nov 29, 2019
FAQ.md docs: Fix link to kernel configuration. Apr 10, 2020
LICENSE license: add Apache 2.0 license Nov 20, 2018
MAINTAINERS.md maintainers.md: fix typo in email Mar 25, 2020
NOTICE Fixed a bunch of whitespace errors Nov 29, 2019
PGP-KEY.asc SECURITY-POLICY.md: added PGP key for encryption Apr 6, 2020
README.md readme: update the "Getting Started" section Mar 19, 2020
SECURITY-POLICY.md SECURITY-POLICY.md: added PGP key for encryption Apr 6, 2020
SPECIFICATION.md docs: Added MMDS user guide May 4, 2020
THIRD-PARTY license: add Apache 2.0 license Nov 20, 2018

README.md

Firecracker Logo Title

Our mission is to enable secure, multi-tenant, minimal-overhead execution of container and function workloads.

Read more about the Firecracker Charter here.

What is Firecracker?

Firecracker is an open source virtualization technology that is purpose-built for creating and managing secure, multi-tenant container and function-based services that provide serverless operational models. Firecracker runs workloads in lightweight virtual machines, called microVMs, which combine the security and isolation properties provided by hardware virtualization technology with the speed and flexibility of containers.

The main component of Firecracker is a virtual machine monitor (VMM) that uses 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, AMD (preview) and Arm (preview) CPUs. Firecracker has also been integrated in container runtimes, for example Kata Containers and Weaveworks Ignite.

Firecracker was developed at Amazon Web Services to accelerate the speed and efficiency of services like AWS Lambda and AWS Fargate. Firecracker is open sourced under Apache version 2.0.

To read more about Firecracker, check out firecracker-microvm.io.

Getting Started

To get started with Firecracker, download the latest release binaries or build it from source.

You can build Firecracker on any Unix/Linux system that has Docker running (we use a development container) and bash installed, as follows:

git clone https://github.com/firecracker-microvm/firecracker
cd firecracker
tools/devtool build
toolchain="$(uname -m)-unknown-linux-musl"

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.

The overall security of Firecracker microVMs, including the ability to meet the criteria for safe multi-tenant computing, depends on a well configured Linux host operating system. A configuration that we believe meets this bar is included in the production host setup document.

Contributing

Firecracker is already running production workloads within AWS, but it's still Day 1 on the journey guided by our mission. There's a lot more to build and we welcome all contributions.

To contribute to Firecracker, check out the development setup section in the getting started guide and then the Firecracker contribution guidelines.

Releases

New Firecracker versions are released via the GitHub repository releases page, typically every one or two months. A history of changes is recorded in our changelog.

Design

Firecracker's overall architecture is described in the design document.

Features & Capabilities

Firecracker consists of a single micro Virtual Machine Manager process that exposes an API endpoint to the host once started. The API is specified in OpenAPI format. Read more about it in the API docs.

The API endpoint can be used to:

  • Configure the microvm by:
    • Setting the number of vCPUs (the default is 1).
    • Setting the memory size (the default is 128 MiB).
    • Choosing a CPU template (currently, C3 and T2 are available).
  • Add one or more network interfaces to the microVM.
  • Add one or more read-write or read-only disks to the microVM, each represented by a file-backed block device.
  • Trigger a block device re-scan while the guest is running. This enables the guest OS to pick up size changes to the block device's backing file.
  • Change the backing file for a block device, before or after the guest boots.
  • Configure rate limiters for virtio devices which can limit the bandwidth, operations per second, or both.
  • Configure the logging and metric system.
  • [BETA] Configure the data tree of the guest-facing metadata service. The service is only available to the guest if this resource is configured.
  • Add a vsock socket to the microVM.
  • Start the microVM using a given kernel image, root file system, and boot arguments.
  • Stop the microVM.

Built-in Capabilities:

  • Demand fault paging and CPU oversubscription enabled by default.
  • Jailer process for starting Firecracker in production scenarios; applies a cgroup/namespace/seccomp rule isolation barrier and then drops privileges.

Performance

Firecracker's performance characteristics are listed as part of the specification documentation. All specifications are a part of our commitment to supporting container and function workloads in serverless operational models, and are therefore enforced via continuous integration testing.

Policy for Security Disclosures

The security of Firecracker is our top priority. If you suspect you have uncovered a vulnerability, contact us privately, as outlined in our security policy document; we will immediately prioritize your disclosure.

FAQ & Contact

Frequently asked questions are collected in our FAQ doc.

You can get in touch with the Firecracker community in the following ways:

When communicating within the Firecracker community, please mind our code of conduct.

You can’t perform that action at this time.