Skip to content

Commit d5a51c0

Browse files
committed
Update getting started
Signed-off-by: Maksym Pavlenko <[email protected]>
1 parent 338f1e5 commit d5a51c0

File tree

1 file changed

+12
-36
lines changed

1 file changed

+12
-36
lines changed

docs/getting-started.md

Lines changed: 12 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -78,8 +78,6 @@ GO111MODULE=on make all
7878
Once you have built the runtime, be sure to place the following binaries on your
7979
`$PATH`:
8080
* `runtime/containerd-shim-aws-firecracker`
81-
* `snapshotter/cmd/devmapper/devmapper_snapshotter`
82-
* `snapshotter/cmd/naive/naive_snapshotter`
8381
* `firecracker-control/cmd/containerd/firecracker-containerd`
8482
* `firecracker-control/cmd/containerd/firecracker-ctr`
8583

@@ -135,10 +133,11 @@ root = "/var/lib/firecracker-containerd/containerd"
135133
state = "/run/firecracker-containerd"
136134
[grpc]
137135
address = "/run/firecracker-containerd/containerd.sock"
138-
[proxy_plugins]
139-
[proxy_plugins.firecracker-devmapper]
140-
type = "snapshot"
141-
address = "/var/run/firecracker-containerd/devmapper-snapshotter.sock"
136+
[plugins]
137+
[plugins.devmapper]
138+
pool_name = "fc-dev-thinpool"
139+
base_image_size = "10GB"
140+
root_path = "/var/lib/firecracker-containerd/snapshotter/devmapper"
142141

143142
[debug]
144143
level = "debug"
@@ -153,7 +152,7 @@ binaries are in sync with one another. While other builds of `ctr` may work with
153152
### Prepare and configure snapshotter
154153

155154
The devmapper snapshotter requires a thinpool to exist.
156-
Below is a script to create a thinpool as well as an example config file.
155+
Below is a script to create a thinpool device.
157156

158157
`Note: The configuration with loopback devices is slow and not intended for use in production.`
159158

@@ -205,21 +204,6 @@ fi
205204
```
206205
</details>
207206

208-
<details>
209-
<summary>Snappshotter config file example.</summary>
210-
211-
```json
212-
{
213-
"base_image_size": "10GB",
214-
"root_path": "/var/lib/firecracker-containerd/snapshotter/devmapper",
215-
"pool_name": "fc-dev-thinpool"
216-
}
217-
```
218-
219-
</details>
220-
221-
A reasonable location for this file is at `/etc/firecracker-dm-snapshotter/config.json`.
222-
223207
### Configure containerd runtime plugin
224208

225209
The runtime expects a JSON-formatted configuration file to be located either in
@@ -277,17 +261,7 @@ configuration file has the following fields:
277261

278262
## Usage
279263

280-
Start the containerd snapshotter
281-
282-
```bash
283-
$ ./devmapper_snapshotter \
284-
-address /var/run/firecracker-containerd/devmapper-snapshotter.sock \
285-
-path /tmp/fc-snapshot \
286-
-config /etc/firecracker-dm-snapshotter/config.json
287-
```
288-
`note: The path for -config needs to match the location used when configuring the devmapper snapshotter.`
289-
290-
In another terminal, start containerd
264+
Start containerd
291265

292266
```bash
293267
$ sudo PATH=$PATH /usr/local/bin/firecracker-containerd \
@@ -298,15 +272,17 @@ Pull an image
298272

299273
```bash
300274
$ sudo firecracker-ctr --address /run/firecracker-containerd/containerd.sock images \
301-
pull --snapshotter firecracker-devmapper\
275+
pull --snapshotter devmapper \
302276
docker.io/library/busybox:latest
303277
```
304278

305279
And start a container!
306280

307281
```bash
308282
$ sudo firecracker-ctr --address /run/firecracker-containerd/containerd.sock \
309-
run --snapshotter firecracker-devmapper --runtime aws.firecracker \
283+
run \
284+
--snapshotter devmapper \
285+
--runtime aws.firecracker \
310286
--rm --tty --net-host \
311287
docker.io/library/busybox:latest busybox-test
312288
```
@@ -321,7 +297,7 @@ $ sudo firecracker-ctr --address /run/firecracker-containerd/containerd.sock \
321297
$ sudo firecracker-ctr --address /run/firecracker-containerd/containerd.sock \
322298
namespaces label fc \
323299
containerd.io/defaults/runtime=aws.firecracker \
324-
containerd.io/defaults/snapshotter=firecracker-devmapper
300+
containerd.io/defaults/snapshotter=devmapper
325301

326302
$ sudo firecracker-ctr --address /run/firecracker-containerd/containerd.sock \
327303
-n fc \

0 commit comments

Comments
 (0)