cos

Documentation

Overview

Package cos extracts OS packages from Container Optimized OSes (go/cos).

Index

• Constants
• func New(cfg *cpb.PluginConfig) (filesystem.Extractor, error)
• type Extractor
  • func (e Extractor) Extract(ctx context.Context, input *filesystem.ScanInput) (inventory.Inventory, error)
  • func (e Extractor) FileRequired(api filesystem.FileAPI) bool
  • func (e Extractor) Name() string
  • func (e Extractor) Requirements() *plugin.Capabilities
  • func (e Extractor) Version() int

Constants

const (
	// Name is the unique name of this extractor.
	Name = "os/cos"
)

Functions

func New

func New(cfg *cpb.PluginConfig) (filesystem.Extractor, error)

New returns a COS extractor.

For most use cases, initialize with: ``` e := New(&cpb.PluginConfig{}) ```

Types

type Extractor

type Extractor struct {
	Stats stats.Collector
	// contains filtered or unexported fields
}

Extractor extracts cos packages from cos database.

func (Extractor) Extract

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

Extract extracts packages from cos package info files passed through the scan input.

func (Extractor) FileRequired

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

FileRequired returns true if the specified file matches cos package info 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) Version

func (e Extractor) Version() int

Version of the extractor.