Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add ability to enable or disable individual catalogers #1731

Closed
kzantow opened this issue Apr 11, 2023 · 1 comment · Fixed by #1383
Closed

Add ability to enable or disable individual catalogers #1731

kzantow opened this issue Apr 11, 2023 · 1 comment · Fixed by #1383
Assignees
Labels
enhancement New feature or request

Comments

@kzantow
Copy link
Contributor

kzantow commented Apr 11, 2023

What would you like to be added:
The ability to enable or disable individual catalogers.

Why is this needed:
Today Syft has two different default lists of catalogers: one for image scans and one for directory scans. These have some overlap, but also result in certain catalogers not being run in certain contexts. Syft also has the ability to specify all the catalogers using the catalogers: yaml option, SYFT_CATALOGERS env var, and --catalogers command-line flag, but this requires the user to know all the catalogers they want to run. If a user sets this and Syft adds more catalogers, these do not get run until the user updates the Syft config/invocation they are using.

Additional context:
I believe it's at least as useful to be able to be able to explicitly disable a cataloger (for example, one causing a problem) or enable a cataloger that isn't part of the default set.

My current proposal is to update the --catalogers flag and other configurations to allow each cataloger to be prefixed by a + or -, which would enable and disable the cataloger, respectively. If all catalogers specified in the configuration are additions or removals, the default set of catalogers is used for the scan while having the set supplemented by the + additions and the - entries removed.

This should make configuration significantly easier for a large number of use cases.

@robszumski
Copy link

+1. My use-case is doing image scanning, but I want to enable the package-lock cataloger instead of just package. I don't really want to track an entire set of catalogers, when new ones may be added in the future that are useful to me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants