DOC-1860: Cluster sizing, tier migration, and user scaling GA docs#642
DOC-1860: Cluster sizing, tier migration, and user scaling GA docs#642micheleRP wants to merge 2 commits into
Conversation
Consolidated doc update for the cluster sizing and scaling initiative (DOC-1860, DOC-1375, DOC-940, DOC-1861 provisioning half; DOC-1133 API section stubbed for separate ownership): - manage/maintenance.adoc: new Tier migrations section (DOC-1375) - reference/partials/tiers.adoc: guidance (up to) framing and machine types/RPU concept for BYOC tiers (DOC-940) - get-started/.../byoc/size-byoc-cluster.adoc: new page for the workload-based sizing and pricing calculator, UI + Control Plane API (DOC-1861) - manage/cluster-maintenance/scale-cluster.adoc: new page for self-service horizontal/vertical scaling, prepared for user scaling GA (DOC-1860, ENG-928); merge with the GA release - BYOC create pages: pointer to workload-based sizing - terraform-provider.adoc: tier-migration cross-link and GA revision note for the throughput_tier warning - whats-new-cloud.adoc: scaling GA entry under a placeholder month; sizing calculator entry drafted in a comment pending rollout confirmation TODO(eng)/TODO(ux)/TODO(api) comments mark items to verify before merge. Keep the PR in draft until ENG-928 ships. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
✅ Deploy Preview for rp-cloud ready!
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 Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
|
Thanks in advance for the SME review. This PR stays in draft until ENG-928 (User Scaling GA) ships, but the content is ready for full review now. Suggested focus areas:
Inline TODO comments in the source mark everything unverified. Full context and merge checklist are in the PR description. |
Per Denis Coady (Cloud PM, Slack 2026-07-20): customers should size and resize clusters with the workload calculator rather than reasoning in tiers or RPUs. - tiers partial: lead with workload-based sizing for usage-based-billing orgs; reframe RPU as an internal unit resolved by the calculator; TODO(pm) on whether docs may state the tier phase-out - size-byoc-cluster: state workload-based sizing as the recommended path; scope manual RPU mode to users who already know their capacity - scale-cluster: TODO(eng) for the upcoming single load metric as the when-to-scale signal (cross-ref DOC-1381) Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
@deniscoady Following your thread in Slack yesterday (tiers phasing out, customers shouldn't reason in tiers or RPUs, calculator is the intended path): I've updated this PR to lead with workload-based sizing wherever the calculator is available and to reframe RPU as an internal unit the calculator resolves, rather than a concept customers learn. One open messaging question for you: how far should the published docs go on the tier phase-out?
Option 2 needs official deprecation comms behind it before we can publish (our docs standards require a citation for any maturity/deprecation claim). If a phase-out announcement is planned, we'd time the docs change to that. Which framing do you want? Also flagged in the source: the single load metric you mentioned as the future over/under-provisioning signal is marked as a TODO on the new Scale a BYOC Cluster page, to document once it ships. |
Summary
Consolidated doc update for the cluster sizing and scaling initiative. This PR covers how users assess how and why to scale a BYOC cluster: sizing at create time, tier migrations today, and self-service scaling at GA.
Tickets:
Scale a BYOC Clusterpage, whats-new entrymaintenance.adocSize and Price a BYOC Clusterpage (UI + Control Plane API), pointers from the three BYOC create pagesMerge gate
Keep this PR in draft until ENG-928 (User Scaling GA) ships. Working assumption (docs plan 2026-07-20): user scaling is not feature-gated at GA and applies to all BYOC clusters.
Before marking ready to merge:
Month TBDheading inwhats-new-cloud.adocwith the GA monthTODO(eng)items: tier-migration guardrails and duration (Nate Cole, ENG-450); guidance/enforcement wording and tier table accuracy (Travis Downs; confirm Tristan Stevens' DOC-940 hold is lifted); 24-broker limit and vertical-scaling client impact (Simon Lord, ENG-928)TODO(ux): verify the scale and sizing UI flows against the shipped productTODO(api): verify/v1beta2/sizingrequest/response fields against the published OpenAPI spec; document the GA scaling API surface (DOC-1133, Kat)enableSizingCalculatorrollout state, Julin/Denis)Review notes
🤖 Generated with Claude Code
Preview pages
partials/tiers.adoc)