burble/nomad-driver-containerd
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #19 from Roblox/readme

Browse Source 
Fix broken links and readibility improvements.
This commit is contained in:
Shishir 2020-07-10 14:54:01 -07:00 committed by GitHub
commit b575a82836
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -36,17 +36,20 @@ $ make build (This will build your containerd-driver binary)
```
./setup.sh
```
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.
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.
**NOTE** `setup.sh` overrides your existing `containerd` to `containerd-1.3.4`. This is needed for `io.containerd.runc.v2` runtime.<br/>
Your original containerd systemd unit file will be backed up at `/lib/systemd/system/containerd.service.bkp` in case you wanna revert later.
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:
```
$ nomad node status (Note down the <node_id>)
$ nomad node status <node_id>
$ nomad node status <node_id> | grep containerd-driver
```
## Run Example jobs.
There are few example jobs in the [`example`](https://github.com/Roblox/nomad-driver-containerd/tree/readme/example) directory.
There are few example jobs in the [`example`](https://github.com/Roblox/nomad-driver-containerd/tree/master/example) directory.
```
$ nomad job run <job_name.nomad>
@ -54,7 +57,7 @@ $ nomad job run <job_name.nomad>
will launch the job.<br/>
**NOTE:** You need to run `setup.sh` before trying out the example jobs.<br/>
More detailed instructions are in the [`example README.md`](https://github.com/Roblox/nomad-driver-containerd/tree/readme/example)
More detailed instructions are in the [`example README.md`](https://github.com/Roblox/nomad-driver-containerd/tree/master/example)
## Tests
```

2
example/README.md
View File

@ -119,6 +119,8 @@ This container does the following:<br/>
<li>Bind mounts /tmp/s1 (host) to /tmp/t1 (container).</li>
</ol>
**NOTE**: `/tmp/s1` should exist on the host, before you run **Privileged** job.<br/>
**Exec into privileged container to check capabilities, devices and mounts.**
```