containerd

Documentation

Overview

Package containerd provides a container Watcher for containerd engines.

Usage

import "github.com/thediveo/whalewatcher/watcher/containerd"
watcher := containerd.NewWatcher("")

The watcher constructor accepts options, with currently the only option being specifying a container engine's PID. The PID information then can be used downstream in tools like lxkns to translate container PIDs between different PID namespaces.

Index

• Constants
• func New(containerdsock string, buggeroff backoff.BackOff, ...) (watcher.Watcher, error)

Constants

const Type = engineclient.Type

Type ID of the container engine handled by this watcher.

Functions

func New

func New(containerdsock string, buggeroff backoff.BackOff, opts ...engineclient.NewOption) (watcher.Watcher, error)

New returns a Watcher for keeping track of the currently alive containers, optionally with the (nerdctl) composer projects they're associated with.

When the containerdsock parameter is left empty then containerd's default "/run/containerd/containerd.sock" applies.

If the backoff is nil then the backoff defaults to backoff.StopBackOff, that is, any failed operation will never be retried.

Finally, containerd engine client-specific options can be passed in.