Skip to content

Commit 5b7c43d

Browse files
raduweissandreeaflorescu
authored andcommitted
docs: address writing feedback
Changes: - Added the logo and graphical title at the top of README.md. - Added a link to the GitHub releases in the README.md "Releases" section. - Added links to [AWS Lambda](https://aws.amazon.com/lambda/) and [AWS Fargate](https://aws.amazon.com/fargate/) where they were mentioned. - Harmonised the use of "built on" / "based on" / "uses" / "started from", "multitenant" vs "multi-tenant", and "microVM" vs "micro-VM" across all .md docs. - Fixed some typos. Signed-off-by: Radu Weiss <[email protected]>
1 parent 632dbab commit 5b7c43d

File tree

5 files changed

+34
-31
lines changed

5 files changed

+34
-31
lines changed

CHARTER.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Mission
44

5-
Enable secure, multi-tenant, minimal-overhead execution of container and
5+
Enable secure, multitenant, minimal-overhead execution of container and
66
serverless workloads.
77

88
## Tenets (unless you know better ones)

FAQ.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,25 +9,27 @@ sufficient isolation between their applications when all containers have to use
99
a shared operating system (OS) kernel. Containers offer fast startup times,
1010
while VMs offer hardware virtualization-based security boundaries that are more
1111
secure. Firecracker is a new virtualization technology that enables service
12-
owners to operate multi-tenant container-based services on bare metal machines
12+
owners to operate multitenant container-based services on bare metal machines
1313
by combining the speed, resource efficiency, and performance enabled by
1414
containers with the security and workload isolation properties of traditional
1515
VMs.
1616

1717
### Who developed Firecracker?
1818

19-
Firecracker was built at Amazon Web Services to enable AWS services such as AWS
20-
Fargate and AWS Lambda to improve resource utilization and customer experience.
21-
Firecracker is based on Chromium OSs' Virtual Machine Monitor (crosvm), an
22-
open-sourced VMM written in Rust. Today, crosvm and Firecracker have diverged
23-
to serve very different customer needs. We plan to contribute back the bug fixes
24-
and tests added to shared crates, and any Firecracker functionality that's
25-
appealing for crosvm.
19+
Firecracker was built at Amazon Web Services to enable AWS services such as
20+
[Lambda](https://aws.amazon.com/lambda/) and
21+
[Fargate](https://aws.amazon.com/fargate/) to improve resource utilization and
22+
customer experience. Firecracker started from Chromium OS's Virtual Machine
23+
Monitor (crosvm), an open-sourced VMM written in Rust. Today, crosvm and
24+
Firecracker have diverged to serve very different customer needs. We plan to
25+
contribute back the bug fixes and tests added to shared crates, and any
26+
Firecracker functionality that's appealing for crosvm.
2627

2728
### Who uses Firecracker today and how will they use Firecracker?
2829

29-
Today, AWS Lambda and AWS Fargate are built on Firecracker. In the
30-
future, we plan to enable users to launch micro-VM backed containers
30+
Today, [AWS Lambda](https://aws.amazon.com/lambda/) and
31+
[AWS Fargate](https://aws.amazon.com/fargate/) are built on Firecracker. In the
32+
future, we plan to enable users to launch microVM backed containers
3133
via familiar interfaces such as containerd.
3234

3335
### Is Firecracker compatible with the container ecosystem such as Kubernetes, Docker, Kata containers?

README.md

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Firecracker Read Me
1+
![Firecracker Logo Title](docs/fc-logo-title.png)
22

3-
Our mission is to enable secure, multi-tenant, minimal-overhead execution of
3+
Our mission is to enable secure, multitenant, minimal-overhead execution of
44
container and serverless workloads.
55

66
Read more about the Firecracker Charter [here](CHARTER.md).
@@ -14,33 +14,34 @@ machines, called microVMs, which combine the security and workload isolation
1414
properties of traditional VMs with the speed and resource efficiency of
1515
containers (you can create microVMs with any combination of vCPUs and memory).
1616

17-
Firecracker implements a virtual machine monitor (VMM) based on the Linux Kernel
18-
Virtual Machine (KVM) to create and manage microVMs (there is one Firecracker
19-
process per microVM). Firecracker has a minimalist design. It excludes
20-
unnecessary devices and guest functionality to reduce the memory footprint and
21-
attack surface area of each microVM. This improves security, decreases the
22-
startup time, and increases hardware utilization. Firecracker currently supports
23-
Intel CPUs, with planned AMD and ARM support. Firecracker will also be
24-
integrated with popular container runtimes.
17+
Firecracker implements a virtual machine monitor (VMM) that uses the Linux
18+
Kernel Virtual Machine (KVM) to create and manage microVMs (there is one
19+
Firecracker process per microVM). Firecracker has a minimalist design. It
20+
excludes unnecessary devices and guest functionality to reduce the memory
21+
footprint and attack surface area of each microVM. This improves security,
22+
decreases the startup time, and increases hardware utilization. Firecracker
23+
currently supports Intel CPUs, with planned AMD and ARM support. Firecracker
24+
will also be integrated with popular container runtimes.
2525

2626
Firecracker was developed at Amazon Web Services to accelerate the speed and
27-
efficiency of services like AWS Fargate and AWS Lambda. Firecracker is open
27+
efficiency of services like [AWS Lambda](https://aws.amazon.com/lambda/) and
28+
[AWS Fargate](https://aws.amazon.com/fargate/). Firecracker is open
2829
sourced under [Apache version 2.0](LICENSE).
2930

3031
To read more about the benefits of Firecracker, check out
31-
[firecracker-microvm.io](firecracker-microvm.io).
32+
[firecracker-microvm.io](https://firecracker-microvm.github.io).
3233

3334
## Getting Started
3435

3536
To try out Firecracker, go to the [quickstart guide](docs/getting-started.md).
3637

37-
To enable service owners to run microVM-based containers in multi-tenant
38+
To enable service owners to run microVM-based containers in multitenant
3839
production fleets, we are working to integrate Firecracker in the container
3940
ecosystem; once this integration is complete, customers will be able to run
4041
pods, tasks, and containers within Firecracker microVMs.
4142

4243
Service owners will also need to ensure that their host OS is configured to a
43-
security bar that enables safe multi-tenant computing. An configuration that we
44+
security bar that enables safe multitenant computing. A configuration that we
4445
consider meets this bar is included in
4546
[the production host setup document](docs/prod-host-setup.md).
4647

@@ -56,7 +57,8 @@ To contribute to Firecracker, check out the development setup section in the
5657

5758
## Releases
5859

59-
New Firecracker versions are released via GitHub's release infrastructure,
60+
New Firecracker versions are released via the GitHub repository
61+
[releases](https://github.com/firecracker-microvm/firecracker/releases) page,
6062
typically every one or two months. A history of changes is recorded in our
6163
[changelog](CHANGELOG.md).
6264

@@ -92,7 +94,7 @@ The **API endpoint** can be used to:
9294
arguments.
9395
- Stop the microVM.
9496

95-
**Build-in Capabilities**:
97+
**Built-in Capabilities**:
9698

9799
- Demand fault paging and CPU oversubscription enabled by default.
98100
- Jailer process for starting Firecracker in production scenarios; applies a

docs/design.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Firecracker is a new virtualization technology that enables customers to deploy
88
lightweight *micro* Virtual Machines or microVMs. Firecracker microVMs combine
99
the security and workload isolation properties of traditional VMs with the
1010
speed, agility and resource efficiency enabled by containers. They provide a
11-
secure, trusted environment for multi-tenant services, while maintaining
11+
secure, trusted environment for multitenant services, while maintaining
1212
minimal overhead.
1313

1414
The scope of this document is to describe the features and architecture of the

docs/getting-started.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,7 @@
1818

1919
- **KVM**
2020

21-
Firecracker is built on top of [KVM](https://www.linux-kvm.org). Please make
22-
sure that:
21+
Firecracker uses [KVM](https://www.linux-kvm.org). Please make sure that:
2322
1. you have KVM enabled in your Linux kernel, and
2423
2. you have read/write access to `/dev/kvm`.
2524
If you need help setting up access to `/dev/kvm`, you should check out
@@ -290,4 +289,4 @@ test container and checking for net connectivity:
290289
```bash
291290
docker pull alpine
292291
docker run --rm -it alpine ping -c 3 amazon.com
293-
```
292+
```

0 commit comments

Comments
 (0)