containerd

Documentation

Overview

Package containerd extracts container inventory from containerd API.

Index

• Constants
• type Config
  • func DefaultConfig() Config
• type CtrdClient
• type Extractor
  • func New(cfg Config) *Extractor
  • func NewWithClient(cli CtrdClient, socketAddr string) *Extractor
  • func (e Extractor) Config() Config
  • func (e Extractor) Ecosystem(i *extractor.Inventory) string
  • func (e *Extractor) Extract(ctx context.Context, input *standalone.ScanInput) ([]*extractor.Inventory, error)
  • func (e Extractor) Name() string
  • func (e Extractor) Requirements() *plugin.Capabilities
  • func (e Extractor) ToPURL(i *extractor.Inventory) *purl.PackageURL
  • func (e Extractor) Version() int
• type Metadata

Constants

const (
	// Name is the unique name of this extractor.
	Name = "containers/containerd-runtime"
)

Types

type Config

type Config struct {
	// ContainerdSocketAddr is the local path to the containerd socket.
	// Used further to crete a client for containerd API.
	ContainerdSocketAddr string
}

Config is the configuration for the Extractor.

func DefaultConfig

func DefaultConfig() Config

DefaultConfig returns the default configuration for the containerd extractor.

type CtrdClient

type CtrdClient interface {
	LoadContainer(ctx context.Context, id string) (containerd.Container, error)
	NamespaceService() namespaces.Store
	TaskService() tasks.TasksClient
	Close() error
}

CtrdClient is an interface that provides an abstraction on top of the containerd client. Needed for testing purposes.

type Extractor

type Extractor struct {
	// contains filtered or unexported fields
}

Extractor implements the containerd runtime extractor.

func New

func New(cfg Config) *Extractor

New creates a new containerd client and returns a containerd container inventory extractor.

func NewWithClient

func NewWithClient(cli CtrdClient, socketAddr string) *Extractor

NewWithClient creates a new extractor with the provided containerd client. Needed for testing purposes.

func (Extractor) Config

func (e Extractor) Config() Config

Config returns the configuration of the extractor.

func (Extractor) Ecosystem

func (e Extractor) Ecosystem(i *extractor.Inventory) string

Ecosystem returns no ecosystem since the Inventory is not a software package.

func (*Extractor) Extract

func (e *Extractor) Extract(ctx context.Context, input *standalone.ScanInput) ([]*extractor.Inventory, error)

Extractor extracts containers from the containerd API.

func (Extractor) Name

func (e Extractor) Name() string

Name of the extractor.

func (Extractor) Requirements

func (e Extractor) Requirements() *plugin.Capabilities

Requirements of the extractor.

func (Extractor) ToPURL

func (e Extractor) ToPURL(i *extractor.Inventory) *purl.PackageURL

ToPURL converts an inventory created by this extractor into a PURL.

func (Extractor) Version

func (e Extractor) Version() int

Version of the extractor.

type Metadata

type Metadata struct {
	Namespace   string
	ImageName   string
	ImageDigest string
	Runtime     string
	ID          string
	PID         int
	RootFS      string
}

Metadata holds parsing information for a container running on the containerd runtime.