nomad-driver-containerd

Nomad task driver for launching containers using containerd.

Containerd (containerd.io) is a lightweight container daemon for running and managing container lifecycle.
Docker daemon also uses containerd.

dockerd (docker daemon) --> containerd --> containerd-shim --> runc

nomad-driver-containerd enables nomad client to launch containers directly using containerd, without docker!
Docker daemon is not required on the host system.

nomad-driver-containerd architecture

Requirements

• Nomad >=v0.11
• Go >=v1.11
• Containerd >=1.3
• Vagrant >=v2.2
• VirtualBox v6.0 (or any version vagrant is compatible with)

Building nomad-driver-containerd

Make sure your $GOPATH is setup correctly.

$ mkdir -p $GOPATH/src/github.com/Roblox
$ cd $GOPATH/src/github.com/Roblox
$ git clone git@github.com:Roblox/nomad-driver-containerd.git
$ cd nomad-driver-containerd
$ make build (This will build your containerd-driver binary)

Screencast

Wanna try it out!?

$ vagrant up

or vagrant provision if the vagrant VM is already running.

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:

$ nomad node status (Note down the <node_id>)
$ nomad node status <node_id> | grep containerd-driver

NOTE: setup.sh is part of the vagrant setup and should not be executed directly.

Run Example jobs.

There are few example jobs in the example directory.

$ nomad job run <job_name.nomad>

will launch the job.

More detailed instructions are in the example README.md

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.
command	string	no	Command to override command defined in the image.
args	[]string	no	Arguments to the command.
privileged	bool	no	Run container in privileged mode. Your container will have all linux capabilities when running in privileged mode.
readonly_rootfs	bool	no	Container root filesystem will be read-only.
cap_add	[]string	no	Add individual capabilities.
cap_drop	[]string	no	Drop invidual capabilities.
devices	[]string	no	A list of devices to be exposed to the container.
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 are supported.

Mount block
  {
   - type (string) (Optional): Supported values are volume, bind or tmpfs. Default: volume.
   - target (string) (Required): Target path in the container.
   - source (string) (Optional): Source path on the host.
   - options ([]string) (Optional): fstab style mount options. NOTE: For bind mounts, atleast rbind and ro are required.
  }

Bind mount example

mounts = [
           {
                type    = "bind"
                target  = "/target/t1"
                source  = "/src/s1"
                options = ["rbind", "ro"]
           }
        ]

Tests

$ make test

NOTE: These are destructive tests and can leave the system in a changed state.
It is highly recommended to run these tests either as part of a CI/CD system or on a immutable infrastructure e.g VMs.

Cleanup

make clean

This will delete your binary: containerd-driver

vagrant destroy

This will destroy your vagrant VM.

Currently supported environments

Ubuntu (>= 16.04)

Limitations

nomad-driver-containerd v0.1 is not production ready. There are some open items which are currently being worked on.

1. Networking: Networking is not in scope of containerd as described here. However an external CNI plugin can be used to add networking to the container. We are researching on how to enable networking for our internal use-cases, and would publish (open-source) that work at some point.

2. Port forwarding: The ability to map a host port to a container port. This is currently not supported, but could be supported in future.

3. Consul connect: When a user launches a job in nomad, s/he can add a service stanza which will instruct nomad to register the service with consul for service discovery. This is currently not supported.

License

Copyright 2020 Roblox Corporation

Licensed under the Apache License, Version 2.0 (the "License"). For more information read the License.