docs: improve documentation for total CPU mode, schedule overlap, and immutable fields#216
Merged
Merged
Conversation
…eduleSpec Mark targetResource and schedule as immutable after creation, and clarify that additionalProcessingUnits is the only field that can be updated in place. Changes are made via source comments so they are preserved across make docs regenerations. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
… metric-type switching - Add YAML example for targetCPUUtilization.total with a note explaining that highPriority and total are mutually exclusive, use different Cloud Monitoring metrics, and that switching between them skips one reconcile - Add note to the Scheduled scaling section explaining that additionalProcessingUnits from overlapping schedules are summed for both desiredMinPUs and desiredMaxPUs - Remove the duplicate metric-type switching note that was placed after the Examples section (now covered inline next to the total example) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
rustycl0ck
approved these changes
Apr 21, 2026
rustycl0ck
added
the
release/patch
|
A tag with version v0.7.2 has been created! 🎉 Changes: v0.7.1...v0.7.2 |
|
A new github release with version v0.7.2 has been created! 🎉 |
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.
What this PR does
Fills in documentation gaps that users were running into when adopting new features.
README
targetCPUUtilization.totalwith an inline note explaining:highPriorityandtotalare mutually exclusive and use different Cloud Monitoring metricsadditionalProcessingUnitsfrom overlapping schedules are summed for bothdesiredMinPUsanddesiredMaxPUstotalexample)CRD reference (
docs/crd-reference.md)Updated via source comments in
api/v1beta1/spannerautoscaleschedule_types.go(regenerated withmake docs) to preserve changes across future regenerations:targetResourceandscheduleas immutable after creation inSpannerAutoscaleScheduleSpecadditionalProcessingUnitsis the only field that can be updated in placeTest plan
make docsregeneratesdocs/crd-reference.mdcorrectly with the new descriptions🤖 Generated with Claude Code