Revise storage requirements in requirements.md#507
Merged
Conversation
Updated storage requirements to include details for 'posix' and 'decomposed' storage drivers, specifying filesystem compliance and additional requirements.
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates the storage requirements section in the requirements documentation to provide more specific and detailed information about different storage drivers (posix, decomposed, and decomposeds3), their filesystem requirements, and additional technical specifications.
- Restructured storage requirements with detailed driver-specific information
- Added filesystem compliance requirements for
posixanddecomposeddrivers - Specified additional requirements like atomic read-after-write consistency and extended attributes
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| | Storage | <ul><li>Local storage: Classic file storage on a local file system with POSIX compatibility (e.g., ext4, XFS, ZFS)</li><li>S3</li><li>NFS (mounted with NFS version 4.2 or later)</li><li>CephFS</li><li>GPFS</li></ul> | | ||
| | Server Operating System | <ul><li>Production: Linux</li><li>Testing and development: MacOS or Windows WSL</li></ul> | | ||
| | Database | <ul><li>None (OpenCloud stores files exclusively on the storage to minimize complexity and ensure maximum reliability)</li></ul> | | ||
| | Storage | <ul><li>The `posix` and `decomposed` storage drivers require:<ul><li>a fully POSIX compliant filesystem <ul><li> local e.g. ext4, XFS, ZFS</li><li>network e.g. CephFS, GPFS, NFS v4.2 or later</li></ul></li><li>atomic read after write consistency for directory metadata (NFS mount option `noac`)</li></ul></li><li>`decomposeds3` additionally requires an S3 bucket</li><li>`posix` requires extended attributes (offloading metadata >1KB into dedicated files)</li></ul> | |
There was a problem hiding this comment.
The parenthetical note '(offloading metadata >1KB into dedicated files)' is unclear. It's not immediately obvious what this means for administrators setting up the system. Consider rephrasing to something like 'supports extended attributes for storing metadata larger than 1KB' or providing a brief explanation of why this matters for system configuration.
Suggested change
| | Storage | <ul><li>The `posix` and `decomposed` storage drivers require:<ul><li>a fully POSIX compliant filesystem <ul><li> local e.g. ext4, XFS, ZFS</li><li>network e.g. CephFS, GPFS, NFS v4.2 or later</li></ul></li><li>atomic read after write consistency for directory metadata (NFS mount option `noac`)</li></ul></li><li>`decomposeds3` additionally requires an S3 bucket</li><li>`posix` requires extended attributes (offloading metadata >1KB into dedicated files)</li></ul> | | |
| | Storage | <ul><li>The `posix` and `decomposed` storage drivers require:<ul><li>a fully POSIX compliant filesystem <ul><li> local e.g. ext4, XFS, ZFS</li><li>network e.g. CephFS, GPFS, NFS v4.2 or later</li></ul></li><li>atomic read after write consistency for directory metadata (NFS mount option `noac`)</li></ul></li><li>`decomposeds3` additionally requires an S3 bucket</li><li>`posix` requires extended attributes (supports storing metadata larger than 1KB; this ensures compatibility and reliability for large file metadata)</li></ul> | |
| | Storage | <ul><li>Local storage: Classic file storage on a local file system with POSIX compatibility (e.g., ext4, XFS, ZFS)</li><li>S3</li><li>NFS (mounted with NFS version 4.2 or later)</li><li>CephFS</li><li>GPFS</li></ul> | | ||
| | Server Operating System | <ul><li>Production: Linux</li><li>Testing and development: MacOS or Windows WSL</li></ul> | | ||
| | Database | <ul><li>None (OpenCloud stores files exclusively on the storage to minimize complexity and ensure maximum reliability)</li></ul> | | ||
| | Storage | <ul><li>The `posix` and `decomposed` storage drivers require:<ul><li>a fully POSIX compliant filesystem <ul><li> local e.g. ext4, XFS, ZFS</li><li>network e.g. CephFS, GPFS, NFS v4.2 or later</li></ul></li><li>atomic read after write consistency for directory metadata (NFS mount option `noac`)</li></ul></li><li>`decomposeds3` additionally requires an S3 bucket</li><li>`posix` requires extended attributes (offloading metadata >1KB into dedicated files)</li></ul> | |
There was a problem hiding this comment.
The deeply nested HTML list structure (4 levels deep) makes the content difficult to read and maintain. Consider breaking this into a table with columns for 'Storage Driver', 'Filesystem Requirements', and 'Additional Requirements', or using separate sections for each driver type to improve readability.
Suggested change
| | Storage | <ul><li>The `posix` and `decomposed` storage drivers require:<ul><li>a fully POSIX compliant filesystem <ul><li> local e.g. ext4, XFS, ZFS</li><li>network e.g. CephFS, GPFS, NFS v4.2 or later</li></ul></li><li>atomic read after write consistency for directory metadata (NFS mount option `noac`)</li></ul></li><li>`decomposeds3` additionally requires an S3 bucket</li><li>`posix` requires extended attributes (offloading metadata >1KB into dedicated files)</li></ul> | | |
| | Storage | See the table below for storage driver requirements. | |
github-project-automation
bot
moved this from In Progress
to Done
in OpenCloud Team Board
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.
Updated storage requirements to include details for 'posix' and 'decomposed' storage drivers, specifying filesystem compliance and additional requirements.