Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add PosixFS (experimental) #1081

Merged
merged 8 commits into from
Dec 4, 2024
Merged

Add PosixFS (experimental) #1081

merged 8 commits into from
Dec 4, 2024

Conversation

mmattel
Copy link
Contributor

@mmattel mmattel commented Nov 30, 2024

Fixes: #1080 (Add PosixFS (experimental) to available storages)

This PR adds a description for the PosixFS driver (experimental state)

No backport

@phil-davis a language review is welcomed

@mmattel mmattel added the documentation Improvements or additions to documentation label Nov 30, 2024

To use the PosixFS Storage Driver, the following prerequisites have to be fulfilled:

* There must be storage available to store meta data and blobs, available under a root path.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just as a general note, blobs and metadata both live in the same file in the posixfs (the file contains the actual data, and the metadata is attached directly to that file), in contrast to decomposedfs. Not sure if that should be worded differently.


* There must be storage available to store meta data and blobs, available under a root path.
* When using inotify, the storage must be local on the same machine. +
Network mounts require `inotifywait` to be installed (inotify does not work here).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not really correct. inotifywait is a hard requirement for the inotify watcher, regardless if it's a mounted remote filesystem or a local one.


=== GPFS Specifics

When using GPFS as the underlying filesystem, the machine running the xref:{s-path}/storage-users.adoc[Storage-Users] service needs to have the GPFS filesystem mounted locally. The mount path is given to ocis as the `STORAGE_USERS_POSIX_ROOT` path.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nitpick: the user doesn't necessarily have to set the mount path as the posix root. Instead the posix root is the directory where posixfs keeps it data. It may be the mount path or any subdirectory of it.

@mmattel
Copy link
Contributor Author

mmattel commented Dec 3, 2024

@aduffeck I have incorporated your suggestions, pls have a look

@mmattel mmattel merged commit 761e048 into master Dec 4, 2024
1 check passed
@mmattel mmattel deleted the posixfs branch December 4, 2024 08:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add PosixFS (experimental) to available storages
3 participants