Skip to content

docs: explain S3 event message-provider flags - #294

Open
erenbati wants to merge 2 commits into
guacsec:mainfrom
erenbati:docs/s3-message-provider-flags-270
Open

erenbati wants to merge 2 commits into
guacsec:mainfrom
erenbati:docs/s3-message-provider-flags-270

Conversation

@erenbati

@erenbati erenbati commented Oct 25, 2026 •

Copy link
Copy Markdown
Contributor

Closes #270

Summary

  • Add a standalone guide for S3 event-notification polling through Kafka and Amazon SQS.
  • Document --s3-mp, --s3-mp-endpoint, --s3-queues, and related bucket/region options.
  • Provide examples using guacone collect s3 --poll for both Kafka and SQS.
  • Clarify the distinction between guacone polling and guaccollect s3 --service-poll, as well as the currently supported SQS ObjectCreated:Put event.

Validation

  • Verified command options and default values against GUAC's CLI flag store.
  • Checked Kafka/SQS option validation and notification handling against the GUAC S3 collector and message provider source.
  • The current PR head passed GitHub Actions formatting CI and the Netlify deploy preview.
  • Documentation-only change; no live Kafka or SQS integration test was run.

AI assistance

AI assistance was used to prepare this documentation. The contributor reviewed the content against the source and remains responsible for it.

Signed-off-by: Eren Batı <243848222+erenbati@users.noreply.github.com>
Signed-off-by: Eren Batı <243848222+erenbati@users.noreply.github.com>
@netlify

netlify Bot commented Oct 25, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for resonant-wisp-1a517a ready!

Name Link
🔨 Latest commit c78bd5b
🔍 Latest deploy log https://app.netlify.com/projects/resonant-wisp-1a517a/deploys/6add82ecdaaf84da26ef8a2f
😎 Deploy Preview https://deploy-preview-294--resonant-wisp-1a517a.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@gittuf-app-beta

Copy link
Copy Markdown

Observed review from mihaimaruseac+323199 (@mihaimaruseac)

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document S3 message-provider flags (--s3-mp, --s3-mp-endpoint, --s3-queues)

2 participants