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

Update README.md.

Browse Source
This commit is contained in:
Shishir Mahajan 2020-07-09 13:17:09 -07:00
parent d41fd1e0a6
commit 38325c685c
No known key found for this signature in database
GPG Key ID: D41782E7688DEC4A
1 changed files with 8 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
README.md
View File

@ -21,45 +21,6 @@ Docker daemon is not required on the host system.
- [Go](https://golang.org/doc/install) >=v1.11
- [Containerd](https://containerd.io/downloads/) >=1.3
## Installing containerd
Containerd can be build from the [`source`](https://github.com/containerd/containerd) OR
pre-compiled binary can be downloaded from [`here`](https://containerd.io/downloads/)
```
$ cd /tmp
$ curl -L -o containerd-1.3.4.linux-amd64.tar.gz https://github.com/containerd/containerd/releases/download/v1.3.4/containerd-1.3.4.linux-amd64.tar.gz
$ sudo tar -C /usr/local -xzf containerd-1.3.4.linux-amd64.tar.gz
$ rm -f containerd-1.3.4.linux-amd64.tar.gz
```
Once containerd is installed in `/usr/local/bin`, it can be managed using process supervisors or init systems like systemd. An example systemd unit file looks something like this.
```
[Unit]
Description=containerd container runtime
Documentation=https://containerd.io
After=network.target
[Service]
ExecStartPre=-/sbin/modprobe overlay
ExecStart=/usr/local/bin/containerd
KillMode=process
Delegate=yes
LimitNOFILE=1048576
# Having non-zero Limit*s causes performance problems due to accounting overhead
# in the kernel. We recommend using cgroups to do container-local accounting.
LimitNPROC=infinity
LimitCORE=infinity
TasksMax=infinity
[Install]
WantedBy=multi-user.target
```
Once the systemd unit is dropped in `/lib/systemd/system/containerd.service`, you can start containerd:
```
$ sudo systemctl daemon-reload
$ sudo systemctl start containerd
$ sudo systemctl status containerd
```
## Building nomad-driver-containerd
```
$ mkdir -p $GOPATH/src/github.com/Roblox
@ -68,21 +29,17 @@ $ git clone git@github.com:Roblox/nomad-driver-containerd.git
$ cd nomad-driver-containerd
$ make build (This will build your containerd-driver binary)
```
### Start a nomad dev server with nomad-driver-containerd task driver
## Wanna try it out!?
```
$ mkdir -p /tmp/nomad-driver-containerd
$ cd /tmp/nomad-driver-containerd
$ ln -s $GOPATH/src/github.com/Roblox/nomad-driver-containerd/containerd-driver containerd-driver
$ cd $GOPATH/src/github.com/Roblox/nomad-driver-containerd/example
$ nomad agent -dev -config=agent.hcl -plugin-dir=/tmp/nomad-driver-containerd
./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.
Once the nomad server is up and running, you can check the registered task drivers (which will also show `nomad-driver-containerd`) using:
Once `setup.sh` is complete and the nomad server is up and running, you can check the registered task drivers (which will also show nomad-driver-containerd) using:
```
$ nomad node status <nodeid>
$ nomad node status (Note down the <node_id>)
$ nomad node status <node_id>
```
## Run Example jobs.
@ -92,7 +49,8 @@ There are few example jobs in the [`example`](https://github.com/Roblox/nomad-dr
```
$ nomad job run <job_name.nomad>
```
will launch the job, as long as both nomad server (+nomad-driver-containerd) and containerd are running on your system.
will launch the job.
NOTE: You need to run `setup.sh` before trying out the example jobs.
More detailed instructions are in the [`example README.md`](https://github.com/Roblox/nomad-driver-containerd/tree/readme/example)
## Tests