-
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 8 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,19 +23,110 @@ type: docs | |
| weight: 101 | ||
| --- | ||
|
|
||
| There are several options for getting started with Apache Polaris. | ||
| # Getting Started with Apache Polaris Binary Distribution | ||
|
Subham-KRLX marked this conversation as resolved.
Outdated
|
||
|
|
||
| To quickly try out Apache Polaris, please use the [quickstart guide](./quick-start). For other examples, please see below. | ||
| Quickly start Apache Polaris by running the pre-built binary, no build needed. | ||
|
|
||
| ## Docker Compose Examples | ||
| Each of the proceeding Docker Compose examples provides a complete working environment with detailed instructions. | ||
| --- | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - Java 21 or later installed. You can verify this by running: | ||
|
|
||
| ```bash | ||
| java -version | ||
| ``` | ||
|
|
||
| --- | ||
|
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 | ||
| curl -L https://downloads.apache.org/incubator/polaris/1.0.0-incubating/polaris-bin-1.0.0-incubating.tgz | tar xz | ||
| ``` | ||
|
|
||
| --- | ||
|
|
||
| ## 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 | ||
| cd apache-polaris-1.0.0-incubating-bin | ||
|
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. we could move this to next step |
||
| ``` | ||
|
|
||
| --- | ||
|
|
||
| ## 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 | ||
|
|
||
| ### Next Steps | ||
| Start the Polaris server using the provided script: | ||
|
|
||
| 1. Check & install dependencies | ||
| 2. Choose the way you want to deploy Polaris | ||
| 3. Create a catalog | ||
| 4. Check Using Polaris page | ||
| ```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](https://polaris.apache.org/docs/) for comprehensive information on configuration, deployment, and usage. | ||
|
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. we may not need to mention it, as people visiting this page are already here. |
||
| - Use `./bin/polaris-admin` in the binary distribution for administrative and maintenance tasks. | ||
|
|
||
| --- | ||
|
|
||
| ## Other Getting Started Options | ||
|
|
||
| For building and running Polaris from source code, check out the [Quickstart guide](./quick-start/). | ||
|
|
||
| For Docker Compose examples and other deployment options, please see the [documentation](https://polaris.apache.org). | ||
|
|
||
| --- | ||
|
|
||
| ### Getting Help | ||
|
|
||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.