containerd-shim-systemd-v1

command module
v0.0.0-...-7472e58 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 24, 2023 License: Apache-2.0 Imports: 67 Imported by: 0

README

sytstemd-shim

This project aims to provide a containerd shim implementation which uses systemd to manage containers.

Advantages over the standard runc (io.containerd.runc.v2) shim:

  1. Containers can be seen and managed using systemctl just like any other system service
  2. There is a single shim per node instead of per container (or pod), so O(1) runtime overhead instead of O(n).
  3. Shutting down or restarting the node will correctly shutdown containers because containers are run as systemd units.
  4. Possible to send all stdout/stderr messages to journald instead of managing pipes.
  5. Shim can be restarted for whatever reason w/o disrupting containers (TODO).

This requires a minimum of containerd 1.6 to function.

This is alpha quality software and does not yet fully implement the containerd shim API. Do not use this in production environments.

Regarding point "2" above, for containers which require a TTY we actually spin up a helper process to copy from the pty to the stdio pipes. This helper is (mostly) written in C and has minimal overhead.

Build:

make build

Install:

sudo make install # installs binary
$(which containerd-shim-systemd-v1) install # installs/starts systemd units

Usage:

Put the built binary into $PATH (as seen by the containerd daemon).

# ctr run --rm --runtime=io.containerd.systemd.v1 docker.io/busybox:latest test top

You should be able to do things like

# systemctl status containerd-default-test

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
contrib

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL