Skip to content
Secure and fast microVMs for serverless computing.
Branch: master
Clone or download
acatangiu and aghecenco vmm: add error conversion unit tests
Signed-off-by: Adrian Catangiu <acatan@amazon.com>
Latest commit 5452cbc Apr 17, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.cargo specify linker for arm platforms Feb 21, 2019
.github
api_server
arch aarch64: add vcpu configuration Apr 19, 2019
arch_gen lint: fix clippy warnings after rebase Mar 1, 2019
cpuid fix debug build warning Apr 17, 2019
devices transition from sys_util::Error to std::io::Error Mar 13, 2019
docs Add local macOS VM dev machine setup instructions Mar 25, 2019
dumbo
fc_util Improve test coverage Apr 2, 2019
jailer remove sys_util::Error usage from jailer Mar 13, 2019
kernel aarch64: add vcpu configuration Apr 19, 2019
logger metrics: remove `bad_syscalls` Mar 5, 2019
memory_model kvm: remove dependency on memory-model Mar 8, 2019
micro_http Improve test coverage Apr 2, 2019
mmds Let MMDS accept only String, Array and Object values on PUT and PATCH… Apr 2, 2019
net_gen lint: add clippy allow lint macros in generated modules Mar 1, 2019
net_util remove hard dependency on serde version 1.0.27 Mar 20, 2019
rate_limiter Improve test coverage Apr 2, 2019
resources kernel-config: Remove kernel modules from config Apr 5, 2019
seccomp rename setup_seccomp to SeccompFilter::apply Mar 19, 2019
src lint: fix clippy warnings after rebase Mar 1, 2019
sys_util
tests vmm: add error conversion unit tests Apr 19, 2019
tools devtool: new command(checkenv) to check for prerequisites. Apr 19, 2019
vhost_backend lint: fix clippy lint errors for all features Mar 1, 2019
vhost_gen lint: add clippy allow lint macros in generated modules Mar 1, 2019
virtio_gen lint: add clippy allow lint macros in generated modules Mar 1, 2019
vmm vmm: add error conversion unit tests Apr 19, 2019
.gitignore Remove Cargo.lock from .gitignore Nov 27, 2018
.mailmap update mailmap with more deduplicated names Jan 30, 2019
CHANGELOG.md
CHARTER.md docs: rename files to the GitHub standard names Dec 4, 2018
CODE_OF_CONDUCT.md docs: rename files to the GitHub standard names Dec 4, 2018
CONTRIBUTING.md docs: rename files to the GitHub standard names Dec 4, 2018
CREDITS.md release v0.15.0 Feb 22, 2019
Cargo.lock replace kvm with rust-vmm kvm-ioctls Apr 17, 2019
Cargo.toml remove json 'context' argument from firecracker Feb 26, 2019
FAQ.md docs: rootfs and kernel img guide Mar 13, 2019
LICENSE license: add Apache 2.0 license Nov 20, 2018
MAINTAINERS.md docs: add docs to clarify Firecracker's direction Nov 12, 2018
NOTICE license: add Apache 2.0 license Nov 20, 2018
README.md Clarify getting started section of README Jan 23, 2019
SECURITY-POLICY.md docs: Updated the FAQ and README documentation Nov 15, 2018
SPECIFICATION.md Correct Open API spec link in SPECIFICATION.md Nov 27, 2018
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 CPUs, with planned AMD and Arm support. Firecracker will also be integrated with popular container runtimes.

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 system that has Docker running (we use a development container) as follows:

git clone https://github.com/firecracker-microvm/firecracker
cd firecracker
tools/devtool build

The Firecracker binary will be placed at build/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.
  • [EXPERIMENTAL] Add one or more vsock sockets 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.