Skip to content

docs: note S3-compatible object storage for Tiered Storage - #1856

Draft
goanpeca wants to merge 1 commit into
redpanda-data:mainfrom
goanpeca:docs/s3-compatible-storage
Draft

docs: note S3-compatible object storage for Tiered Storage#1856
goanpeca wants to merge 1 commit into
redpanda-data:mainfrom
goanpeca:docs/s3-compatible-storage

Conversation

@goanpeca

Copy link
Copy Markdown

Description

Adds one NOTE to the "Configure object storage" step of the Tiered Storage partial (modules/manage/partials/tiered-storage.adoc), directly after the sentence listing the natively supported backends (Amazon S3, Google Cloud Storage, and Azure Blob Storage / Azure Data Lake Storage).

That sentence is the only guidance on the page about which object stores work, so a reader whose store is not one of those has no next step, even though Tiered Storage talks to object storage over the S3 API and the property reference already describes cloud_storage_url_style as the addressing style for S3-compatible object storage. The NOTE points at the two properties involved:

  • cloud_storage_api_endpoint for the provider endpoint, shown as the placeholder <s3-compatible-endpoint>.
  • cloud_storage_url_style, deferring to the provider's documentation for the value it requires, which mirrors the wording already in that property's own description.

No provider is named and no real endpoint is used. Both xrefs use the same reference:properties/object-storage-properties.adoc#<property> form already used in manage/partials/remote-read-replicas.adoc. The partial is not env-cloud gated, so the NOTE renders in both the Linux and Kubernetes versions of the Tiered Storage page. Nothing else in the partial changes.

Review deadline:

Page previews

Deploy preview links to be added once the Netlify build for this PR is available. Pages rendered from the edited partial:

  • manage/tiered-storage/ (updated)
  • manage/kubernetes/tiered-storage/k-tiered-storage/ (updated)

Checks

  • New feature
  • Content gap
  • Support Follow-up
  • Small fix (typos, links, copyedits, etc)

Signed-off-by: Gonzalo Peña-Castellanos <goanpeca@gmail.com>
@netlify

netlify Bot commented Jul 30, 2026

Copy link
Copy Markdown

Deploy Preview for redpanda-docs-preview ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 8b86218
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-docs-preview/deploys/6a6bae6a0348dc00076fc956
😎 Deploy Preview https://deploy-preview-1856--redpanda-docs-preview.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.

@coderabbitai

coderabbitai Bot commented Jul 30, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 793ea473-ca62-47c5-be95-357fe89b6621

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

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.

1 participant