docs: pipeline: outputs: s3: document S3-compatible endpoints - #2638
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe S3 output documentation now describes endpoint schemes and ports, S3-compatible object stores, path-style requests, and signing with the configured region. ChangesS3 endpoint documentation
Estimated code review effort: 1 (Trivial) | ~2 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
- use documented examples in endpoint description Signed-off-by: Gonzalo Peña-Castellanos <goanpeca@gmail.com> Signed-off-by: Eric D. Schabell <eric@schabell.org>
39f395a to
61cdd12
Compare
|
@goanpeca I've fixed the lint / vale issues, removing draft status as confirmed the fix is good. I'll review now. |
The
endpointdescription in the configuration parameters table doesn't say what a custom endpoint is for, even though the page later shows MinIO and Google Cloud examples that rely on it. This expands the description to state thatendpointpoints the S3 output at an S3-compatible object store other than Amazon S3, and adds the two behaviors that matter when you do that.Both behaviors come from the plugin source.
s3_put_objectbuilds the request URI as/<bucket><key>whilecb_s3_initsets the client host to the configured endpoint, so requests are always path-style rather than virtual-hosted.cb_s3_initalso setss3_client->regionfromregion, whichflb_signv4_doinsrc/aws/flb_aws_util.cuses for the SigV4 credential scope, soregionstill matters when the endpoint isn't an AWS one.No other changes: the parameter table stays alphabetical and the existing MinIO and Google Cloud sections are untouched.
Summary by CodeRabbit