Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
docs-action committed Jan 6, 2025
1 parent 23c1ceb commit bbc2e0f
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion assets/js/search-data.json
Original file line number Diff line number Diff line change
Expand Up @@ -3193,7 +3193,7 @@
},"456": {
"doc": "Mount",
"title": "FAQs",
"content": "How do I get started with lakeFS Mount (Everest)? . lakeFS Mount is avaialble for lakeFS Cloud and lakeFS Enterprise customers. Once your setup is complete, contact us to access the lakeFS Mounts binary and follow the provided docs. | Want to try lakeFS Cloud? Signup for a 30-day free trial. | Interested in lakeFS Enterprise? Contact sales for a 30-day free license. | . Can I write to lakeFS using lakeFS Mount? . Currently, lakeFS Mount supports read-only file system operations. Write support is on our roadmap and will be added in the future. What operating systems are supported by lakeFS Mount? . lakeFS Mount supports Linux and MacOS. Windows support is on the roadmap. How can I control access to my data when using lakeFS Mount? . You can use lakeFS’s existing Role-Based Access Control mechanism, which includes repository and path-level policies. lakeFS Mount translates filesystem operations into lakeFS API operations and authorizes them based on these policies. The minimal RBAC permissions required for mounting a prefix from a lakeFS repository looks like this: . { \"id\": \"MountPolicy\", \"statement\": [ { \"action\": [ \"fs:ReadObject\" ], \"effect\": \"allow\", \"resource\": \"arn:lakefs:fs:::repository/<repository-name>/object/<prefix>/*\" }, { \"action\": [ \"fs:ListObjects\", \"fs:ReadCommit\", \"fs:ReadRepository\" ], \"effect\": \"allow\", \"resource\": \"arn:lakefs:fs:::repository/<repository-name>\" } ] } . Does data pass through the lakeFS server when using lakeFS Mount? . lakeFS Mount leverages pre-signed URLs to read data directly from the underlying object store, meaning data doesn’t pass through the lakeFS server. By default, presign is enabled. To disable it, use: . everest mount <lakefs_uri> <mount_directory> --presign=false . What happens if a lakeFS branch is updated after I mount it? . lakeFS Mount points to the commit that was the HEAD commit of the branch at the time of mounting. This means the local directory reflects the branch state at the time of mounting and does not update with subsequent branch changes. When are files downloaded to my local environment? . lakeFS Mount uses a lazy prefetch strategy. Files are not downloaded at mount time or during operations that only inspect file metadata (e.g., ls). Files are downloaded only when commands that require file access (e.g., cat) are used. What are the scale limitations of lakeFS Mount, and what are the recommended configurations for dealing with large datasets? . When using lakeFS Mount, the volume of data accessed by the local machine influences the scale limitations more than the total size of the dataset under the mounted prefix. This is because lakeFS Mount uses a lazy downloading approach, meaning it only downloads the accessed files. lakeFS Mount listing capability is limited to performing efficiently for prefixes containing fewer than 8000 objects, but we are working to increase this limit. Recommended Configuration . Ensure your cache size is large enough to accommodate the volume of files being accessed. How does lakeFS Mount integrate with a Git repository? . It is perfectly safe to mount a lakeFS path within a Git repository. lakeFS Mount prevents git from adding mounted objects to the git repository (i.e when running git add -A) by adding a virtual .gitignore file to the mounted directory. The .gitignore file will also instruct Git to ignore all files except .everest/source and in its absence, it will try to find a .everest/source file in the destination folder, and read the lakeFS URI from there. Since .everest/source is in source control, it will mount the same lakeFS commit every time! . I’m already using lakectl local for working with lakeFS data locally, why should I use lakeFS Mount? . While both lakectl local and lakeFS Mount enable working with lakeFS data locally, they serve different purposes: . Use lakectl local . | For enabling lakeFS writes with lakectl local commit. | To integrate seamlessly with Git. | . Use lakeFS Mount . For read-only local data access. lakeFS Mount offers several benefits over lakectl local: . | Optimized selective data access: The lazy prefetch strategy saves storage space and reduces latency by only fetching the required data. | Reduced initial latency: Start working on your data immediately without waiting for downloads. | . Note Note: Write support for lakeFS Mount is on our roadmap. ",
"content": "How do I get started with lakeFS Mount (Everest)? . lakeFS Mount is avaialble for lakeFS Cloud and lakeFS Enterprise customers. Once your setup is complete, contact us to access the lakeFS Mounts binary and follow the provided docs. | Want to try lakeFS Cloud? Signup for a 30-day free trial. | Interested in lakeFS Enterprise? Contact sales for a 30-day free license. | . Can I write to lakeFS using lakeFS Mount? . Currently, lakeFS Mount supports read-only file system operations. Write support is on our roadmap and will be added in the future. What operating systems are supported by lakeFS Mount? . lakeFS Mount supports Linux and MacOS. Windows support is on the roadmap. How can I control access to my data when using lakeFS Mount? . You can use lakeFS’s existing Role-Based Access Control mechanism, which includes repository and path-level policies. lakeFS Mount translates filesystem operations into lakeFS API operations and authorizes them based on these policies. The minimal RBAC permissions required for mounting a prefix from a lakeFS repository looks like this: . { \"id\": \"MountPolicy\", \"statement\": [ { \"action\": [ \"fs:ReadObject\" ], \"effect\": \"allow\", \"resource\": \"arn:lakefs:fs:::repository/<repository-name>/object/<prefix>/*\" }, { \"action\": [ \"fs:ListObjects\", \"fs:ReadCommit\", \"fs:ReadRepository\" ], \"effect\": \"allow\", \"resource\": \"arn:lakefs:fs:::repository/<repository-name>\" } ] } . Does data pass through the lakeFS server when using lakeFS Mount? . lakeFS Mount leverages pre-signed URLs to read data directly from the underlying object store, meaning data doesn’t pass through the lakeFS server. By default, presign is enabled. To disable it, use: . everest mount <lakefs_uri> <mount_directory> --presign=false . What happens if a lakeFS branch is updated after I mount it? . lakeFS Mount points to the commit that was the HEAD commit of the branch at the time of mounting. This means the local directory reflects the branch state at the time of mounting and does not update with subsequent branch changes. When are files downloaded to my local environment? . lakeFS Mount uses a lazy prefetch strategy. Files are not downloaded at mount time or during operations that only inspect file metadata (e.g., ls). Files are downloaded only when commands that require file access (e.g., cat) are used. What are the scale limitations of lakeFS Mount, and what are the recommended configurations for dealing with large datasets? . When using lakeFS Mount, the volume of data accessed by the local machine influences the scale limitations more than the total size of the dataset under the mounted prefix. This is because lakeFS Mount uses a lazy downloading approach, meaning it only downloads the accessed files. lakeFS Mount listing capability is limited to performing efficiently for prefixes containing fewer than 8000 objects, but we are working to increase this limit. Recommended Configuration . Ensure your cache size is large enough to accommodate the volume of files being accessed. How does lakeFS Mount integrate with a Git repository? . It is perfectly safe to mount a lakeFS path within a Git repository. lakeFS Mount prevents git from adding mounted objects to the git repository (i.e when running git add -A) by adding a virtual .gitignore file to the mounted directory. The .gitignore file will also instruct Git to ignore all files except .everest/source and in its absence, it will try to find a .everest/source file in the destination folder, and read the lakeFS URI from there. Since .everest/source is in source control, it will mount the same lakeFS commit every time! . I’m already using lakectl local for working with lakeFS data locally, why should I use lakeFS Mount? . While both lakectl local and lakeFS Mount enable working with lakeFS data locally, they serve different purposes: . Use lakectl local . | For enabling lakeFS writes with lakectl local commit. | To integrate seamlessly with Git. | . Use lakeFS Mount . For read-only local data access. lakeFS Mount offers several benefits over lakectl local: . | Optimized selective data access: The lazy prefetch strategy saves storage space and reduces latency by only fetching the required data. | Reduced initial latency: Start working on your data immediately without waiting for downloads. | . Note Write support for lakeFS Mount is on our roadmap. ",
"url": "/reference/mount.html#faqs",

"relUrl": "/reference/mount.html#faqs"
Expand Down
2 changes: 1 addition & 1 deletion reference/mount.html
Original file line number Diff line number Diff line change
Expand Up @@ -967,7 +967,7 @@ <h5 id="use-lakefs-mount">
</ul>

<p class="note"><strong>Note</strong>
Note: Write support for lakeFS Mount is on our roadmap.</p>
Write support for lakeFS Mount is on our roadmap.</p>

<!-- END EXCLUDE FROM TOC -->

Expand Down

0 comments on commit bbc2e0f

Please sign in to comment.