Included docs for GUACCollect #121
Open
Conversation
This file contains 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
* Fixes guacsec#120 * I used an image of the mermaid diagram because I don't know whether guac-docs supports mermaid diagrams Signed-off-by: nathannaveen <[email protected]>
✅ Deploy Preview for resonant-wisp-1a517a ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
lumjjb
approved these changes
Mar 29, 2024
|
|
||
| # Ingesting data with GUACCollect | ||
|
|
||
| GUACCollect is a command-line tool within the GUAC ecosystem designed for collecting and ingesting software bill of materials (SBOMs), attestations, and other metadata documents from various sources. This tool supports a wide range of data sources, including GitHub, S3, Google Cloud Storage (GCS), and OCI images, making it a versatile choice for enhancing the visibility and security of your software supply chain. |
There was a problem hiding this comment.
nit: guaccollect to match case (and use ` ticks to indicate code)
|
|
||
| - A fresh copy of the [GUAC service infrastructure through Docker Compose]({{ | ||
| site.baseurl }}{%link setup.md %}). Including the `guacone` binary in your path | ||
| and [GUAC Data](https://github.com/guacsec/guac-data/archive/refs/heads/main.zip) |
There was a problem hiding this comment.
hmm, i think we usually recommend cloning GUAC data instead of unzipping - is this a different dataset?
| - **Download from OCI Images**: Retrieve SBOMs and attestations embedded in OCI images. | ||
| - **File System Collection**: Collect documents directly from a specified file path on your system. | ||
|
|
||
| ## Usage |
There was a problem hiding this comment.
could be helpful to also add some information about the poll option
|
@nathannaveen can you fix the formatter issues (and optionally address Brandon's minor feedback) so we can merge this? I'd also suggest adding the source of your image (as an SVG or the mermaid file or whatever you used to create it) into the repo somewhere so that we can update it later if needed. |
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.
guaccollectdocumentation #120