Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CollectSource ¶
type CollectSource interface {
// GetDataSources returns a data source containing targets for the
// collector to collect
GetDataSources(ctx context.Context) (*DataSources, error)
// DataSourcesUpdate will return a channel which will get an element
// if the CollectSource has new data. This is heuristical and the
// channel may get an element even if there is no new data.
DataSourcesUpdate(ctx context.Context) (<-chan error, error)
}
CollectSource provides a way for collector to get collect targets from a data source (e.g. a file, a database, a pubsub queue, etc.)
This provides the flexibility for collectors to be configured in a similar way to prevent configuration drift among collectors, and provide a way to centrally manage collector source targets.
type DataSources ¶
type DataSources struct {
OciDataSources []Source
OciRegistryDataSources []Source
// NOTE: Git data sources should follow the URI scheme as defined in:
// https://spdx.github.io/spdx-spec/v2.3/package-information/#771-description
// <vcs_tool>+<transport>://<host_name>[/<path_to_repository>][@<revision_tag_or_branch>][#<sub_path>]
// e.g. git+https://github.com/guacsec/guac@v1
GitDataSources []Source
// NOTE: It is expected that a GithubReleaseDataSource is of the form:
// https://github.com/<org>/<repo>/releases/<tag> or
// https://github.com/<org>/<repo>/releases/tag/<tag> or
// https://github.com/<org>/<repo>/releases
// Tag is optional and left off will assume latest.
GithubReleaseDataSources []Source
// PurlDataSources encodes the list of PURLs
PurlDataSources []Source
}
Click to show internal directories.
Click to hide internal directories.