This is an automated email from the ASF dual-hosted git repository.
yufei pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/polaris.git
The following commit(s) were added to refs/heads/main by this push:
new 5750f4e39 fix(quickstart): Correct Quickstart Instructions (#1673)
5750f4e39 is described below
commit 5750f4e3927ee2d9dd23c842bbb6ee8a54061eaf
Author: Adnan Hemani <adna...@berkeley.edu>
AuthorDate: Tue May 27 11:58:51 2025 -0700
fix(quickstart): Correct Quickstart Instructions (#1673)
---
getting-started/assets/cloud_providers/deploy-aws.sh | 4 ++--
getting-started/assets/cloud_providers/deploy-azure.sh | 4 ++--
getting-started/assets/cloud_providers/deploy-gcp.sh | 4 ++--
.../deploying-polaris/quickstart-deploy-aws.md | 13 ++++++-------
.../deploying-polaris/quickstart-deploy-azure.md | 13 ++++++-------
.../deploying-polaris/quickstart-deploy-gcp.md | 13 ++++++-------
.../content/in-dev/unreleased/getting-started/quickstart.md | 7 +++++--
.../in-dev/unreleased/getting-started/using-polaris.md | 4 ++--
8 files changed, 31 insertions(+), 31 deletions(-)
diff --git a/getting-started/assets/cloud_providers/deploy-aws.sh
b/getting-started/assets/cloud_providers/deploy-aws.sh
index 82e811fb3..aceefb51c 100644
--- a/getting-started/assets/cloud_providers/deploy-aws.sh
+++ b/getting-started/assets/cloud_providers/deploy-aws.sh
@@ -70,7 +70,7 @@ POSTGRES_ADDR=$(echo $DESCRIBE_DB | jq -r
'.["DBInstances"][0]["Endpoint"]' | jq
export QUARKUS_DATASOURCE_JDBC_URL=$(printf '%s'
"jdbc:postgresql://$POSTGRES_ADDR/POLARIS")
export QUARKUS_DATASOURCE_USERNAME=postgres
export QUARKUS_DATASOURCE_PASSWORD=postgres
-echo ($QUARKUS_DATASOURCE_JDBC_URL)
+echo $QUARKUS_DATASOURCE_JDBC_URL
S3_BUCKET_NAME="polaris-quickstart-s3-$RANDOM_SUFFIX"
echo "S3 Bucket Name: $S3_BUCKET_NAME"
@@ -84,4 +84,4 @@ export
STORAGE_LOCATION="s3://$S3_BUCKET_NAME/quickstart_catalog/"
-Dquarkus.container-image.build=true \
--no-build-cache
-docker compose -f getting-started/jdbc/docker-compose-bootstrap-db.yml -f
getting-started/jdbc/docker-compose.yml up -d
+docker compose -p polaris -f
getting-started/jdbc/docker-compose-bootstrap-db.yml -f
getting-started/jdbc/docker-compose.yml up -d
diff --git a/getting-started/assets/cloud_providers/deploy-azure.sh
b/getting-started/assets/cloud_providers/deploy-azure.sh
index 764c18dc5..c6a76e4f1 100644
--- a/getting-started/assets/cloud_providers/deploy-azure.sh
+++ b/getting-started/assets/cloud_providers/deploy-azure.sh
@@ -32,7 +32,7 @@ POSTGRES_ADDR=$(echo $CREATE_DB_RESPONSE | jq -r '.host')
export QUARKUS_DATASOURCE_JDBC_URL=$(printf '%s'
"jdbc:postgresql://$POSTGRES_ADDR/POLARIS")
export QUARKUS_DATASOURCE_USERNAME=postgres
export QUARKUS_DATASOURCE_PASSWORD=postgres
-echo ($QUARKUS_DATASOURCE_JDBC_URL)
+echo $QUARKUS_DATASOURCE_JDBC_URL
STORAGE_ACCOUNT_NAME="polaristest$RANDOM_SUFFIX"
STORAGE_CONTAINER_NAME="polaris-test-container-$RANDOM_SUFFIX"
@@ -71,4 +71,4 @@ EOF
-Dquarkus.container-image.build=true \
--no-build-cache
-docker compose -f getting-started/jdbc/docker-compose-bootstrap-db.yml -f
getting-started/jdbc/docker-compose.yml up -d
+docker compose -p polaris -f
getting-started/jdbc/docker-compose-bootstrap-db.yml -f
getting-started/jdbc/docker-compose.yml up -d
diff --git a/getting-started/assets/cloud_providers/deploy-gcp.sh
b/getting-started/assets/cloud_providers/deploy-gcp.sh
index e6ed2cfb4..fd57d9d79 100644
--- a/getting-started/assets/cloud_providers/deploy-gcp.sh
+++ b/getting-started/assets/cloud_providers/deploy-gcp.sh
@@ -39,7 +39,7 @@ gcloud sql databases create POLARIS
--instance=$DB_INSTANCE_NAME
export QUARKUS_DATASOURCE_JDBC_URL=$(printf '%s'
"jdbc:postgresql://$POSTGRES_ADDR/POLARIS")
export QUARKUS_DATASOURCE_USERNAME=postgres
export QUARKUS_DATASOURCE_PASSWORD=postgres
-echo ($QUARKUS_DATASOURCE_JDBC_URL)
+echo $QUARKUS_DATASOURCE_JDBC_URL
GCS_BUCKET_NAME="polaris-test-gcs-$RANDOM_SUFFIX"
echo "GCS Bucket Name: $GCS_BUCKET_NAME"
@@ -52,4 +52,4 @@ export
STORAGE_LOCATION="gs://$GCS_BUCKET_NAME/quickstart_catalog/"
-Dquarkus.container-image.build=true \
--no-build-cache
-docker compose -f getting-started/jdbc/docker-compose-bootstrap-db.yml -f
getting-started/jdbc/docker-compose.yml up -d
+docker compose -p polaris -f
getting-started/jdbc/docker-compose-bootstrap-db.yml -f
getting-started/jdbc/docker-compose.yml up -d
diff --git
a/site/content/in-dev/unreleased/getting-started/deploying-polaris/quickstart-deploy-aws.md
b/site/content/in-dev/unreleased/getting-started/deploying-polaris/quickstart-deploy-aws.md
index 8754408c8..8aa3b34a7 100644
---
a/site/content/in-dev/unreleased/getting-started/deploying-polaris/quickstart-deploy-aws.md
+++
b/site/content/in-dev/unreleased/getting-started/deploying-polaris/quickstart-deploy-aws.md
@@ -38,21 +38,20 @@ The requirements to run the script below are:
```shell
chmod +x getting-started/assets/cloud_providers/deploy-aws.sh
export ASSETS_PATH=$(pwd)/getting-started/assets/
-./getting-started/assets/cloud_providers/deploy-aws.sh
-```
-
-Also, set the following static credentials for interacting with the Polaris
server in the following exercises:
-
-```shell
export CLIENT_ID=root
export CLIENT_SECRET=s3cr3t
+./getting-started/assets/cloud_providers/deploy-aws.sh
```
+## Next Steps
+Congrats, you now have a running instance of1 Polaris! For details on how to
use Polaris, check out the [Using Polaris]({{% ref "using-polaris" %}}) page.
+
+## Cleanup Instructions
To shut down the Polaris server, run the following commands:
```shell
export ASSETS_PATH=$(pwd)/getting-started/assets/
-docker compose -f getting-started/eclipselink/docker-compose.yml down
+docker compose -p polaris -f getting-started/eclipselink/docker-compose.yml
down
```
To deploy Polaris in a production setting, please review further
recommendations at the [Configuring Polaris for Production]({{% relref
"../../configuring-polaris-for-production" %}}) page.
\ No newline at end of file
diff --git
a/site/content/in-dev/unreleased/getting-started/deploying-polaris/quickstart-deploy-azure.md
b/site/content/in-dev/unreleased/getting-started/deploying-polaris/quickstart-deploy-azure.md
index 53ab57a9a..ff1f2c647 100644
---
a/site/content/in-dev/unreleased/getting-started/deploying-polaris/quickstart-deploy-azure.md
+++
b/site/content/in-dev/unreleased/getting-started/deploying-polaris/quickstart-deploy-azure.md
@@ -33,21 +33,20 @@ The requirements to run the script below are:
```shell
chmod +x getting-started/assets/cloud_providers/deploy-azure.sh
export ASSETS_PATH=$(pwd)/getting-started/assets/
-./getting-started/assets/cloud_providers/deploy-azure.sh
-```
-
-Also, set the following static credentials for interacting with the Polaris
server in the following exercises:
-
-```shell
export CLIENT_ID=root
export CLIENT_SECRET=s3cr3t
+./getting-started/assets/cloud_providers/deploy-azure.sh
```
+## 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.
+
+## Cleanup Instructions
To shut down the Polaris server, run the following commands:
```shell
export ASSETS_PATH=$(pwd)/getting-started/assets/
-docker compose -f getting-started/eclipselink/docker-compose.yml down
+docker compose -p polaris -f getting-started/eclipselink/docker-compose.yml
down
```
To deploy Polaris in a production setting, please review further
recommendations at the [Configuring Polaris for Production]({{% relref
"../../configuring-polaris-for-production" %}}) page.
\ No newline at end of file
diff --git
a/site/content/in-dev/unreleased/getting-started/deploying-polaris/quickstart-deploy-gcp.md
b/site/content/in-dev/unreleased/getting-started/deploying-polaris/quickstart-deploy-gcp.md
index d76d82b74..cbf15a876 100644
---
a/site/content/in-dev/unreleased/getting-started/deploying-polaris/quickstart-deploy-gcp.md
+++
b/site/content/in-dev/unreleased/getting-started/deploying-polaris/quickstart-deploy-gcp.md
@@ -33,21 +33,20 @@ The requirements to run the script below are:
```shell
chmod +x getting-started/assets/cloud_providers/deploy-gcp.sh
export ASSETS_PATH=$(pwd)/getting-started/assets/
-./getting-started/assets/cloud_providers/deploy-gcp.sh
-```
-
-Also, set the following static credentials for interacting with the Polaris
server in the following exercises:
-
-```shell
export CLIENT_ID=root
export CLIENT_SECRET=s3cr3t
+./getting-started/assets/cloud_providers/deploy-gcp.sh
```
+## 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.
+
+## Cleanup Instructions
To shut down the Polaris server, run the following commands:
```shell
export ASSETS_PATH=$(pwd)/getting-started/assets/
-docker compose -f getting-started/eclipselink/docker-compose.yml down
+docker compose -p polaris -f getting-started/eclipselink/docker-compose.yml
down
```
To deploy Polaris in a production setting, please review further
recommendations at the [Configuring Polaris for Production]({{% relref
"../../configuring-polaris-for-production" %}}) page.
\ No newline at end of file
diff --git a/site/content/in-dev/unreleased/getting-started/quickstart.md
b/site/content/in-dev/unreleased/getting-started/quickstart.md
index d59d76ac7..6fac350e8 100644
--- a/site/content/in-dev/unreleased/getting-started/quickstart.md
+++ b/site/content/in-dev/unreleased/getting-started/quickstart.md
@@ -45,11 +45,14 @@ To start using Polaris in Docker and launch Polaris, which
is packaged with a Po
```shell
export ASSETS_PATH=$(pwd)/getting-started/assets/
+export QUARKUS_DATASOURCE_JDBC_URL=jdbc:postgresql://postgres:5432/POLARIS
+export QUARKUS_DATASOURCE_USERNAME=postgres
+export QUARKUS_DATASOURCE_PASSWORD=postgres
export CLIENT_ID=root
export CLIENT_SECRET=s3cr3t
docker compose -p polaris -f
getting-started/assets/postgres/docker-compose-postgres.yml \
- -f getting-started/eclipselink/docker-compose-bootstrap-db.yml \
- -f getting-started/eclipselink/docker-compose.yml up
+ -f getting-started/jdbc/docker-compose-bootstrap-db.yml \
+ -f getting-started/jdbc/docker-compose.yml up -d
```
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:
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 9c01d1c16..35f0bae33 100644
--- a/site/content/in-dev/unreleased/getting-started/using-polaris.md
+++ b/site/content/in-dev/unreleased/getting-started/using-polaris.md
@@ -24,7 +24,7 @@ weight: 400
## Setup
-Define your `CLIENT_ID` & `CLIENT_SECRET` and export them for future use.
+Ensure your `CLIENT_ID` & `CLIENT_SECRET` variables are already defined, as
they were required for starting the Polaris server earlier.
```shell
export CLIENT_ID=YOUR_CLIENT_ID
@@ -309,7 +309,7 @@ curl -v
http://127.0.0.1:8181/api/management/v1/catalogs/quickstart_catalog -H "
* 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
+docker compose -p polaris -f
getting-started/assets/postgres/docker-compose-postgres.yml -f
getting-started/jdbc/docker-compose-bootstrap-db.yml -f
getting-started/jdbc/docker-compose.yml down
```
