Documentation
¶
Overview ¶
Package dockercomposeimage extracts image URLs from Docker Compose files.
Index ¶
Constants ¶
View Source
const ( // Name is the unique name of this extractor. Name = "containers/dockercomposeimage" // DefaultMaxFileSizeBytes is the default maximum file size the extractor will // attempt to extract. If a file is encountered that is larger than this // limit, the file is ignored by `FileRequired`. 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` gets a bigger 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 image URLs from Docker Compose files.
func New ¶
New returns a Docker Compose 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 image URLs from a Docker Compose file.
func (Extractor) FileRequired ¶
func (e Extractor) FileRequired(api filesystem.FileAPI) bool
FileRequired returns true if the specified file could be a Docker Compose file.
func (Extractor) Requirements ¶
func (e Extractor) Requirements() *plugin.Capabilities
Requirements of the extractor.
Source Files
Click to show internal directories.
Click to hide internal directories.