Skip to content

feat(docs): Add Getting Stated guide for MinIO #2227

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

Merged
merged 5 commits into from
Aug 15, 2025

Conversation

dimas-b
Copy link
Contributor

@dimas-b dimas-b commented Aug 1, 2025

A simple page of step-by-step instructions for setting up a local environment with Polaris, MinIO and Spark.

Closes #1530

@adutra
Copy link
Contributor

adutra commented Aug 1, 2025

Nice addition, although I'm wondering: wouldn't it be better to create a docker-compose getting-started example in the directory below?

https://github.com/apache/polaris/tree/main/getting-started

@dimas-b
Copy link
Contributor Author

dimas-b commented Aug 1, 2025

A docker-compose file would be nice, but I wanted to have a prominent doc for people building something from scratch. I've seen a few messages where the catalog creation step appeared to be confusing to users.

@dimas-b dimas-b marked this pull request as draft August 13, 2025 00:06
@dimas-b dimas-b force-pushed the minio-guide branch 2 times, most recently from bac4cee to 0d6a451 Compare August 13, 2025 23:15
@dimas-b dimas-b marked this pull request as ready for review August 13, 2025 23:16
The compose script will start MinIO on default ports (API on 9000, UI on 9001)
plus a Polaris Server pre-configured to that MinIO instance.

In this example the `root` Polaris uses the password set to `s3cr3t`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
In this example the `root` Polaris uses the password set to `s3cr3t`.
In this example the `root` principal uses the password set to `s3cr3t`.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice catch - fixed (with a different text)

eric-maynard
eric-maynard previously approved these changes Aug 14, 2025
@github-project-automation github-project-automation bot moved this from PRs In Progress to Ready to merge in Basic Kanban Board Aug 14, 2025

realm=${1:-"POLARIS"}

TOKEN=$(curl -s http://polaris:8181/api/catalog/v1/oauth/tokens \
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't we modify create-catalog.sh to call this script? Right now the token fetch logic is duplicated.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

refactored. PTAL

@dimas-b dimas-b merged commit 596239c into apache:main Aug 15, 2025
12 checks passed
@github-project-automation github-project-automation bot moved this from Ready to merge to Done in Basic Kanban Board Aug 15, 2025
@dimas-b dimas-b deleted the minio-guide branch August 15, 2025 14:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Support for non-AWS S3 compatible storage with STS
3 participants