Docs: explain mounts on quickstart, working locally #8001
Conversation
ozkatz
added
docs
|
♻️ PR Preview 6a6ab5d has been successfully destroyed since this PR has been closed.
🤖 By surge-preview |
E2E Test Results - DynamoDB Local - Local Block Adapter |
ozkatz
added
the
exclude-changelog
| #### Prerequisites: | ||
|
|
||
| - A working lakeFS Server running either [lakeFS Enterprise](../enterprise) or [lakeFS Cloud](../cloud) | ||
| - You’ve installed the [`lakectl`](../reference/cli.html) command line utility: this is the official lakeFS command line interface, on top of which lakeFS Mount is built. |
There was a problem hiding this comment.
Why is lakectl a requirement?
There was a problem hiding this comment.
because it sets up ~/.lakectl.yaml properly. While technically you don't really need the binary itself, once you have it set up, you'll be able to use everest as well.
There was a problem hiding this comment.
I find this to be confusing. Because even if you download lakectl you still don't have ~/.lakectl.yaml file which means you'll get an error when running everest.
Can you be explicit about the need for lakectl.yaml configuration file? it can even be empty one but this is the actual pre-requisite.
| The _local_ command of lakeFS' CLI _lakectl_ enables working with lakeFS data locally. | ||
| It allows cloning lakeFS data into a directory on any machine, syncing local directories with remote lakeFS locations, | ||
| The _local_ command of lakeFS' CLI _lakectl_ enables working with lakeFS data locally by copying the data onto the host machine. | ||
| It allows syncing local directories with remote lakeFS locations, | ||
| and to [seamlessly integrate lakeFS with Git](#example-using-lakectl-local-in-tandem-with-git). | ||
|
|
||
| Here are the available _lakectl local_ commands: |
There was a problem hiding this comment.
Non-blocking but consider adding a section that explains when to use each of the methods.
| - You’ve installed the [`lakectl`](../reference/cli.html) command line utility: this is the official lakeFS command line interface, on top of which lakeFS Mount is built. | ||
| - lakectl is configured properly to access your lakeFS server as detailed in the configuration instructions | ||
|
|
||
| ### Mounting a lakeFS reference as a local directory |
There was a problem hiding this comment.
It will be good to mention that lakeFS Mount has a Git integration
There was a problem hiding this comment.
will do! probably in a separate PR
Docs: explain how mounts could be used in the context of the quickstart (Alongside lakectl local) as well as on the "Working with lakeFS Data Locally" how-to page.