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

Add driver config options to README.md.

Browse Source
This commit is contained in:
Shishir Mahajan 2020-07-13 13:55:01 -07:00
parent 58be321d9d
commit f16a2bb055
No known key found for this signature in database
GPG Key ID: D41782E7688DEC4A
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -63,6 +63,16 @@ More detailed instructions are in the [`example README.md`](https://github.com/R
## Supported options
**Driver Config**
| Option | Type | Required | Default | Description |
| :---: | :---: | :---: | :---: | :--- |
| **enabled** | bool | no | true | Enable/Disable task driver. |
| **containerd_runtime** | string | yes | N/A | Runtime for containerd e.g. `io.containerd.runc.v1` or `io.containerd.runc.v2`. |
| **stats_interval** | string | no | 1s | Interval for collecting `TaskStats` |
**Task Config**
| Option | Type | Required | Description |
| :---: | :---: | :---: | :--- |
| **image** | string | yes | OCI image (docker is also OCI compatible) for your container. |