Skip to content

Commit 797cbc8

Browse files
Update README.md.
1 parent 35dc902 commit 797cbc8

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Docker daemon is not required on the host system.
2424

2525
## Requirements
2626

27-
- [Nomad](https://www.nomadproject.io/downloads.html) >=v0.11
27+
- [Nomad](https://www.nomadproject.io/downloads.html) >=v1.0
2828
- [Go](https://golang.org/doc/install) >=v1.11
2929
- [Containerd](https://containerd.io/downloads/) >=1.3
3030
- [Vagrant](https://www.vagrantup.com/downloads.html) >=v2.2
@@ -90,14 +90,14 @@ More detailed instructions are in the [`example README.md`](https://github.com/R
9090
| **cwd** | string | no | Specify the current working directory for your container process. If the directory does not exist, one will be created for you. |
9191
| **privileged** | bool | no | Run container in privileged mode. Your container will have all linux capabilities when running in privileged mode. |
9292
| **host_dns** | bool | no | Default (`true`). By default, a container launched using `containerd-driver` will use host `/etc/resolv.conf`. This is similar to [`docker behavior`](https://docs.docker.com/config/containers/container-networking/#dns-services). However, if you don't want to use host DNS, you can turn off this flag by setting `host_dns=false`. |
93-
| **seccomp** | bool | no | Enable default seccomp profile. List of [`allowed syscalls`](https://github.com/containerd/containerd/blob/master/contrib/seccomp/seccomp_default.go#L51-L390). |
93+
| **seccomp** | bool | no | Enable default seccomp profile. List of [`allowed syscalls`](https://github.com/containerd/containerd/blob/master/contrib/seccomp/seccomp_default.go#L51-L395). |
9494
| **seccomp_profile** | string | no | Path to custom seccomp profile. `seccomp` must be set to `true` in order to use `seccomp_profile`. The default `docker` seccomp profile found [`here`](https://github.com/moby/moby/blob/master/profiles/seccomp/default.json) can be used as a reference, and modified to create a custom seccomp profile. |
9595
| **readonly_rootfs** | bool | no | Container root filesystem will be read-only. |
9696
| **host_network** | bool | no | Enable host network. This is equivalent to `--net=host` in docker. |
9797
| **cap_add** | []string | no | Add individual capabilities. |
9898
| **cap_drop** | []string | no | Drop invidual capabilities. |
9999
| **devices** | []string | no | A list of devices to be exposed to the container. |
100-
| **mounts** | []block | no | A list of mounts to be mounted in the container. Volume, bind and tmpfs type mounts are supported. fstab style [`mount options`](https://github.com/containerd/containerd/blob/master/mount/mount_linux.go#L187-L211) are supported. |
100+
| **mounts** | []block | no | A list of mounts to be mounted in the container. Volume, bind and tmpfs type mounts are supported. fstab style [`mount options`](https://github.com/containerd/containerd/blob/master/mount/mount_linux.go#L211-L235) are supported. |
101101

102102
**Mount block**<br/>
103103
&emsp;&emsp;\{<br/>
@@ -219,12 +219,17 @@ A [`service`](https://www.nomadproject.io/docs/job-specification/service) stanza
219219
The service stanza instructs Nomad to register a service with Consul.
220220

221221
## Tests
222+
223+
If you are running the tests locally, use the [`vagrant VM`](Vagrantfile) provided in the repository.
224+
222225
```
223-
$ make test
226+
$ vagrant up
227+
$ vagrant ssh containerd-linux
228+
$ sudo make test
224229
```
225230
**NOTE**: These are destructive tests and can leave the system in a changed state.<br/>
226-
It is highly recommended to run these tests either as part of a CI/CD system or on
227-
a immutable infrastructure e.g VMs.
231+
It is highly recommended to run these tests either as part of a CI/CD system e.g. circleci or on
232+
a immutable infrastructure e.g vagrant VMs.
228233

229234
## Cleanup
230235
```

0 commit comments

Comments
 (0)