Document SBOM ingestion; also mentioned daemon ingestion #168
+46
−0
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
Signed-off-by: Ritesh <[email protected]>
✅ Deploy Preview for resonant-wisp-1a517a ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Signed-off-by: Ritesh <[email protected]>
There was a problem hiding this comment.
It's off to a good start. As in your other PR, let's add a table of command line options and replace the top line with something like
---
layout: page
title: Ingesting SBOMs into GUAC
permalink: /ingesting-sboms/
---
I suggest renaming the file to sbom-ingestion.md as well.
guac-SBOM-ingestion.md
Outdated
| - You can send SBOMs directly to GUAC using its API. | ||
| - Example API request: | ||
| ```bash | ||
| curl -X POST -F "[email protected]" http://guac-server/v0/ingest |
There was a problem hiding this comment.
What's the source for this? This does not work on my local GUAC instance.
guac-SBOM-ingestion.md
Outdated
| ### Recommended Configuration for Daemon Mode | ||
|
|
||
| To use daemon-mode ingestion effectively, ensure the following: | ||
| 1. **Install and configure** the appropriate collectors (e.g., GCS, GitHub, or local directory collectors). |
There was a problem hiding this comment.
The collectors are built-in
guac-SBOM-ingestion.md
Outdated
Comment on lines
68
to
77
| ### Recommended Configuration for Daemon Mode | ||
|
|
||
| To use daemon-mode ingestion effectively, ensure the following: | ||
| 1. **Install and configure** the appropriate collectors (e.g., GCS, GitHub, or local directory collectors). | ||
| 2. **Configure polling intervals** to balance between frequency and system load. | ||
| 3. **Verify connectivity** between GUAC and the data source to avoid ingestion delays. | ||
|
|
||
| Example of starting GUAC in daemon mode: | ||
| ```bash | ||
| guac-server --config /path/to/config.yaml --daemon |
There was a problem hiding this comment.
Again, this command is not a binary that we ship. See guacsec/guac#1005 (comment)
guac-SBOM-ingestion.md
Outdated
Comment on lines
80
to
88
| --- | ||
|
|
||
| ### Conclusion | ||
|
|
||
| SBOM ingestion in GUAC supports both **manual and automated** workflows: | ||
| - **Manual ingestion** is suited for individual files and testing. | ||
| - **Daemon-mode ingestion** allows for **automatic polling** from collectors like GCS. | ||
|
|
||
| With both options available, GUAC can integrate seamlessly into various workflows, from CI/CD pipelines to periodic compliance checks. |
There was a problem hiding this comment.
This section is unnecessary.
Signed-off-by: Ritesh <[email protected]>
|
Signed-off-by: Ritesh <[email protected]>
funnelfiasco
requested changes
Oct 30, 2024
sbom-ingestion.md
Outdated
Comment on lines
35
to
46
| 2. **Daemon-Mode Ingestion (Polling Collectors)**: | ||
| - When configured, GUAC operates in **daemon mode**, using collectors (like GCS) to poll for new SBOMs at regular intervals. | ||
| - **How to Enable Daemon Mode**: | ||
| - Set up a configuration file specifying the collector sources. | ||
| - Example of a collector config: | ||
| ```yaml | ||
| collectors: | ||
| - type: gcs | ||
| bucket: my-sbom-bucket | ||
| pollingInterval: 5m | ||
| ``` | ||
| - Once activated, GUAC will **automatically fetch and ingest** SBOMs from the specified source. |
There was a problem hiding this comment.
What's your source for that example collector config? It doesn't line up with the comment I left in the last round of review.
Signed-off-by: Ritesh <[email protected]>
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.
Closes #140
Closes #142