Everest mount write docs #8725
Everest mount write docs #8725
Conversation
idanovo
added
docs
|
🎊 PR Preview a2557e8 has been successfully built and deployed to https://treeverse-lakeFS-preview-pr-8725.surge.sh 🕐 Build time: 0.01s
🤖 By surge-preview |
E2E Test Results - DynamoDB Local - Local Block Adapter |
E2E Test Results - Quickstart |
| @@ -0,0 +1,26 @@ | |||
| --- | |||
| title: Mount Write Mode Limitations | |||
There was a problem hiding this comment.
| title: Mount Write Mode Limitations | |
| title: Mount (Everest) file system behavior |
| @@ -0,0 +1,26 @@ | |||
| --- | |||
| title: Mount Write Mode Limitations | |||
| description: Limitations of the mount write mode | |||
There was a problem hiding this comment.
File system semantics limitations and and general info
docs/reference/mount.md
Outdated
| **** | ||
| Everest mount write mode is now available for MacOS on experimental mode! | ||
| [Everest mount write mode limitations](mount-write-mode-limitations.md). | ||
| {: .note } |
There was a problem hiding this comment.
Move this under ### Write Mode
There was a problem hiding this comment.
I do not agree!
- It should be at the beginning of the page so users will be aware of the fact that write-mode is available now.
- I think we agreed we won't have a "write-mode" section.
docs/reference/mount.md
Outdated
| @@ -21,13 +21,18 @@ This functionality is currently in limited support and is a Read-Only file syste | |||
| ⚠️ No installation is required. Please [contact us](http://info.lakefs.io/thanks-lakefs-mounts) to get access to the Everest binary. | |||
| {: .note } | |||
|
|
|||
| **** | |||
| Everest mount write mode is now available for MacOS on experimental mode! | |||
There was a problem hiding this comment.
| Everest mount write mode is now available for MacOS on experimental mode! | |
| Everest mount supports writing to the file system and now available for NFS (the default protocol for MacOS)! |
| @@ -179,8 +230,40 @@ The minimal RBAC permissions required for mounting a prefix from a lakeFS reposi | |||
| "action": [ | |||
| "fs:ListObjects", | |||
| "fs:ReadCommit", | |||
| "fs:ReadBranch", | |||
There was a problem hiding this comment.
{
"action": ["fs:ReadConfig"],
"effect": "allow",
"resource": "*"
}| ## Everest Partial-Read Mode | ||
| - Mount write mode is not supported with Everest partial-read mode. | ||
|
|
||
| ## Functionality Limitations |
There was a problem hiding this comment.
That's a very generic title.
We can generalize this and talk about "consistency and data sync"
talk about behavior of sync, diff, commit
There was a problem hiding this comment.
- sync is an internal term
- I don't see how this limitation belongs in "consistency and data sync"
| ## Functionality Limitations | ||
| - Newly created empty directories will not reflect as directory marker in lakeFS. | ||
|
|
||
| ## File System Limitations |
There was a problem hiding this comment.
I don't see maybe i missed - POSIX permissions are not supported and we set default permissions given to files and dirs.
| ## Functionality Limitations | ||
| - Newly created empty directories will not reflect as directory marker in lakeFS. | ||
|
|
||
| ## File System Limitations |
There was a problem hiding this comment.
Please see in this design section
Split the limitations to not-supported, partially supported and behavior modified.
Then explain the things there.
| parent: Mount | ||
| --- | ||
|
|
||
| # Mount Write Mode Limitations |
There was a problem hiding this comment.
| # Mount Write Mode Limitations | |
| # Mount Write Mode file system behavior |
| --- | ||
|
|
||
| # Mount Write Mode Limitations | ||
|
|
There was a problem hiding this comment.
Let's try to make it more structured because there are many things to unpack here.
- Overview
- Architecture and concurrency model - few bullets not long are enough but that section
is great! - Committing Changes
- how it works, consistency, merge strategy, what happens after commit.
- writes during commit may be lost, dont do it
- Limitations
- sub section: functional bullets: (NFS, no eviction for write dir its not cache, durability: restarting the mount may lead to unpredicted behavior)
- sub section: FS Limitations (as mentioned below)
No description provided.