Skip to content

DOC-14: document Cloud topic segment size default#626

Open
micheleRP wants to merge 2 commits into
mainfrom
DOC-14-cloud-segment-size-default
Open

DOC-14: document Cloud topic segment size default#626
micheleRP wants to merge 2 commits into
mainfrom
DOC-14-cloud-segment-size-default

Conversation

@micheleRP

@micheleRP micheleRP commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

Resolves DOC-14.

What

Adds a Segment size row to the topic-properties table on the Cloud "Topics Overview" page (modules/develop/pages/topics/create-topic.adoc).

Why

Redpanda Cloud sets log_segment_size to 128 MiB at the cluster level, unlike self-managed Redpanda (1 GiB). This Cloud-specific default was not documented anywhere in cloud-docs, so Cloud users relying on the self-managed default were misinformed. Verified against cloudv2 main (install-pack fixtures, cluster-config runbook).

Note for reviewers

The per-tier min/max are intentionally described as "limits that depend on your cluster tier" rather than hardcoded. install-pack/generate-tiers.py (max = tier default) and the install-pack fixtures (max 256 MiB, min 16 MiB) disagree, so the exact range isn't reliable across tiers. Recommend confirming the min/max with the Cloud team before stating explicit numbers.

Preview pages

🤖 Generated with Claude Code

@netlify

netlify Bot commented Jul 1, 2026

Copy link
Copy Markdown

Deploy Preview for rp-cloud ready!

Name Link
🔨 Latest commit 324b01a
🔍 Latest deploy log https://app.netlify.com/projects/rp-cloud/deploys/6a512cb9ee98480007154f86
😎 Deploy Preview https://deploy-preview-626--rp-cloud.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 1, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 48d31f11-1f25-4251-ab14-a3f28032de3b

📥 Commits

Reviewing files that changed from the base of the PR and between 191269d and 324b01a.

📒 Files selected for processing (1)
  • modules/develop/pages/topics/create-topic.adoc

📝 Walkthrough

Walkthrough

Adds a “Segment size” row to the topic properties table. The documentation describes the log segment maximum size, Redpanda’s behavior when the limit is reached, the 128 MiB cluster-level default, and per-topic overrides through segment.bytes, subject to tier-dependent limits.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested reviewers: mattschumpert, kbatuigas, Feediver1

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly matches the change: documenting the Cloud topic segment size default.
Description check ✅ Passed The description is detailed and relevant, though it omits the review deadline and explicit checklist selections from the template.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch DOC-14-cloud-segment-size-default

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

Add a Segment size row to the Cloud topic-properties table. Redpanda
Cloud sets log_segment_size to 128 MiB at the cluster level, unlike
self-managed Redpanda (1 GiB), and this was not documented anywhere in
cloud-docs. The per-tier min/max are intentionally described as
tier-dependent rather than hardcoded, pending Cloud-team confirmation.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@micheleRP micheleRP force-pushed the DOC-14-cloud-segment-size-default branch from 73f7e50 to 1e39014 Compare July 10, 2026 17:30
@micheleRP micheleRP marked this pull request as ready for review July 10, 2026 17:33
@micheleRP micheleRP requested a review from a team as a code owner July 10, 2026 17:33
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