From 48292387f232125f258507704c808c93c7354fe6 Mon Sep 17 00:00:00 2001 From: adnanhemani Date: Tue, 29 Apr 2025 18:22:56 -0700 Subject: [PATCH 1/4] Fix Outdated Information and Add Information regarding docker compose down to Quickstart --- .../in-dev/unreleased/getting-started/quickstart.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/site/content/in-dev/unreleased/getting-started/quickstart.md b/site/content/in-dev/unreleased/getting-started/quickstart.md index 3ca17de4b1..f6dde56e23 100644 --- a/site/content/in-dev/unreleased/getting-started/quickstart.md +++ b/site/content/in-dev/unreleased/getting-started/quickstart.md @@ -36,7 +36,7 @@ cd ~/polaris :polaris-quarkus-admin:assemble --rerun \ -Dquarkus.container-image.tag=postgres-latest \ -Dquarkus.container-image.build=true -docker compose -f getting-started/eclipselink/docker-compose.yml up +docker compose -f getting-started/eclipselink/docker-compose-postgres.yml -f getting-started/eclipselink/docker-compose-bootstrap-db.yml -f getting-started/eclipselink/docker-compose.yml up ``` You should see output for some time as Polaris, Spark, and Trino build and start up. Eventually, you won’t see any more logs and see some logs relating to Spark, resembling the following: @@ -55,7 +55,13 @@ export CLIENT_ID=root export CLIENT_SECRET=s3cr3t ``` -The Docker image pre-configures a sample catalog called `polaris_demo` that uses a local file system. +The Docker image pre-configures a sample catalog called `quickstart_catalog` that uses a local file system. + +To shut down the Polaris server and clean up the Docker containers, run the following command: + +```shell +docker compose -f getting-started/eclipselink/docker-compose-postgres.yml -f getting-started/eclipselink/docker-compose-bootstrap-db.yml -f getting-started/eclipselink/docker-compose.yml down +``` ## Running Polaris as a Standalone Process From 742074d4b3312447cf5d9533e32f6a94d7926a0d Mon Sep 17 00:00:00 2001 From: adnanhemani Date: Tue, 29 Apr 2025 18:41:24 -0700 Subject: [PATCH 2/4] Revision 2 --- getting-started/eclipselink/README.md | 6 ++++++ .../content/in-dev/unreleased/getting-started/quickstart.md | 6 ------ .../in-dev/unreleased/getting-started/using-polaris.md | 4 ++++ 3 files changed, 10 insertions(+), 6 deletions(-) diff --git a/getting-started/eclipselink/README.md b/getting-started/eclipselink/README.md index 29c75adc9e..386710e353 100644 --- a/getting-started/eclipselink/README.md +++ b/getting-started/eclipselink/README.md @@ -90,3 +90,9 @@ CREATE SCHEMA iceberg.tpch; CREATE TABLE iceberg.tpch.test_polaris AS SELECT 1 x; SELECT * FROM iceberg.tpch.test_polaris; ``` + +7. To shut down the Polaris instance and clean up all Docker containers, run the following command: +```shell +docker compose -f getting-started/eclipselink/docker-compose-postgres.yml -f getting-started/eclipselink/docker-compose-bootstrap-db.yml -f getting-started/eclipselink/docker-compose.yml down +``` + diff --git a/site/content/in-dev/unreleased/getting-started/quickstart.md b/site/content/in-dev/unreleased/getting-started/quickstart.md index f6dde56e23..166d87ba1a 100644 --- a/site/content/in-dev/unreleased/getting-started/quickstart.md +++ b/site/content/in-dev/unreleased/getting-started/quickstart.md @@ -57,12 +57,6 @@ export CLIENT_SECRET=s3cr3t The Docker image pre-configures a sample catalog called `quickstart_catalog` that uses a local file system. -To shut down the Polaris server and clean up the Docker containers, run the following command: - -```shell -docker compose -f getting-started/eclipselink/docker-compose-postgres.yml -f getting-started/eclipselink/docker-compose-bootstrap-db.yml -f getting-started/eclipselink/docker-compose.yml down -``` - ## Running Polaris as a Standalone Process You can also start Polaris through Gradle (packaged within the Polaris repository): diff --git a/site/content/in-dev/unreleased/getting-started/using-polaris.md b/site/content/in-dev/unreleased/getting-started/using-polaris.md index b0fcb2e047..469be8fa63 100644 --- a/site/content/in-dev/unreleased/getting-started/using-polaris.md +++ b/site/content/in-dev/unreleased/getting-started/using-polaris.md @@ -303,5 +303,9 @@ curl -v http://127.0.0.1:8181/api/management/v1/catalogs/quickstart_catalog -H " ## Next Steps * Visit [Configuring Polaris for Production]({{% relref "../configuring-polaris-for-production" %}}). * A Getting Started experience for using Spark with Jupyter Notebooks is documented [here](https://github.com/apache/polaris/blob/main/getting-started/spark/README.md). +* To shut down a locally-deployed Polaris server and clean up all related Docker containers, run the command listed below. Cloud Deployments have their respective termination commands on their Deployment page, while Polaris running on Gradle will terminate when the Gradle process terminates. +```shell +docker compose -f getting-started/eclipselink/docker-compose-postgres.yml -f getting-started/eclipselink/docker-compose-bootstrap-db.yml -f getting-started/eclipselink/docker-compose.yml down +``` From e9a2ce2f31c2da6898d03b177e36e9e7a02b1b3e Mon Sep 17 00:00:00 2001 From: adnanhemani Date: Tue, 29 Apr 2025 18:59:09 -0700 Subject: [PATCH 3/4] Remove shutdown from README --- getting-started/eclipselink/README.md | 5 ----- 1 file changed, 5 deletions(-) diff --git a/getting-started/eclipselink/README.md b/getting-started/eclipselink/README.md index 386710e353..750a254a3e 100644 --- a/getting-started/eclipselink/README.md +++ b/getting-started/eclipselink/README.md @@ -90,9 +90,4 @@ CREATE SCHEMA iceberg.tpch; CREATE TABLE iceberg.tpch.test_polaris AS SELECT 1 x; SELECT * FROM iceberg.tpch.test_polaris; ``` - -7. To shut down the Polaris instance and clean up all Docker containers, run the following command: -```shell -docker compose -f getting-started/eclipselink/docker-compose-postgres.yml -f getting-started/eclipselink/docker-compose-bootstrap-db.yml -f getting-started/eclipselink/docker-compose.yml down -``` From b4dc82d8e9baae266005660f4ea6eaf3ff8f41c3 Mon Sep 17 00:00:00 2001 From: adnanhemani Date: Tue, 29 Apr 2025 18:59:36 -0700 Subject: [PATCH 4/4] typo --- getting-started/eclipselink/README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/getting-started/eclipselink/README.md b/getting-started/eclipselink/README.md index 750a254a3e..29c75adc9e 100644 --- a/getting-started/eclipselink/README.md +++ b/getting-started/eclipselink/README.md @@ -90,4 +90,3 @@ CREATE SCHEMA iceberg.tpch; CREATE TABLE iceberg.tpch.test_polaris AS SELECT 1 x; SELECT * FROM iceberg.tpch.test_polaris; ``` -