Skip to content

Commit 6cfd39a

Browse files
committed
fix(docs): Replace old image names with new ones
Replace the image reference in some exmaple unikernels in the docs with the updated image reference that also reflects the need to mount container's rootfs as the VM's rootfs. This is implied by the keyword "raw" in the end of the image reference. Also these images make use of the new mountRootfs annotation, which replaced the obsolete useDMBlock one. Signed-off-by: Charalampos Mainas <charalampos.mainas@gmail.com>
1 parent 979be69 commit 6cfd39a

File tree

5 files changed

+19
-19
lines changed

5 files changed

+19
-19
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ $ sudo apt install -y qemu-kvm
8181
Now we are ready to run nginx as a Unikraft unikernel using Docker and `urunc`:
8282

8383
```bash
84-
$ docker run --rm -d --runtime io.containerd.urunc.v2 harbor.nbfc.io/nubificus/urunc/nginx-qemu-unikraft:latest unikernel
84+
$ docker run --rm -d --runtime io.containerd.urunc.v2 harbor.nbfc.io/nubificus/urunc/nginx-qemu-unikraft:latest
8585
67bec5ab9a748e35faf7c2079002177b9bdc806220e59b6b413836db1d6e4018
8686
```
8787

docs/hypervisor-support.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ Supported unikernel frameworks with `urunc`:
6868
An example unikernel:
6969

7070
```bash
71-
sudo nerdctl run --rm -ti --runtime io.containerd.urunc.v2 harbor.nbfc.io/nubificus/urunc/nginx-qemu-unikraft-initrd:latest unikernel
71+
sudo nerdctl run --rm -ti --runtime io.containerd.urunc.v2 harbor.nbfc.io/nubificus/urunc/nginx-qemu-unikraft-initrd:latest
7272
```
7373

7474
### AWS Firecracker
@@ -136,7 +136,7 @@ Supported unikernel frameworks with `urunc`:
136136
An example unikernel:
137137

138138
```bash
139-
sudo nerdctl run --rm -ti --runtime io.containerd.urunc.v2 harbor.nbfc.io/nubificus/urunc/nginx-firecracker-unikraft-initrd:latest unikernel
139+
sudo nerdctl run --rm -ti --runtime io.containerd.urunc.v2 harbor.nbfc.io/nubificus/urunc/nginx-firecracker-unikraft-initrd:latest
140140
```
141141

142142
### Solo5-hvt
@@ -202,7 +202,7 @@ Supported unikernel frameworks with `urunc`:
202202
An example unikernel with a block image inside the conntainer's rootfs:
203203

204204
```bash
205-
sudo nerdctl run --rm -ti --runtime io.containerd.urunc.v2 harbor.nbfc.io/nubificus/urunc/redis-hvt-rumprun-block:latest unikernel
205+
sudo nerdctl run --rm -ti --runtime io.containerd.urunc.v2 harbor.nbfc.io/nubificus/urunc/redis-hvt-rumprun-block:latest
206206
```
207207

208208
## Software-based isolation monitors
@@ -273,5 +273,5 @@ Supported unikernel frameworks with `urunc`:
273273
An example unikernel which utilizes devmapper for block storage:
274274

275275
```bash
276-
sudo nerdctl run --rm -ti --snapshotter devmapper --runtime io.containerd.urunc.v2 harbor.nbfc.io/nubificus/urunc/redis-spt-rumprun:latest unikernel
276+
sudo nerdctl run --rm -ti --snapshotter devmapper --runtime io.containerd.urunc.v2 harbor.nbfc.io/nubificus/urunc/redis-spt-rumprun-raw:latest
277277
```

docs/installation.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -332,20 +332,20 @@ everything was installed correctly.
332332
#### Run a Redis Rumprun unikernel over Solo5-hvt
333333

334334
```bash
335-
sudo nerdctl run --rm -ti --runtime io.containerd.urunc.v2 harbor.nbfc.io/nubificus/urunc/redis-hvt-rumprun-block:latest unikernel
335+
sudo nerdctl run --rm -ti --runtime io.containerd.urunc.v2 harbor.nbfc.io/nubificus/urunc/redis-hvt-rumprun-block:latest
336336
```
337337
#### Run a Redis rumprun unikernel over Solo5-spt with devmapper
338338

339339
```bash
340-
sudo nerdctl run --rm -ti --snapshotter devmapper --runtime io.containerd.urunc.v2 harbor.nbfc.io/nubificus/urunc/redis-spt-rumprun:latest unikernel
340+
sudo nerdctl run --rm -ti --snapshotter devmapper --runtime io.containerd.urunc.v2 harbor.nbfc.io/nubificus/urunc/redis-spt-rumprun-raw:latest
341341
```
342342
#### Run a Nginx Unikraft unikernel over Qemu
343343

344344
```bash
345-
sudo nerdctl run --rm -ti --runtime io.containerd.urunc.v2 harbor.nbfc.io/nubificus/urunc/nginx-qemu-unikraft-initrd:latest unikernel
345+
sudo nerdctl run --rm -ti --runtime io.containerd.urunc.v2 harbor.nbfc.io/nubificus/urunc/nginx-qemu-unikraft-initrd:latest
346346
```
347347
#### Run a Nginx Unikraft unikernel over Firecracker
348348

349349
```bash
350-
sudo nerdctl run --rm -ti --runtime io.containerd.urunc.v2 harbor.nbfc.io/nubificus/urunc/nginx-firecracker-unikraft-initrd:latest unikernel
350+
sudo nerdctl run --rm -ti --runtime io.containerd.urunc.v2 harbor.nbfc.io/nubificus/urunc/nginx-firecracker-unikraft-initrd:latest
351351
```

docs/quickstart.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ sudo apt install -y qemu-system
6060
Now we are ready to run Nginx as a Unikraft unikernel using [docker](https://docs.docker.com/engine/install/ubuntu/) and `urunc`:
6161

6262
```console
63-
$ docker run --rm -d --runtime io.containerd.urunc.v2 harbor.nbfc.io/nubificus/urunc/nginx-qemu-unikraft:latest unikernel
63+
$ docker run --rm -d --runtime io.containerd.urunc.v2 harbor.nbfc.io/nubificus/urunc/nginx-qemu-unikraft:latest
6464
67bec5ab9a748e35faf7c2079002177b9bdc806220e59b6b413836db1d6e4018
6565
```
6666

@@ -251,15 +251,15 @@ sudo cp tenders/hvt/solo5-hvt /usr/local/bin
251251
Now, let's run a Redis unikernel on top of Rumprun and solo5-hvt:
252252

253253
```bash
254-
sudo nerdctl run -d --snapshotter devmapper --runtime io.containerd.urunc.v2 harbor.nbfc.io/nubificus/urunc/redis-hvt-rumprun:latest unikernel
254+
sudo nerdctl run -d --snapshotter devmapper --runtime io.containerd.urunc.v2 harbor.nbfc.io/nubificus/urunc/redis-hvt-rumprun-raw:latest
255255
```
256256

257257
We can inspect the running container to check it's IP address:
258258

259259
```console
260260
$ sudo nerdctl ps
261261
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
262-
8a415b278a9e harbor.nbfc.io/nubificus/urunc/redis-hvt-rumprun:latest "unikernel" 18 seconds ago Up redis-hvt-rumprun-8a415
262+
8a415b278a9e harbor.nbfc.io/nubificus/urunc/redis-hvt-rumprun-raw:latest "redis-server /data/…" 18 seconds ago Up redis-hvt-rumprun-8a415
263263
$ sudo nerdctl inspect 8a415b278a9e | grep IPAddress
264264
"IPAddress": "10.4.0.2",
265265
"IPAddress": "10.4.0.2",

docs/unikernel-support.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -57,14 +57,14 @@ An example of [Unikraft](https://unikraft.org/) on top of
5757
[Qemu](https://qemu.org) with `urunc`:
5858

5959
```bash
60-
sudo nerdctl run --rm -ti --runtime io.containerd.urunc.v2 harbor.nbfc.io/nubificus/urunc/nginx-qemu-unikraft-initrd:latest unikernel
60+
sudo nerdctl run --rm -ti --runtime io.containerd.urunc.v2 harbor.nbfc.io/nubificus/urunc/nginx-qemu-unikraft-initrd:latest
6161
```
6262

6363
Another example of [Unikraft](https://unikraft.org/) on top of
6464
[Firecracker](https://github.com/firecracker-microvm/firecracker) with `urunc`:
6565

6666
```bash
67-
sudo nerdctl run --rm -ti --runtime io.containerd.urunc.v2 harbor.nbfc.io/nubificus/urunc/nginx-firecracker-unikraft-initrd:latest unikernel
67+
sudo nerdctl run --rm -ti --runtime io.containerd.urunc.v2 harbor.nbfc.io/nubificus/urunc/nginx-firecracker-unikraft-initrd:latest
6868
```
6969

7070
## Mirage
@@ -133,14 +133,14 @@ An example of [MirageOS](https://github.com/mirage/mirage) on top of
133133
container's rootfs with 'urunc':
134134

135135
```bash
136-
sudo nerdctl run --rm -ti --runtime io.containerd.urunc.v2 harbor.nbfc.io/nubificus/urunc/net-mirage-hvt:latest unikernel
136+
sudo nerdctl run --rm -ti --runtime io.containerd.urunc.v2 harbor.nbfc.io/nubificus/urunc/net-mirage-hvt:latest
137137
```
138138

139139
An example of [MirageOS](https://github.com/mirage/mirage) on top of
140140
[Solo5](https://github.com/Solo5/solo5) with 'urunc':
141141

142142
```bash
143-
sudo nerdctl run --rm -ti --runtime io.containerd.urunc.v2 harbor.nbfc.io/nubificus/urunc/net-mirage-spt:latest unikernel
143+
sudo nerdctl run --rm -ti --runtime io.containerd.urunc.v2 harbor.nbfc.io/nubificus/urunc/net-mirage-spt:latest
144144
```
145145

146146
## Rumprun
@@ -211,14 +211,14 @@ An example of [Rumprun](https://github.com/cloudkernels/rumprun) on top of
211211
container's rootfs with 'urunc':
212212

213213
```bash
214-
sudo nerdctl run --rm -ti --runtime io.containerd.urunc.v2 harbor.nbfc.io/nubificus/urunc/redis-hvt-rumprun-block:latest unikernel
214+
sudo nerdctl run --rm -ti --runtime io.containerd.urunc.v2 harbor.nbfc.io/nubificus/urunc/redis-hvt-rumprun-block:latest
215215
```
216216

217217
An example of [Rumprun](https://github.com/cloudkernels/rumprun) on top of
218218
[Solo5](https://github.com/Solo5/solo5) using devmapper with 'urunc':
219219

220220
```bash
221-
sudo nerdctl run --rm -ti --snapshotter devmapper --runtime io.containerd.urunc.v2 harbor.nbfc.io/nubificus/urunc/redis-spt-rumprun:latest unikernel
221+
sudo nerdctl run --rm -ti --snapshotter devmapper --runtime io.containerd.urunc.v2 harbor.nbfc.io/nubificus/urunc/redis-spt-rumprun-raw:latest
222222
```
223223

224224
## Mewz
@@ -331,7 +331,7 @@ An example of a Nginx alpine image on top of [Qemu](https://qemu.org) and
331331
snapshotter:
332332

333333
```bash
334-
sudo nerdctl run --rm -ti --snapshotter devmapper --runtime io.containerd.urunc.v2 harbor.nbfc.io/nubificus/urunc/nginx-qemu-linux:latest
334+
sudo nerdctl run --rm -ti --snapshotter devmapper --runtime io.containerd.urunc.v2 harbor.nbfc.io/nubificus/urunc/nginx-qemu-linux-raw:latest
335335
```
336336

337337
An example of a Redis alpine image transformed to a block file on top of

0 commit comments

Comments
 (0)