cri

Documentation

Overview

Package cri provides a container Watcher for CRI pod event API-supporting engines.

Usage

import "github.com/thediveo/whalewatcher/watcher/cri"
watcher := cri.NewWatcher("/path/to/CRI-API-endpoint.sock")

Please note that there is no default/standard path for CRI API endpoints; instead, the exact path depends on the specific container engine and/or the particular deployment.

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(criapisock string, buggeroff backoff.BackOff, opts ...engineclient.NewOption) (watcher.Watcher, error)

Constants

const Type = engineclient.Type

Type ID of the container engine handled by this watcher.

Functions

func New

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

New returns a Watcher for keeping track of the currently alive containers (including sandbox containers).

Please note that there is no default value for the CRI API socket path, so it must not be the empty string.

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.