docker

package

v0.3.4 Latest Latest Go to latest Published: Sep 22, 2025 License: Apache-2.0 Imports: 8 Imported by: 0

Details

Package docker extracts container inventory from docker API.

View Source

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

This section is empty.

func New() standalone.Extractor

New returns an extractor

func NewWithClient(c Client) standalone.Extractor

NewWithClient returns an extractor which uses a specified docker client.

type Client interface {
	ContainerList(ctx context.Context, options container.ListOptions) ([]container.Summary, error)
}

Client is an interface that provides an abstraction on top of the docker client.

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

Extractor implements the docker extractor.

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

Extract extracts containers from the docker API.

func (e Extractor) Name() string

Name of the extractor.

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

Requirements of the extractor.

func (e Extractor) Version() int

Version of the extractor.

type Metadata struct {
	ImageName   string
	ImageDigest string
	ID          string
	Ports       []container.Port
}

Metadata holds parsing information for a container running in docker.

Path	Synopsis
fakeclient Package fakeclient contains a fake implementation of the docker client for testing purposes.	Package fakeclient contains a fake implementation of the docker client for testing purposes.