-
Notifications
You must be signed in to change notification settings - Fork 496
docs: improve getting started and README documentation #2267
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
Changes from 4 commits
f3a8d9d
163e595
48da122
83cbb87
456997f
81b9ce5
74b9a5e
d40b4a7
6219a5c
742e68f
f381a4e
1fac34c
9a8ca15
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -23,3 +23,117 @@ weight: 101 | |
| build: | ||
| render: never | ||
| --- | ||
|
|
||
| # Getting Started with Apache Polaris Binary Distribution | ||
|
Subham-KRLX marked this conversation as resolved.
Outdated
|
||
|
|
||
| Quickly start Apache Polaris by running the pre-built binary, no build needed. | ||
|
|
||
| --- | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - Java 21 or later installed. You can verify this by running: | ||
|
|
||
| ```bash | ||
| java -version | ||
| ``` | ||
|
|
||
| - Basic familiarity with running commands in your operating system terminal. | ||
|
Subham-KRLX marked this conversation as resolved.
Outdated
|
||
|
|
||
| --- | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Nit: the separator may not be quite helpful for a small section like this. Could we remove all of them? |
||
|
|
||
| ## Step 1: Download the Apache Polaris Binary | ||
|
|
||
| 1. Visit the official Apache Polaris GitHub | ||
| [Releases page](https://github.com/apache/polaris/releases). | ||
|
Subham-KRLX marked this conversation as resolved.
Outdated
|
||
|
|
||
| 2. Download the latest binary archive file, for example: | ||
|
|
||
| ```bash | ||
| apache-polaris-<version>-bin.tar.gz | ||
|
Subham-KRLX marked this conversation as resolved.
Outdated
|
||
| ``` | ||
|
|
||
| --- | ||
|
|
||
| ## Step 2: Extract the Archive | ||
|
|
||
| Extract the downloaded tar.gz file to your desired directory: | ||
|
Subham-KRLX marked this conversation as resolved.
Outdated
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. please remove this step as step 1 extract it already. |
||
|
|
||
| ```bash | ||
| tar -xzvf apache-polaris-<version>-bin.tar.gz | ||
| cd apache-polaris-<version> | ||
| ``` | ||
|
|
||
| *Replace `<version>` with the actual version number.* | ||
|
Subham-KRLX marked this conversation as resolved.
Outdated
|
||
|
|
||
| --- | ||
|
|
||
| ## Step 3: Configure Polaris (Optional) | ||
|
|
||
| Edit the `application.properties` file if needed. For example: | ||
|
Subham-KRLX marked this conversation as resolved.
Outdated
|
||
|
|
||
| ```bash | ||
| polaris.storage.backend=local | ||
| polaris.storage.local.path=/data/polaris | ||
| ``` | ||
| *(This is a configuration file, not a shell command. Adjust these values as needed.)* | ||
|
|
||
| --- | ||
|
|
||
| ## Step 4: Run the Polaris Server | ||
|
|
||
| Start the Polaris server using the provided script: | ||
|
|
||
| ```bash | ||
| ./bin/polaris-server.sh start | ||
|
Subham-KRLX marked this conversation as resolved.
Outdated
|
||
| ``` | ||
|
|
||
| To tail the logs in a separate terminal, run: | ||
|
|
||
| ```bash | ||
| tail -f logs/polaris.log | ||
| ``` | ||
|
|
||
| --- | ||
|
|
||
| ## Step 5: Verify the Server is Running | ||
|
|
||
| Open your browser and navigate to: | ||
|
|
||
| ```bash | ||
| curl http://localhost:8181/api/catalog/v1/health | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think the path is wrong. |
||
| ``` | ||
|
|
||
| You should see the Polaris server running or be able to access its REST API. | ||
|
|
||
| --- | ||
|
|
||
| ## Step 6: Stop the Polaris Server | ||
|
|
||
| To stop the server, run: | ||
|
|
||
| ```bash | ||
| ./bin/polaris-server.sh stop | ||
|
Subham-KRLX marked this conversation as resolved.
Outdated
|
||
| ``` | ||
|
|
||
| --- | ||
|
|
||
| ## Additional Resources | ||
|
|
||
| - See the official Apache Polaris documentation for details. | ||
|
Subham-KRLX marked this conversation as resolved.
Outdated
|
||
| - Use ./bin/polaris-admin in the binary for admin and maintenance tasks. | ||
|
|
||
| --- | ||
|
|
||
| Get started with Apache Polaris binaries. See repo for containers and more. | ||
|
Subham-KRLX marked this conversation as resolved.
Outdated
|
||
|
|
||
| --- | ||
|
|
||
| *Happy data cataloging with Apache Polaris!* | ||
|
|
||
| --- | ||
|
Subham-KRLX marked this conversation as resolved.
Outdated
|
||
|
|
||
| **Want to build or run Polaris from source?** | ||
| See the [Quickstart guide](https://polaris.apache.org/in-dev/unreleased/getting-started/quickstart/) for developer instructions and advanced setup. | ||
|
Subham-KRLX marked this conversation as resolved.
Outdated
|
||
|
|
||
| --- | ||
Uh oh!
There was an error while loading. Please reload this page.