containerd

Documentation

Overview

Package containerd extracts container inventory from containerd metadb database.

Index

• Constants
• type Config
  • func DefaultConfig() Config
• type Extractor
  • func New(cfg Config) *Extractor
  • func (e Extractor) Config() Config
  • func (Extractor) Ecosystem(i *extractor.Inventory) string
  • func (e Extractor) Extract(ctx context.Context, input *filesystem.ScanInput) ([]*extractor.Inventory, error)
  • func (e Extractor) FileRequired(api filesystem.FileAPI) bool
  • 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
• type SnapshotMetadata

Constants

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

Types

type Config

type Config struct {
	// MaxMetaDBFileSize is the maximum file size an extractor will unmarshal.
	// If Extract gets a bigger file, it will return an error.
	MaxMetaDBFileSize int64
}

Config is the configuration for the Extractor.

func DefaultConfig

func DefaultConfig() Config

DefaultConfig returns the default configuration for the containerd extractor.

type Extractor

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

Extractor extracts containers from the containerd metadb file.

func New

func New(cfg Config) *Extractor

New returns a containerd container inventory extractor.

func (Extractor) Config

func (e Extractor) Config() Config

Config returns the configuration of the extractor.

func (Extractor) Ecosystem

func (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 *filesystem.ScanInput) ([]*extractor.Inventory, error)

Extract container inventory through the containerd metadb file passed as the scan input.

func (Extractor) FileRequired

func (e Extractor) FileRequired(api filesystem.FileAPI) bool

FileRequired returns true if the specified file matches containerd metaDB file pattern.

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
	// the type of filesystem implementation. For example, overlayfs
	Snapshotter string
	// string that is the sha digest
	SnapshotKey string
	LowerDir    string
	UpperDir    string
	WorkDir     string
}

Metadata contains metadata about a containerd container.

type SnapshotMetadata

type SnapshotMetadata struct {
	FilesystemType string
	Digest         string
	ID             int
	Kind           int
	Parent         string
}

SnapshotMetadata recovers the mount point of a container from snapshotter metadata.db file.