Skip to content

Latest commit

 

History

History
133 lines (90 loc) · 3.62 KB

BUILDING.md

File metadata and controls

133 lines (90 loc) · 3.62 KB
Raw

Build containerd from source

This guide is useful if you intend to contribute on containerd. Thanks for your effort. Every contribution is very appreciated.

Build the development environment

In first you need to setup your Go development environment. You can follow this guideline How to write go code and at the end you need to have GOPATH and GOROOT set in your environment.

Current containerd requires Go 1.8.x or above.

At this point you can use go to checkout containerd in your GOPATH:

go get github.com/containerd/containerd

containerd uses Btrfs it means that you need to satisfy this dependencies in your system:

  • CentOS/Fedora: yum install btrfs-progs-devel
  • Debian/Ubuntu: apt-get install btrfs-tools

At this point you are ready to build containerd yourself.

In your local environment

containerd uses make to create a repeatable build flow. It means that you can run:

make

This is going to build all the binaries provided by this project in the ./bin directory.

You can move them in your global path with:

sudo make install

Via Docker Container

Build containerd

You can build containerd via Docker container. You can build an image from this Dockerfile:

FROM golang

RUN apt-get update && \
    apt-get install btrfs-tools

Let's suppose that you built an image called containerd/build and you are into the containerd root directory you can run the following command:

docker run -it --rm \
    -v ${PWD}:/go/src/github.com/containerd/containerd \
    -e GOPATH=/go \
    -w /go/src/github.com/containerd/containerd containerd/build make

At this point you can find your binaries in the ./bin directory in your host. You can move the binaries in your $PATH with the command:

sudo make install

Build runc and containerd

To have complete core container runtime, you will need both containerd and runc. It is possible to build both of these via Docker container.

You can use go to checkout runc in your GOPATH:

go get github.com/opencontainers/runc

We can build an image from this Dockerfile

FROM golang

RUN apt-get update && \
    apt-get install -y btrfs-tools libapparmor-dev libseccomp-dev

In our Docker container we will use a specific runc build which includes seccomp and apparmor support. Hence why our Dockerfile includes these dependencies: libapparmor-dev libseccomp-dev.

Let's suppose you build an image called containerd/build from the above Dockerfile. You can run the following command:

docker run -it --privileged \
    -v /var/lib/containerd \
    -v ${GOPATH}/src/github.com/opencontainers/runc:/go/src/github.com/opencontainers/runc \
    -v ${GOPATH}/src/github.com/containerd/containerd:/go/src/github.com/containerd/containerd \
    -e GOPATH=/go
    -w /go/src/github.com/containerd/containerd containerd/build sh

This mounts both runc and containerd repositories in our Docker container.

From within our Docker container let's build containerd

cd /go/src/github.com/containerd/containerd
make && make install

These binaries can be found in the ./bin directory in your host. make install will move the binaries in your $PATH.

Next, let's build runc

cd /go/src/github.com/opencontainers/runc
make BUILDTAGS='seccomp apparmor' && make install

When working with ctr, the containerd CLI we just built, don't forget to start containerd!

containerd --config config.toml