Skip to content

Commit 6f17d02

Browse files
Update README.md.
1 parent c1707df commit 6f17d02

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

README.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ Docker daemon is not required on the host system.
2323
- [Nomad](https://www.nomadproject.io/downloads.html) >=v0.11
2424
- [Go](https://golang.org/doc/install) >=v1.11
2525
- [Containerd](https://containerd.io/downloads/) >=1.3
26+
- [Vagrant](https://www.vagrantup.com/downloads.html) >=v2.2
27+
- [VirtualBox](https://www.virtualbox.org/) v6.0 (or any version vagrant is compatible with)
2628

2729
## Building nomad-driver-containerd
2830

@@ -37,19 +39,18 @@ $ make build (This will build your containerd-driver binary)
3739
## Wanna try it out!?
3840

3941
```
40-
./setup.sh
42+
$ vagrant up
4143
```
42-
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.
44+
or `vagrant provision` if the vagrant VM is already running.
4345

44-
**NOTE** `setup.sh` overrides your existing `containerd` to `containerd-1.3.4`. This is needed for `io.containerd.runc.v2` runtime.<br/>
45-
Your original containerd systemd unit file will be backed up at `/lib/systemd/system/containerd.service.bkp` in case you wanna revert later.
46-
47-
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:
46+
Once setup (`vagrant up` OR `vagrant provision`) is complete and the nomad server is up and running, you can check the registered task drivers (which will also show `containerd-driver`) using:
4847
```
4948
$ nomad node status (Note down the <node_id>)
5049
$ nomad node status <node_id> | grep containerd-driver
5150
```
5251

52+
**NOTE:** [`setup.sh`](vagrant/setup.sh) is part of the vagrant setup and should not be executed directly.
53+
5354
## Run Example jobs.
5455

5556
There are few example jobs in the [`example`](https://github.com/Roblox/nomad-driver-containerd/tree/master/example) directory.
@@ -120,6 +121,11 @@ make clean
120121
```
121122
This will delete your binary: `containerd-driver`
122123

124+
```
125+
vagrant destroy
126+
```
127+
This will destroy your vagrant VM.
128+
123129
## Currently supported environments
124130
Ubuntu (>= 16.04)
125131

0 commit comments

Comments
 (0)