feat: allow passing mkfs format options via storage class parameters #747

lukasmetzner · 2024-10-10T13:26:03Z

User can now pass format options directly to mkfs via storage class parameters for every fstype.

Older kernels might not be compatible with the mkfs.xfs options we set. As mkfs.xfs provides a default set of options for certain linux kernel lts versions we can choose the appropriate set of values by inspecting the current kernel version.

If we can find a suitable config we fall back to the most compatible version with older kernels.

BEGIN_COMMIT_OVERRIDE
feat: allow passing mkfs format options via storage class parameters (#747)
feat: change XFS default options to support older kernels (#747)
END_COMMIT_OVERRIDE

codecov · 2024-10-10T13:28:25Z

Codecov Report

Attention: Patch coverage is 25.00000% with 12 lines in your changes missing coverage. Please review.

Project coverage is 35.89%. Comparing base (0b6e860) to head (216294a).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
internal/volumes/mount.go	0.00%	12 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #747      +/-   ##
==========================================
- Coverage   35.96%   35.89%   -0.08%     
==========================================
  Files          19       19              
  Lines        1835     1850      +15     
==========================================
+ Hits          660      664       +4     
- Misses       1142     1153      +11     
  Partials       33       33

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

internal/volumes/mount.go

jooola

I am really unsure what the best way of configuring the xfs settings is.

I wrote a bunch of ideas, let me know what you think. I'd wait for Julian's input before merging this anyways :)

internal/volumes/mount.go

internal/volumes/utils.go

docs/kubernetes/README.md

internal/volumes/mount.go

dev/main.tf

docs/kubernetes/README.md

internal/volumes/mount.go

If all nodes in your cluster run the same kernel version, the CSI driver will automatically determine the correct `mkfs.xfs` options. However, if your cluster has nodes with different kernel versions, older nodes may fail to mount volumes created by newer kernels. To avoid this issue, you can set a minimum kernel version via `xfsMinSupportedKernel`. This ensures that all nodes use the appropriate `mkfs.xfs` defaults for maximum compatibility. The following strings are valid versions, but only the major, minor, and patch components are considered. If a major, minor, or patch version is not provided, it is evaluated as `0`.

After switching to the mount-utils library from k8s the xfs format options and fallback method have to be reimplemented.

Co-authored-by: Jonas L. <[email protected]>

Co-authored-by: Julian Tölle <[email protected]>

🤖 I have created a release *beep* *boop* --- ## [2.10.0](v2.9.0...v2.10.0) (2024-10-29) ### Features * add support & tests for Kubernetes 1.31 ([#721](#721)) ([85035b9](85035b9)) * allow arbitrary length API tokens ([#724](#724)) ([61c3a0e](61c3a0e)) * allow passing mkfs format options via storage class parameters ([#747](#747)) ([4b9aa4e](4b9aa4e)) * change XFS default options to support older kernels ([#747](#747)) ([4b9aa4e](4b9aa4e)) * drop tests for Kubernetes 1.27 ([#722](#722)) ([d46a54b](d46a54b)) * force pods with volumes to be scheduled on Cloud servers ([#743](#743)) ([702fe01](702fe01)) * fstype is directly passed to mkfs: mkfs.<fstype> ([#749](#749)) ([173bf2f](173bf2f)) * support for SELinux mount ([#756](#756)) ([719247e](719247e)), closes [#582](#582) * Support SINGLE_NODE_MULTI_WRITER capability ([#725](#725)) ([cd53c23](cd53c23)), closes [#327](#327) * **swarm:** removed workaround support for mock staging/unstaging ([#746](#746)) ([465ec21](465ec21)) ### Bug Fixes * do not log sensitive mount options ([#755](#755)) ([0b6e860](0b6e860)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).

lukasmetzner self-assigned this Oct 10, 2024

lukasmetzner linked an issue Oct 10, 2024 that may be closed by this pull request

Support a minimal node kernel version for the XFS options compatibility #690

Closed

lukasmetzner force-pushed the 690-support-a-minimal-node-kernel-version-for-the-xfs-options-compatibility branch from 94cd9cc to f258593 Compare October 10, 2024 13:29

jooola reviewed Oct 10, 2024

View reviewed changes

internal/volumes/mount.go Outdated Show resolved Hide resolved

lukasmetzner force-pushed the 690-support-a-minimal-node-kernel-version-for-the-xfs-options-compatibility branch from f457046 to 0215469 Compare October 11, 2024 14:52

jooola reviewed Oct 14, 2024

View reviewed changes

lukasmetzner force-pushed the 690-support-a-minimal-node-kernel-version-for-the-xfs-options-compatibility branch 7 times, most recently from 2d2c235 to 0e7173e Compare October 18, 2024 11:05

lukasmetzner marked this pull request as ready for review October 22, 2024 10:07

lukasmetzner requested a review from a team as a code owner October 22, 2024 10:07

lukasmetzner force-pushed the 690-support-a-minimal-node-kernel-version-for-the-xfs-options-compatibility branch 2 times, most recently from 6b9e25c to f34cea5 Compare October 22, 2024 10:13