system

package

v2.4.0-rc.0 Latest Latest Go to latest Published: Sep 17, 2026 License: Apache-2.0 Imports: 35 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/containerd/nerdctl

Links

Open Source Insights

Documentation ¶

Index ¶

func Df(ctx context.Context, client *containerd.Client, options types.SystemDfOptions) error
func DiskUsage(ctx context.Context, client *containerd.Client, options types.SystemDfOptions) (types.DiskUsage, error)
func Events(ctx context.Context, client *containerd.Client, ...) error
func Info(ctx context.Context, client *containerd.Client, ...) error
func Prune(ctx context.Context, client *containerd.Client, ...) error
type Action
- func TopicToAction(topic string) Action
type EventFilter
type EventOut

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Df ¶ added in v2.4.0

func Df(ctx context.Context, client *containerd.Client, options types.SystemDfOptions) error

Df shows how much disk space containerd uses for the images, containers and volumes of the current namespace, plus the BuildKit build cache.

func DiskUsage ¶ added in v2.4.0

func DiskUsage(ctx context.Context, client *containerd.Client, options types.SystemDfOptions) (types.DiskUsage, error)

DiskUsage collects the disk usage of every kind of resource nerdctl manages.

func Events ¶

func Events(ctx context.Context, client *containerd.Client, options types.SystemEventsOptions) error

Events is from https://github.com/containerd/containerd/blob/v1.4.3/cmd/ctr/commands/events/events.go

func Info ¶

func Info(ctx context.Context, client *containerd.Client, options types.SystemInfoOptions) error

func Prune ¶

func Prune(ctx context.Context, client *containerd.Client, options types.SystemPruneOptions) error

Prune will remove all unused containers, networks, images (dangling only or both dangling and unreferenced), and optionally, volumes.

Types ¶

type Action ¶ added in v2.4.0

type Action string

const (
	START   Action = "start"
	UNKNOWN Action = "unknown"
)

func TopicToAction ¶ added in v2.4.0

func TopicToAction(topic string) Action

type EventFilter ¶

type EventFilter func(*EventOut) bool

EventFilter for filtering events

type EventOut ¶

type EventOut struct {
	Timestamp time.Time
	ID        string
	Namespace string
	Topic     string
	Action    Action
	Event     string
	Labels    map[string]string
}

EventOut contains information about an event.

Source Files ¶

View all Source files

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