Documentation
¶
Overview ¶
Package k8simage extracts container image references from Kubernetes YAML files.
Index ¶
Constants ¶
const ( // Name is the unique name of this extractor. Name = "containers/k8simage" // DefaultMaxFileSizeBytes is the default maximum file size the extractor will // attempt to process. If a file is encountered that is larger than this // limit, the file is skipped during processing. DefaultMaxFileSizeBytes = 1 * units.MiB )
Variables ¶
This section is empty.
Functions ¶
func NewDefault ¶
func NewDefault() filesystem.Extractor
NewDefault returns an extractor with the default config settings.
Types ¶
type Config ¶
type Config struct {
// Stats is a stats collector for reporting metrics.
Stats stats.Collector
// MaxFileSizeBytes is the maximum file size this extractor will unmarshal. If
// `FileRequired` receives a larger file, it will return false.
MaxFileSizeBytes int64
}
Config is the configuration for the Extractor.
func DefaultConfig ¶
func DefaultConfig() Config
DefaultConfig returns the default configuration for the extractor.
type Extractor ¶
type Extractor struct {
// contains filtered or unexported fields
}
Extractor extracts container image references from Kubernetes YAML files.
func New ¶
New returns a Kubernetes container image extractor.
For most use cases, initialize with: ``` e := New(DefaultConfig()) ```
func (Extractor) Extract ¶
func (e Extractor) Extract(ctx context.Context, input *filesystem.ScanInput) (inventory.Inventory, error)
Extract extracts container image references from a K8s configuration file.
func (Extractor) FileRequired ¶
func (e Extractor) FileRequired(api filesystem.FileAPI) bool
FileRequired returns true if the specified file looks like a Kubernetes YAML file. It determines if the specified file is a Kubernetes YAML file that should be processed by checking the file extension (.yaml or .yml).
func (Extractor) Requirements ¶
func (e Extractor) Requirements() *plugin.Capabilities
Requirements of the extractor.
Source Files