Clarify Pool-generated StorageClass parameters, drop dead ndcs/npcs - #194
Merged
Conversation
Contributor
|
🤖: Deployment available as https://docstest.simplyblock.io/docs-pool-storageclass-crd-changes |
…cs/npcs Pool.spec.storageClassParameters values are copied verbatim into the auto-generated StorageClass and are immutable once the pool is created (simplyblock/simplyblock-operator#409), so document that explicitly instead of leaving the relationship implicit. Also remove distr_ndcs/distr_npcs from the StorageClass parameter reference: the CSI driver dropped per-volume erasure coding overrides (simplyblock/simplyblock-csi#440), and the erasure coding schema is fixed at cluster creation, matching what's already documented elsewhere (cluster deployment options, Linux initiators). Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…apping The StoragePool CRD fields are camel case, the StorageClass parameters the CSI driver reads are snake_case, and `filesystem` maps to the well-known `csi.storage.k8s.io/fstype` key. That mapping (mergeStorageClassParameters in operator/internal/controller/simplyblockstoragepool_controller.go) was not documented anywhere, so the link promising a "full parameter mapping" had nothing to point at. Also note the operator-added `dhchap_node_label` for DHCHAP pools. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
noctarius
force-pushed
the
docs/pool-storageclass-crd-changes
branch
from
August 21, 2026 16:21
c605b04 to
13bd150
Compare
Contributor
|
🤖: Deployment available as https://docstest.simplyblock.io/docs-pool-storageclass-crd-changes |
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
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
Pool.spec.storageClassParametersis copied verbatim into the auto-generated StorageClass and is immutable once the pool is created (fix: make StorageClassParameters immutable instead of silently ignoring edits simplyblock-operator#409).distr_ndcs/distr_npcsfrom the StorageClass parameter reference — the CSI driver dropped per-volume erasure coding overrides (Remove ndcs and npcs from volume create API simplyblock-csi#440); the schema is fixed at cluster creation, matching what's already documented in cluster deployment options and the Linux initiators guide.Test plan
./scripts/quality-gate.sh(voice, prose, terminology, American English, punctuation, mkdocs syntax) passes clean for both changed files