From f3a8d9d5d3803a8ad795aac24b459fd01cabec2e Mon Sep 17 00:00:00 2001 From: Subham Sangwan Date: Tue, 5 Aug 2025 19:07:57 +0530 Subject: [PATCH 1/7] docs: improve getting started and README documentation --- getting-started/README.md | 3 + getting-started/getting-started-binary.md | 119 ++++++++++++++++++++++ 2 files changed, 122 insertions(+) create mode 100644 getting-started/getting-started-binary.md diff --git a/getting-started/README.md b/getting-started/README.md index 32a7376509..6e949e24f0 100644 --- a/getting-started/README.md +++ b/getting-started/README.md @@ -19,6 +19,9 @@ # Getting Started with Apache Polaris +If you prefer not to use Docker, you can get started with Polaris by downloading and running the official binary distribution. +See [Getting Started with the Polaris Binary Distribution](getting-started-binary.md) for step-by-step instructions on installing and running Polaris directly as a standalone application. + You can quickly get started with Polaris by playing with the docker-compose examples provided in this directory. Each example has detailed instructions. diff --git a/getting-started/getting-started-binary.md b/getting-started/getting-started-binary.md new file mode 100644 index 0000000000..3c7b821b5f --- /dev/null +++ b/getting-started/getting-started-binary.md @@ -0,0 +1,119 @@ + + +# Getting Started with Apache Polaris Binary Distribution + +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. + +--- + +## Step 1: Download the Apache Polaris Binary + +1. Visit the official Apache Polaris GitHub + [Releases page](https://github.com/apache/polaris/releases). + +2. Download the latest binary archive file, for example: + +```bash +apache-polaris--bin.tar.gz +``` + +--- + +## Step 2: Extract the Archive + +Extract the downloaded tar.gz file to your desired directory: + +```bash +tar -xzvf apache-polaris--bin.tar.gz +cd apache-polaris- +``` + +*Replace `` with the actual version number.* + +--- + +## Step 3: Configure Polaris (Optional) + +Edit the configuration file if needed: + +--- + +## Step 4: Run the Polaris Server + +Start the Polaris server using the provided script: + +```bash +./bin/polaris-server.sh start +``` + +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 +http://localhost:8181 +``` + +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 +``` + +--- + +## Additional Resources + +- See the official Apache Polaris documentation for details. +- Use ./bin/polaris-admin in the binary for admin and maintenance tasks. + +--- + +Get started with Apache Polaris binaries. See repo for containers and more. + +--- + +*Happy data cataloging with Apache Polaris!* From 163e595aa0ab2a44f328283ae2cdbb5c02874a22 Mon Sep 17 00:00:00 2001 From: Subham Sangwan Date: Wed, 6 Aug 2025 21:06:23 +0530 Subject: [PATCH 2/7] Revert changes to getting-started/README.md as per reviewer request --- getting-started/README.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/getting-started/README.md b/getting-started/README.md index 6e949e24f0..32a7376509 100644 --- a/getting-started/README.md +++ b/getting-started/README.md @@ -19,9 +19,6 @@ # Getting Started with Apache Polaris -If you prefer not to use Docker, you can get started with Polaris by downloading and running the official binary distribution. -See [Getting Started with the Polaris Binary Distribution](getting-started-binary.md) for step-by-step instructions on installing and running Polaris directly as a standalone application. - You can quickly get started with Polaris by playing with the docker-compose examples provided in this directory. Each example has detailed instructions. From 48da122b345e14a18625f48e7a279ce02b19a3cc Mon Sep 17 00:00:00 2001 From: Subham Sangwan Date: Thu, 7 Aug 2025 07:50:35 +0530 Subject: [PATCH 3/7] Consolidate binary setup in Getting Started index, update README quickstart link, update quickstart.md and remove redundant binary doc --- README.md | 2 +- getting-started/getting-started-binary.md | 119 ------------------ .../unreleased/getting-started/_index.md | 114 +++++++++++++++++ .../unreleased/getting-started/quickstart.md | 3 + 4 files changed, 118 insertions(+), 120 deletions(-) delete mode 100644 getting-started/getting-started-binary.md diff --git a/README.md b/README.md index 1296e00cb4..ad082daaac 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ for contribution guidelines. Click [here](https://polaris.apache.org/in-dev/unreleased/) for a quick overview of Polaris. ## Quickstart -Click [here](https://polaris.apache.org/in-dev/unreleased/getting-started/install-dependencies/) for the quickstart experience, which will help you set up a Polaris instance locally or on any supported cloud provider. +Click [here](https://polaris.apache.org/in-dev/unreleased/getting-started/) for the quickstart experience, which will help you set up a Polaris instance locally or on any supported cloud provider. ## Building and Running diff --git a/getting-started/getting-started-binary.md b/getting-started/getting-started-binary.md deleted file mode 100644 index 3c7b821b5f..0000000000 --- a/getting-started/getting-started-binary.md +++ /dev/null @@ -1,119 +0,0 @@ - - -# Getting Started with Apache Polaris Binary Distribution - -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. - ---- - -## Step 1: Download the Apache Polaris Binary - -1. Visit the official Apache Polaris GitHub - [Releases page](https://github.com/apache/polaris/releases). - -2. Download the latest binary archive file, for example: - -```bash -apache-polaris--bin.tar.gz -``` - ---- - -## Step 2: Extract the Archive - -Extract the downloaded tar.gz file to your desired directory: - -```bash -tar -xzvf apache-polaris--bin.tar.gz -cd apache-polaris- -``` - -*Replace `` with the actual version number.* - ---- - -## Step 3: Configure Polaris (Optional) - -Edit the configuration file if needed: - ---- - -## Step 4: Run the Polaris Server - -Start the Polaris server using the provided script: - -```bash -./bin/polaris-server.sh start -``` - -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 -http://localhost:8181 -``` - -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 -``` - ---- - -## Additional Resources - -- See the official Apache Polaris documentation for details. -- Use ./bin/polaris-admin in the binary for admin and maintenance tasks. - ---- - -Get started with Apache Polaris binaries. See repo for containers and more. - ---- - -*Happy data cataloging with Apache Polaris!* diff --git a/site/content/in-dev/unreleased/getting-started/_index.md b/site/content/in-dev/unreleased/getting-started/_index.md index ee0f9b6871..c65d05d1f6 100644 --- a/site/content/in-dev/unreleased/getting-started/_index.md +++ b/site/content/in-dev/unreleased/getting-started/_index.md @@ -23,3 +23,117 @@ weight: 101 build: render: never --- + +# Getting Started with Apache Polaris Binary Distribution + +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. + +--- + +## Step 1: Download the Apache Polaris Binary + +1. Visit the official Apache Polaris GitHub + [Releases page](https://github.com/apache/polaris/releases). + +2. Download the latest binary archive file, for example: + +```bash +apache-polaris--bin.tar.gz +``` + +--- + +## Step 2: Extract the Archive + +Extract the downloaded tar.gz file to your desired directory: + +```bash +tar -xzvf apache-polaris--bin.tar.gz +cd apache-polaris- +``` + +*Replace `` with the actual version number.* + +--- + +## Step 3: Configure Polaris (Optional) + +Edit the `application.properties` file if needed. For example: + +```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 +``` + +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 +``` + +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 +``` + +--- + +## Additional Resources + +- See the official Apache Polaris documentation for details. +- Use ./bin/polaris-admin in the binary for admin and maintenance tasks. + +--- + +Get started with Apache Polaris binaries. See repo for containers and more. + +--- + +*Happy data cataloging with Apache Polaris!* + +--- + +**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. + +--- diff --git a/site/content/in-dev/unreleased/getting-started/quickstart.md b/site/content/in-dev/unreleased/getting-started/quickstart.md index 6d92c1635a..b7bfcb2f46 100644 --- a/site/content/in-dev/unreleased/getting-started/quickstart.md +++ b/site/content/in-dev/unreleased/getting-started/quickstart.md @@ -114,3 +114,6 @@ docker run --name trino -d -p 8080:8080 trinodb/trino ## Next Steps Congrats, you now have a running instance of Polaris! For further information regarding how to use Polaris, check out the [Using Polaris]({{% ref "using-polaris" %}}) page. + + + From 83cbb871d91c567089544b451194d029da56ea5b Mon Sep 17 00:00:00 2001 From: Subham Date: Thu, 7 Aug 2025 09:03:01 +0530 Subject: [PATCH 4/7] Update quickstart.md removing blank spaces. --- site/content/in-dev/unreleased/getting-started/quickstart.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/site/content/in-dev/unreleased/getting-started/quickstart.md b/site/content/in-dev/unreleased/getting-started/quickstart.md index b7bfcb2f46..6d92c1635a 100644 --- a/site/content/in-dev/unreleased/getting-started/quickstart.md +++ b/site/content/in-dev/unreleased/getting-started/quickstart.md @@ -114,6 +114,3 @@ docker run --name trino -d -p 8080:8080 trinodb/trino ## Next Steps Congrats, you now have a running instance of Polaris! For further information regarding how to use Polaris, check out the [Using Polaris]({{% ref "using-polaris" %}}) page. - - - From 456997f08ab3506ea9a1c074381cf1c518fc74e1 Mon Sep 17 00:00:00 2001 From: Subham Date: Fri, 8 Aug 2025 06:36:51 +0530 Subject: [PATCH 5/7] Update _index.md updating the link. --- site/content/in-dev/unreleased/getting-started/_index.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/site/content/in-dev/unreleased/getting-started/_index.md b/site/content/in-dev/unreleased/getting-started/_index.md index c65d05d1f6..4ca3cfd3f1 100644 --- a/site/content/in-dev/unreleased/getting-started/_index.md +++ b/site/content/in-dev/unreleased/getting-started/_index.md @@ -50,9 +50,7 @@ java -version 2. Download the latest binary archive file, for example: ```bash -apache-polaris--bin.tar.gz -``` - +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 From 81b9ce51f87cb086153ddc240ff54b1775d435a7 Mon Sep 17 00:00:00 2001 From: Subham Date: Fri, 8 Aug 2025 22:41:41 +0530 Subject: [PATCH 6/7] Update _index.md removing the bash commands which are not in use. --- site/content/in-dev/unreleased/getting-started/_index.md | 1 - 1 file changed, 1 deletion(-) diff --git a/site/content/in-dev/unreleased/getting-started/_index.md b/site/content/in-dev/unreleased/getting-started/_index.md index 4ca3cfd3f1..e3a5e357e2 100644 --- a/site/content/in-dev/unreleased/getting-started/_index.md +++ b/site/content/in-dev/unreleased/getting-started/_index.md @@ -58,7 +58,6 @@ curl -L https://downloads.apache.org/incubator/polaris/1.0.0-incubating/polaris- Extract the downloaded tar.gz file to your desired directory: ```bash -tar -xzvf apache-polaris--bin.tar.gz cd apache-polaris- ``` From 74b9a5e577430b82048cba6b8ebe4045bd855ce1 Mon Sep 17 00:00:00 2001 From: Subham Date: Sat, 9 Aug 2025 08:02:17 +0530 Subject: [PATCH 7/7] Update _index.md --- .../unreleased/getting-started/_index.md | 23 ++++--------------- 1 file changed, 5 insertions(+), 18 deletions(-) diff --git a/site/content/in-dev/unreleased/getting-started/_index.md b/site/content/in-dev/unreleased/getting-started/_index.md index e3a5e357e2..a97bb34c5b 100644 --- a/site/content/in-dev/unreleased/getting-started/_index.md +++ b/site/content/in-dev/unreleased/getting-started/_index.md @@ -38,8 +38,6 @@ Quickly start Apache Polaris by running the pre-built binary, no build needed. java -version ``` -- Basic familiarity with running commands in your operating system terminal. - --- ## Step 1: Download the Apache Polaris Binary @@ -58,11 +56,9 @@ curl -L https://downloads.apache.org/incubator/polaris/1.0.0-incubating/polaris- Extract the downloaded tar.gz file to your desired directory: ```bash -cd apache-polaris- +cd apache-polaris-1.0.0-incubating-bin ``` -*Replace `` with the actual version number.* - --- ## Step 3: Configure Polaris (Optional) @@ -117,20 +113,11 @@ To stop the server, run: ## Additional Resources -- See the official Apache Polaris documentation for details. -- Use ./bin/polaris-admin in the binary for admin and maintenance tasks. - ---- - -Get started with Apache Polaris binaries. See repo for containers and more. - ---- - -*Happy data cataloging with Apache Polaris!* - +- See the [official Apache Polaris documentation](https://polaris.apache.org/docs/) for comprehensive information on configuration, deployment, and usage. +- Use `./bin/polaris-admin` in the binary distribution for administrative and maintenance tasks. + --- -**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. +Get started with Apache Polaris binaries. See the [repository](https://github.com/apache/polaris) for container images and more resources, or check out the [Quickstart guide](https://polaris.apache.org/in-dev/unreleased/getting-started/quickstart/) for developer instructions and advanced setup. ---