all: Remove 16k IOPS recommendation#1719
Conversation
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
📝 WalkthroughWalkthroughThis PR restructures Redpanda storage performance documentation by removing explicit 16,000 IOPS minimum thresholds and reorganizing guidance across three files. The core requirements document now emphasizes NVMe-based storage, specifies XFS/ext4 filesystem mounting for data directories and Tiered Storage cache, notes Kubernetes volume type support, and warns against NFS. The production readiness checklist adds NVMe storage class requirements, while the self-test documentation is simplified to reference the benchmarks rather than prescribe a specific IOPS threshold. Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
micheleRP
left a comment
There was a problem hiding this comment.
Critical issues (must fix)
-
[
modules/deploy/pages/redpanda/kubernetes/k-production-readiness.adoc:530–531] Two sibling bullets in the same "Storage performance requirements" section still reference the recommendation this PR removes. With the 16,000 IOPS bullet gone, these read as dangling references:- Line 530:
* Consider provisioned IOPS where available to meet or exceed the minimum— what minimum? No minimum is defined on this page anymore. - Line 531:
* Enable xref:develop:manage-topics/config-topics.adoc#configure-write-caching[write caching] to help Redpanda perform better in environments with disks that don't meet the recommended IOPS— what recommendation?
Fix: Rewrite both bullets so they stand alone without referring to a removed number. Suggested rewordings:
- Line 530 →
* Consider provisioned IOPS where available to guarantee consistent storage performance - Line 531 →
* Enable xref:develop:manage-topics/config-topics.adoc#configure-write-caching[write caching] to improve performance on storage with limited IOPS
Alternatively, delete both bullets if they were only meaningful in the context of the 16k threshold.
- Line 530:
Suggestions (should consider)
-
[
modules/deploy/partials/self-test.adoc] After this removal, the partial is reduced to two short paragraphs — an intro sentence and a single xref — under an H1= Perform a self test. The partial is included withleveloffset=+1into three deployment pages (dev-deployment.adoc,production-deployment.adoc,k-production-deployment.adoc), where it renders as an H2 section with no actionable guidance. Consider either:- Retiring the partial and inlining the single xref at the three call sites, or
- Renaming the heading to something like
= Verify storage performanceso it still matches the (now thinner) content.
Not blocking — the partial still renders correctly, but it's become very thin.
This minimum performance recommendation was fairly arbitrary and doesn't really work in practice. Remove it everywhere it's mentioned.
02289f1 to
6e830d5
Compare
|
Have deleted the extra k8s bullet points. Left the other thing. |
micheleRP
left a comment
There was a problem hiding this comment.
looks great, thanks for the PR @StephanDollberg!
This minimum performance recommendation was fairly arbitrary and doesn't really work in practice.
Remove it everywhere it's mentioned.
Description
Resolves https://redpandadata.atlassian.net/browse/
Review deadline:
Page previews
Checks