Skip to content

Commit 0115996

Browse files
authored
Merge pull request firecracker-microvm#481 from kzys/doc-no-snapshotters
Remove snapshotters from architecture.md
2 parents 6d5ee65 + 799eb52 commit 0115996

File tree

1 file changed

+2
-21
lines changed

1 file changed

+2
-21
lines changed

docs/architecture.md

Lines changed: 2 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,6 @@ implementing its interfaces and extending its APIs.
88

99
firecracker-containerd implements the following containerd interfaces:
1010

11-
* [snapshotter](https://github.com/containerd/containerd/blob/v1.2.6/snapshots/snapshotter.go#L116-L323):
12-
Snapshotters provide the implementation of layer storage and union filesystems
13-
for containerd containers
1411
* [V2 runtime](https://github.com/containerd/containerd/blob/v1.2.6/runtime/v2/task/shim.proto):
1512
Runtimes provide the implementation for configuring and running containerized
1613
processes. The V2 runtime is a containerd-specific interface and is not
@@ -26,22 +23,6 @@ APIs.
2623

2724
There are currently several components in this repository:
2825

29-
* Two [snapshotter](../snapshotter)s
30-
that create files used as block-devices for pass-through into the
31-
microVM. These snapshotters are used for providing the container image
32-
to the microVM. Both snapshotters run as out-of-process gRPC proxy plugins.
33-
The [naive](../snapshotter/cmd/naive/README.md) snapshotter is a simple
34-
proof-of-concept using flat files and copy-ahead; it is useful for debugging
35-
and validating, and requires no setup. The
36-
[devmapper](../snapshotter/cmd/devmapper/README.md) snapshotter leverages the
37-
[Linux device mapper](https://en.wikipedia.org/wiki/Device_mapper) framework
38-
and [thin
39-
provisioning](https://www.kernel.org/doc/Documentation/device-mapper/thin-provisioning.txt)
40-
to deduplicate storage between layers and enable copy-on-write functionality.
41-
The devmapper snapshotter has been [contributed to
42-
containerd](https://github.com/containerd/containerd/pull/3022), and we expect
43-
to remove the devmapper snapshotter source code from this repository in the
44-
future.
4526
* A [control plugin](../firecracker-control) managing the lifecycle of the
4627
runtime and implementing our [control API](../proto/firecracker.proto) by
4728
proxying commands to the runtime. The control plugin is compiled in to the
@@ -59,7 +40,7 @@ There are currently several components in this repository:
5940
container processes. The agent invokes [runC](https://runc.io) via
6041
containerd's `containerd-shim-runc-v1` to create standard Linux containers
6142
inside the microVM.
62-
43+
6344
A high-level diagram of the various components and their interactions can be
6445
seen below:
6546

@@ -73,4 +54,4 @@ be seen below:
7354
* Overview of possible design approaches can be found in the [design approaches
7455
doc](design-approaches.md).
7556
* More details on the architecture of the shims and design decisions behind
76-
them can be found in the [shim design doc](shim-design.md).
57+
them can be found in the [shim design doc](shim-design.md).

0 commit comments

Comments
 (0)