docs: add configurable pipeline design proposal#3033
Open
Abhishek9639 wants to merge 1 commit into
Open
Conversation
Author
|
Hey @jeffmendoza or @mlieberman85, |
|
This pull request has been automatically marked as stale because it has not had recent activity (60 days of inactivity). |
Signed-off-by: Abhishek <abhishekup082@gmail.com>
9584a93 to
75fd526
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description of the PR
This PR adds a design proposal document for making the GUAC Collector-Certifier-Queryer pipeline configurable, as discussed in issue #1093.
Right now, running GUAC in production means spinning up a separate binary for every collector and certifier
guaccollect osv,guaccollect deps_dev,guaccollect scorecard, etc. That gets operationally heavy pretty quickly, especially for teams just getting started. On top of that, there's no way to look atguac.yamland understand what components are actually running the flat config doesn't map to individual components at all.The document in
proposals/configurable-pipeline.mdcaptures both of these problems clearly and sketches out a proposal: apipeline:block inguac.yamlwhere users can declare which collectors and certifiers are enabled, so eventually a singleguacone runcommand could bring up the whole pipeline from one config file.This is intentionally left as a work-in-progress proposal to gather feedback from the community before any implementation starts.
Fixes #1093
PR Checklist
-sflag togit commit.make generatehas been runmake generatehas been runmake generatehas been runcollectsubprotobuf has been changed,make protohas been run