Skip to content

docs: note S3-compatible endpoints for s3 storage backend - #5259

Open
goanpeca wants to merge 4 commits into
kestra-io:mainfrom
goanpeca:docs/s3-compatible-storage
Open

docs: note S3-compatible endpoints for s3 storage backend#5259
goanpeca wants to merge 4 commits into
kestra-io:mainfrom
goanpeca:docs/s3-compatible-storage

Conversation

@goanpeca

Copy link
Copy Markdown

Adds a short "S3-compatible endpoints" subsection to the internal storage docs, under the existing s3 backend options table.

  • Notes that the s3 backend targets Amazon S3 by default and that endpoint repoints it at another S3-compatible store (Backblaze B2, Cloudflare R2, MinIO).
  • Adds a YAML snippet with endpoint plus force-path-style, using a placeholder endpoint.
  • Links to the existing type: minio backend for MinIO deployments.

Docs only, no config or behaviour change.

Signed-off-by: Gonzalo Peña-Castellanos <goanpeca@gmail.com>
@MilosPaunovic
MilosPaunovic requested a review from aj-emerich July 31, 2026 05:32
@MilosPaunovic MilosPaunovic added area/docs Issues related to documentation, plugin examples, blueprints, and guides kind/external Pull requests raised by community contributors labels Jul 31, 2026
@github-project-automation github-project-automation Bot moved this to To review in Pull Requests Jul 31, 2026
@MilosPaunovic

Copy link
Copy Markdown
Member

Is this ready to be reviewed @goanpeca, or is there a reason why it's still in draft?

@goanpeca
goanpeca marked this pull request as ready for review August 4, 2026 20:41
Copilot AI lite review requested due to automatic review settings August 4, 2026 20:41
@goanpeca

goanpeca commented Aug 4, 2026

Copy link
Copy Markdown
Author

No reason, that was my mistake @MilosPaunovic. It is ready, and I have marked it out of draft.

The change notes that the s3 storage backend's existing endpoint setting lets it target any store implementing the S3 API, not only Amazon S3, which the page did not previously state. Docs-only.

Related: I also have a small code PR open on kestra-io/storage-s3#230 that tags the plugin's S3 client user agent. Independent of this one, but same area if you want to look at both.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds an “S3-compatible endpoints” note to the internal storage documentation to clarify how the existing type: s3 backend can be pointed at non-AWS, S3-compatible object stores via endpoint (and sometimes force-path-style), while also pointing readers to the dedicated type: minio backend for MinIO deployments.

Changes:

  • Adds a new “S3-compatible endpoints” subsection under the AWS S3 storage backend docs.
  • Documents using endpoint (and force-path-style) to target S3-compatible providers (e.g., Backblaze B2, Cloudflare R2, MinIO).
  • Includes a YAML configuration snippet and cross-links to the existing MinIO backend section.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

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

Labels

area/docs Issues related to documentation, plugin examples, blueprints, and guides kind/external Pull requests raised by community contributors

Projects

Status: To review

Development

Successfully merging this pull request may close these issues.

4 participants