docs: note S3-compatible object storage for Tiered Storage - #1856
docs: note S3-compatible object storage for Tiered Storage#1856goanpeca wants to merge 1 commit into
Conversation
Signed-off-by: Gonzalo Peña-Castellanos <goanpeca@gmail.com>
✅ Deploy Preview for redpanda-docs-preview ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
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 |
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_styleas the addressing style for S3-compatible object storage. The NOTE points at the two properties involved:cloud_storage_api_endpointfor 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 inmanage/partials/remote-read-replicas.adoc. The partial is notenv-cloudgated, 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