detector

package
v1.1.3 Latest Latest
Warning

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

Go to latest
Published: Feb 2, 2024 License: MIT Imports: 3 Imported by: 0

Documentation

Overview

Package detector defines the plugin interface between the TurtleFinder and its container engine detector plugins.

The sub-package “all” pulls in all supported engine detector plugins that are supported out-of-the-box of this module. The “all” package in turn is imported by the toplevel “turtlefinder” package to ensure that the full support is always included.

The individual engine-specific detector plugins are then implemented in the other sub-packages: for instance, the “containerd” and “moby” sub-packages.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Detector

type Detector interface {
	// EngineNames returns one or more process name(s) of a specific type of
	// container engine.
	EngineNames() []string

	// NewWatchers returns one or more watchers for tracking the alive container
	// workload of the container engine accessible by at least one of the
	// specified API paths. Usually, this will be only a single watcher per
	// engine, but in case of containerd we want to return multiple watchers,
	// one for plain containerd and one for its CRI view.
	NewWatchers(ctx context.Context, pid model.PIDType, apis []string) []watcher.Watcher
}

Detector allows specialized container engine detector plugins to interface with the generic engine discovery mechanism, by describing how to detect a particular container engine using its process name and creating the correct watcher(s) to monitor the container workload.

Directories

Path Synopsis
Package all pulls in all turtlefinder engine detectors.
Package all pulls in all turtlefinder engine detectors.
Package containerd implements the engine detector for containerd processes.
Package containerd implements the engine detector for containerd processes.
Package crio implements the engine detector for cri-o engine processes.
Package crio implements the engine detector for cri-o engine processes.
Package moby implements the engine detector for Docker “dockerd” processes.
Package moby implements the engine detector for Docker “dockerd” processes.

Jump to

Keyboard shortcuts

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