Skip to content

Commit b575a82

Browse files
Merge pull request #19 from Roblox/readme
Fix broken links and readibility improvements.
2 parents 5bf2d8b + 4ba8a6d commit b575a82

File tree

2 files changed

+9
-4
lines changed

2 files changed

+9
-4
lines changed

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,25 +36,28 @@ $ make build (This will build your containerd-driver binary)
3636
```
3737
./setup.sh
3838
```
39-
The setup script will setup `containerd 1.3.4` and `nomad server+nomad-driver-containerd` (nomad server/client should already be installed on your system, and `setup.sh` only builds the driver) on your system, so you can try out [`example`](https://github.com/Roblox/nomad-driver-containerd/tree/readme/example) jobs.
39+
The setup script will setup `containerd 1.3.4` and `nomad server+nomad-driver-containerd` (nomad server/client should already be installed on your system, and `setup.sh` only builds the driver) on your system, so you can try out [`example`](https://github.com/Roblox/nomad-driver-containerd/tree/master/example) jobs.
40+
41+
**NOTE** `setup.sh` overrides your existing `containerd` to `containerd-1.3.4`. This is needed for `io.containerd.runc.v2` runtime.<br/>
42+
Your original containerd systemd unit file will be backed up at `/lib/systemd/system/containerd.service.bkp` in case you wanna revert later.
4043

4144
Once `setup.sh` is complete and the nomad server is up and running, you can check the registered task drivers (which will also show `containerd-driver`) using:
4245
```
4346
$ nomad node status (Note down the <node_id>)
44-
$ nomad node status <node_id>
47+
$ nomad node status <node_id> | grep containerd-driver
4548
```
4649

4750
## Run Example jobs.
4851

49-
There are few example jobs in the [`example`](https://github.com/Roblox/nomad-driver-containerd/tree/readme/example) directory.
52+
There are few example jobs in the [`example`](https://github.com/Roblox/nomad-driver-containerd/tree/master/example) directory.
5053

5154
```
5255
$ nomad job run <job_name.nomad>
5356
```
5457
will launch the job.<br/>
5558

5659
**NOTE:** You need to run `setup.sh` before trying out the example jobs.<br/>
57-
More detailed instructions are in the [`example README.md`](https://github.com/Roblox/nomad-driver-containerd/tree/readme/example)
60+
More detailed instructions are in the [`example README.md`](https://github.com/Roblox/nomad-driver-containerd/tree/master/example)
5861

5962
## Tests
6063
```

example/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,8 @@ This container does the following:<br/>
119119
<li>Bind mounts /tmp/s1 (host) to /tmp/t1 (container).</li>
120120
</ol>
121121

122+
**NOTE**: `/tmp/s1` should exist on the host, before you run **Privileged** job.<br/>
123+
122124
**Exec into privileged container to check capabilities, devices and mounts.**
123125

124126
```

0 commit comments

Comments
 (0)