BUILDING.md

Building

This doc includes:

• Requirements
• Build from source
• Configure
  • Proxy snapshotter plugin config
  • containerd config
• Run

Requirements

• Install Go >= 1.16.x
• Install runc >= 1.0
• Install containerd >= 1.4.x (1.6.x is preferred)
  • See Downloads at containerd.io.

Build from source

You need git to checkout the source code and compile:

git clone https://github.com/containerd/accelerated-container-image.git
cd accelerated-container-image
make

The snapshotter and ctr plugin are generated in bin.

Configure

proxy snapshotter plugin config

sudo mkdir /etc/overlaybd-snapshotter
sudo cat <<-EOF | sudo tee /etc/overlaybd-snapshotter/config.json
{
    "root": "/var/lib/overlaybd/",
    "address": "/run/overlaybd-snapshotter/overlaybd.sock"
}
EOF

containerd config

sudo cat <<-EOF | sudo tee --append /etc/containerd/config.toml

[proxy_plugins.overlaybd]
    type = "snapshot"
    address = "/run/overlaybd-snapshotter/overlaybd.sock"
EOF

Run

# run snapshotter plugin
sudo bin/overlaybd-snapshotter

# restart containerd
sudo systemctl restart containerd