Skip to content

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

Merged
micheleRP merged 3 commits into
mainfrom
DOC-14-cloud-segment-size-default
Jul 15, 2026
Merged

DOC-14: document Cloud topic segment size default#626
micheleRP merged 3 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

Updates the Segment size row in the topic-properties table on the Cloud "Topics Overview" page (modules/develop/pages/topics/create-topic.adoc) to describe segment size qualitatively, without citing a specific value or tier-dependent limits.

Why

DOC-14 flagged that Cloud users could mistake the self-managed segment size default (1 GiB) for their Cloud value. The fix clarifies that Cloud differs, without publishing a Cloud number:

  • Cloud segment size is set per cluster config profile, not a fixed 128 MiB "cluster default."

The row now states that Redpanda Cloud sets the segment size automatically and that users can override it per topic with the segment.bytes property, with no specific 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 50f1541
🔍 Latest deploy log https://app.netlify.com/projects/rp-cloud/deploys/6a567ea5e70e8d0008f9e41a
😎 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

📝 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
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.
Title check ✅ Passed The title clearly matches the change: documenting the Cloud topic segment size default.
Description check ✅ Passed It includes the issue link, what/why, and a preview, with only minor template omissions like review deadline and checks.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 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
@simonlord simonlord requested a review from travisdowns July 13, 2026 09:08
Cloud segment size is set per cluster config profile, not the 128 MiB
"cluster default" previously stated (customers never see that value).
With customer scaling replacing fixed tiers, describe segment size
qualitatively instead of citing a number or tier-dependent limits.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Comment thread modules/develop/pages/topics/create-topic.adoc
@micheleRP micheleRP merged commit 4824c0b into main Jul 15, 2026
6 checks passed
@micheleRP micheleRP deleted the DOC-14-cloud-segment-size-default branch July 15, 2026 17:08

@Feediver1 Feediver1 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

PR Review: DOC-14: document Cloud topic segment size default (#626)

Files reviewed: 1 .adoc file (modules/develop/pages/topics/create-topic.adoc)
Overall assessment: Clean, well-scoped change that closes a real content gap. One cross-repo inconsistency surfaces on a directly linked page and should be fixed in the docs repo, otherwise ready to merge.

What this PR does

Adds a Segment size row to the topic-properties table on the Cloud "Topics Overview" page. The row explains what a log segment is, states that Redpanda Cloud sets segment size automatically (deliberately without publishing a number, since the value comes from per-cluster config profiles), and notes the per-topic override via segment.bytes.

Jira ticket alignment

Ticket: DOC-14 — Document alternative segment size defaults in Redpanda Cloud
Status: Substantially addressed, with one deliberate divergence and one remaining scope item:

  • The ticket asks to document the specific Cloud values (128 MiB default, 16–256 MiB bounds). The PR intentionally omits all numbers because Cloud now sets segment size per cluster config profile and customer scaling is replacing fixed tiers. This is documented in the PR body and commit history, and the SME approved — reasonable divergence, but the ticket resolution comment should record why no numbers were published.
  • The ticket's original example — the self-managed disk-utilization page citing the 1 GiB default with no Cloud caveat — lives in the docs repo (modules/manage/pages/cluster-maintenance/disk-utilization.adoc) and is untouched. It doesn't render in cloud-docs, so it's arguably out of scope here, but DOC-14 shouldn't be closed as fully resolved without deciding whether that page needs a "Cloud differs" note.

Critical issues (must fix)

None in the changed file itself. But see the cross-repo finding below — it contradicts this PR's content on a page one click away.

Suggestions (should consider)

  1. [create-topic.adoc: Segment size row] Every other row with configurable behavior states its default in bold ("The default is 20 MiB…"). This row can't cite a number, which is correct — but consider making the absence explicit, e.g. "The default depends on your cluster configuration," so readers don't assume the omission is an oversight. Optional; the current wording is acceptable.

Impact on other files

  • docs repo, modules/develop/pages/manage-topics/config-topics.adoc (lines 306–334): The ifdef::env-cloud[] example output for rpk topic describe — which renders on the Cloud Manage Topics page, the first "Next steps" link from the page this PR edits — shows segment.bytes 1073741824 DEFAULT_CONFIG. That tells Cloud users their default segment size is 1 GiB, contradicting both this PR ("Redpanda Cloud sets the segment size for your cluster automatically") and actual Cloud behavior. The Cloud-gated example block appears to have been copied from the self-managed example without adjusting values. This needs a follow-up PR in the docs repo (the page is single-sourced into cloud-docs), either correcting the value or removing the segment.bytes line from the example.
  • No What's New entry needed (clarification, not a feature), no nav or xref impact (no new or moved pages).

What works well

  • The qualitative framing ("set automatically… override with segment.bytes") is future-proof against config-profile changes, and the decision not to publish numbers is well documented in the commit messages.
  • The two-sentence structure (what a segment is, then the Cloud behavior) matches the pattern of the other table rows, and voice/tense/terminology are all compliant.
  • The intermediate commits show the 1 GiB comparison and tier-dependent limits were consciously removed, not forgotten — good revision hygiene.

🤖 Generated with Claude Code

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.

3 participants