docs: add cluster autoscaling guide - #38799
Open
maheshwarip wants to merge 2 commits into
Open
Conversation
Adds a task-oriented guide under Clusters for AUTO SCALING STRATEGY (ON HYDRATION): configuring it, monitoring an in-flight burst, what happens if the steady-size replica never hydrates (no timeout, burst stays up indefinitely), and what happens if capacity is unavailable on Self-Managed (best-effort, never blocks the steady replicas). Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01XqmZ4Mb6edy9y3uLhtAKQK
The headless fragment linked to a bare #available-sizes anchor, which only resolves on pages that happen to define that heading themselves (create-cluster.md, alter-cluster.md). Including the fragment on the new autoscaling guide broke both links, since that page has no such heading. Point at /sql/create-cluster/#available-sizes instead, matching every other cross-reference to that heading in the docs. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01XqmZ4Mb6edy9y3uLhtAKQK
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
Closes EDU-82:
AUTO SCALING STRATEGY (ON HYDRATION)is documented piecemeal acrossCREATE CLUSTER/ALTER CLUSTER, but there was no task-oriented guide in the Clusters section, and two operational questions (steady-state replica never hydrates, capacity unavailable on Self-Managed) weren't answered anywhere user-facing.Description
New guide:
doc/user/content/clusters/autoscaling.md(linked fromclusters/_index.md).headless/cluster-hydration-burstfragment for the mechanism, so nothing is duplicated withCREATE CLUSTER/ALTER CLUSTER.ALTER CLUSTERform for adding/removing the strategy on an existing cluster.mz_cluster_auto_scaling_strategies,SHOW CLUSTERSactivity column,mz_hydration_statuses, audit log.doc/developer/design/20260522_cluster_autoscaling.mdand theHydrationBurstStrategysource comments); links to resizing the cluster.Pages for review:
Verification
hugo --quiet(extended v0.123.7) builds cleanly fromdoc/user, both the HTML output and the--config config.toml,config.skill.tomlMarkdown/skill output.ZgotmplZescapes, and every internal link/anchor referenced from the new page resolves to an existing page or heading.SHOW CLUSTERSand catalog-query examples againsttest/testdrive/cluster-controller.tdandtest/sqllogictest/show_clusters.slt.🤖 Generated with Claude Code
https://claude.ai/code/session_01XqmZ4Mb6edy9y3uLhtAKQK
Generated by Claude Code