-
Notifications
You must be signed in to change notification settings - Fork 331
docs: Add quickstart documentation #2976
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
docs: Add quickstart documentation #2976
Conversation
|
Meh, forgot to mention: |
adutra
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is really amazing, a complete no-brainer 😆
Co-authored-by: Alexandre Dutra <[email protected]>
Co-authored-by: Alexandre Dutra <[email protected]>
Co-authored-by: Alexandre Dutra <[email protected]>
adnanhemani
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is super great for reintroducing Quickstart! Thank you so much for doing this :)
I'm personally not a big fan of using MinIO here, as it may give off an (incorrect) impression that we are preferring a vendor/product for usage with Polaris. Using the local file based approach avoids all of that. But I also see the discussion in the PR regarding this topic, so I don't want to block on that. The usefulness of this PR far outweighs any negatives here!
Yeah, @adnanhemani , that's a good point and I agree. Let me list out some shared values that I think we have:
I believe that there are two conflicting ideas here:
|
|
Polaris docs have a variety of options for storage: https://polaris.apache.org/in-dev/unreleased/getting-started/creating-a-catalog/ Getting Started should focus on simplicity, in which case MinIO appears to be the best fit. Given that MinIO (still) has public docker images, I believe it is fine to use it for getting-started guides. |
Context
I wanted to ensure that onboarding was very simple for users to play around with Polaris through a quickstart that does everything for you.
To that end, this is a quick_start docker compose file that will allow a user to auto-create a catalog, principal, privileges, etc and uses a MinIO-based connection. The Docker Compose file does not use any other scripts within the repository, so the user-facing documentation can be a one-line bash script.
There are no tests related to this as it is a getting started file.
Checklist
CHANGELOG.md(if needed)site/content/in-dev/unreleased(if needed)Docs Pics
Console Output