Skip to content

Clarify Pool-generated StorageClass parameters, drop dead ndcs/npcs - #194

Merged
noctarius merged 2 commits into
mainfrom
docs/pool-storageclass-crd-changes
Aug 21, 2026
Merged

Clarify Pool-generated StorageClass parameters, drop dead ndcs/npcs#194
noctarius merged 2 commits into
mainfrom
docs/pool-storageclass-crd-changes

Conversation

@boddumanohar

Copy link
Copy Markdown
Member

Summary

Test plan

  • ./scripts/quality-gate.sh (voice, prose, terminology, American English, punctuation, mkdocs syntax) passes clean for both changed files

@github-actions

Copy link
Copy Markdown
Contributor

🤖: Deployment available as https://docstest.simplyblock.io/docs-pool-storageclass-crd-changes

@boddumanohar
boddumanohar requested a review from noctarius August 12, 2026 07:21
@boddumanohar boddumanohar self-assigned this Aug 21, 2026
boddumanohar and others added 2 commits August 21, 2026 18:17
…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
noctarius force-pushed the docs/pool-storageclass-crd-changes branch from c605b04 to 13bd150 Compare August 21, 2026 16:21
@noctarius
noctarius merged commit bedca49 into main Aug 21, 2026
3 checks passed
@noctarius
noctarius deleted the docs/pool-storageclass-crd-changes branch August 21, 2026 16:21
@github-actions

Copy link
Copy Markdown
Contributor

🤖: Deployment available as https://docstest.simplyblock.io/docs-pool-storageclass-crd-changes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants