Fix broken links and readibility improvements.

This commit is contained in:
Shishir Mahajan 2020-07-10 14:09:56 -07:00
parent 5bf2d8b66f
commit 5edf09fcd3
No known key found for this signature in database
GPG Key ID: D41782E7688DEC4A
2 changed files with 8 additions and 5 deletions

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
```

View File

@ -116,7 +116,7 @@ This container does the following:<br/>
<li>Sleeps for 10 mins (600 seconds).</li>
<li>Runs in privileged mode i.e the bounding set contains all linux capabilities.</li>
<li>Add /dev/loop0 and /dev/loop1 loopback devices into the container.</li>
<li>Bind mounts /tmp/s1 (host) to /tmp/t1 (container).</li>
<li>Bind mounts /tmp/s1 (host) to /tmp/t1 (container). **NOTE**: /tmp/s1 should exist on the host, before you run **Privileged** job.</li>
</ol>
**Exec into privileged container to check capabilities, devices and mounts.**