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

Proposal: Change default location of ~/.lakectl.yaml #7696

Open
5 tasks
ozkatz opened this issue Apr 23, 2024 · 0 comments
Open
5 tasks

Proposal: Change default location of ~/.lakectl.yaml #7696

ozkatz opened this issue Apr 23, 2024 · 0 comments
Labels
area/lakectl Issues related to lakeFS' command line interface (lakectl) improvement product-task python-wrapper

Comments

@ozkatz
Copy link
Collaborator

ozkatz commented Apr 23, 2024

Why

lakectl is configured using a yaml file located in $HOME/lakectl.yaml.
While this makes perfect sense for lakectl, it is also currently used by other lakeFS clients such as the high level python SDK - and libraries that depend on it.

This is confusing!

When

Currently I'm only aware of these 2 tools that look for this file. As time passes I'm sure more tools will follow. So soon?

How

In a non-breaking way. Allow both lakectl and the Python SDK to look for a more aptly-named $HOME/.lakefs/client.yaml (happy to hear better suggestions so that we don't end up replacing it yet again in the future) -- and if that doesn't exist, fall back to $HOME/.lakectl.yaml.

  • lakectl and SDK should implement fallback logic from new file name to old
  • lakectl should create this file by default instead of the old name in lakectl config
  • the web UI should recommend downloading the config to the new location post-setup
  • lakeFS docs should be adjusted to refer to the new name by deafult
  • python SDK docs, (+ possibly docs of dependent tools such as lakefs-spec) should start using new path
@ozkatz ozkatz added area/lakectl Issues related to lakeFS' command line interface (lakectl) improvement python-wrapper labels Apr 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/lakectl Issues related to lakeFS' command line interface (lakectl) improvement product-task python-wrapper
Projects
None yet
Development

No branches or pull requests

2 participants