docs: sync Pool -> StoragePool CRD rename and maxLogicalVolumeCount -> maxSubsystemCount - #195
Merged
Merged
Conversation
Contributor
|
🤖: Deployment available as https://docstest.simplyblock.io/docs-rename-pool-to-storagepool-crd |
boddumanohar
marked this pull request as ready for review
August 21, 2026 15:31
boddumanohar
force-pushed
the
docs/rename-pool-to-storagepool-crd
branch
from
August 21, 2026 15:33
3e12104 to
42366d0
Compare
Contributor
|
🤖: Deployment available as https://docstest.simplyblock.io/docs-rename-pool-to-storagepool-crd |
…> maxSubsystemCount Matches simplyblock-operator#413 (field rename) and #414 (CRD kind rename), both merged into operator main. Regenerated docs/reference/operator/reference.md via scripts/operator-reference-gen.sh against operator main, isolating just the delta these two changes introduce (the checked-in reference.md is separately behind operator main by other unrelated merged PRs, left untouched here). Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…ence The Pool -> StoragePool rename is correct and kept. Three problems in the accompanying changes are fixed here, all verified against the operator CRDs in simplyblock-operator (operator/api/v1alpha1, operator/config/crd/bases). maxSubsystemCount is a required field on StorageCluster only. It is not part of StorageNodeSetSpec or StorageNodeOverrides, so renaming the removed maxLogicalVolumeCount to it moved a valid field onto the wrong CRDs. Because CRDs prune unknown fields, those manifests would have applied cleanly and silently done nothing. The field is removed from the StorageNodeSet and StorageNode examples instead. partitions and corePercentage do not exist on StorageNodeSet either and were already removed from the operator reference on main. They are dropped from the expansion examples as well. The StoragePool section appended to docs/reference/operator/reference.md was a byte-identical duplicate of the section already generated on main, which gave the page two #storagepool anchors. That file is generated and is reverted; it is regenerated with scripts/operator-reference-gen.sh, never edited by hand. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
noctarius
force-pushed
the
docs/rename-pool-to-storagepool-crd
branch
from
August 21, 2026 16:14
42366d0 to
66730f6
Compare
Contributor
|
🤖: Deployment available as https://docstest.simplyblock.io/docs-rename-pool-to-storagepool-crd |
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.
Summary
Syncs the documentation with two CRD changes merged into
simplyblock-operatormain:kind: Pool->kind: StoragePool(simplyblock-operator#414)maxLogicalVolumeCount->maxSubsystemCount(simplyblock-operator#413)Files changed:
docs/reference/operator/reference.md— regenerated viascripts/operator-reference-gen.shagainst operator main, but scoped to only the delta these two PRs introduce. The checked-in reference is separately behind operator main by other, unrelated already-merged PRs (e.g. the ClusterOps CR work, failure-domain changes) — those are out of scope here and left untouched to keep this diff focused.docs/reference/operator/index.md— hand-written overview:PoolCRD table row/example/anchors,maxLogicalVolumeCountexample values and overrides table.docs/kubernetes/installation/k8s-storage-plane.md— storage pool creation walkthrough (kind: Poolexample,maxLogicalVolumeCount, and a stalekubectl get simplyblockpoolcommand corrected to the actual resource namekubectl get storagepools).docs/kubernetes/operations/scaling/expanding-storage-cluster.md—maxLogicalVolumeCountin node-expansion examples.Note:
deployment/(the built, versioned doc site) is CI-managed viadoc-builder deployand is not hand-edited here.Test plan
./doc-builder serve) for the changed pages.docs/reference/operator/reference.mdrenders cleanly and cross-references (#storagepool,#storagepoolspec) resolve.🤖 Generated with Claude Code