Skip to content

Commit 94dfb79

Browse files
adnanhemaniwilliamhyun
authored andcommitted
fix(quickstart): Correct Quickstart Instructions (apache#1673)
1 parent 4a4804b commit 94dfb79

File tree

8 files changed

+31
-31
lines changed

8 files changed

+31
-31
lines changed

getting-started/assets/cloud_providers/deploy-aws.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ POSTGRES_ADDR=$(echo $DESCRIBE_DB | jq -r '.["DBInstances"][0]["Endpoint"]' | jq
7070
export QUARKUS_DATASOURCE_JDBC_URL=$(printf '%s' "jdbc:postgresql://$POSTGRES_ADDR/POLARIS")
7171
export QUARKUS_DATASOURCE_USERNAME=postgres
7272
export QUARKUS_DATASOURCE_PASSWORD=postgres
73-
echo ($QUARKUS_DATASOURCE_JDBC_URL)
73+
echo $QUARKUS_DATASOURCE_JDBC_URL
7474

7575
S3_BUCKET_NAME="polaris-quickstart-s3-$RANDOM_SUFFIX"
7676
echo "S3 Bucket Name: $S3_BUCKET_NAME"
@@ -84,4 +84,4 @@ export STORAGE_LOCATION="s3://$S3_BUCKET_NAME/quickstart_catalog/"
8484
-Dquarkus.container-image.build=true \
8585
--no-build-cache
8686

87-
docker compose -f getting-started/jdbc/docker-compose-bootstrap-db.yml -f getting-started/jdbc/docker-compose.yml up -d
87+
docker compose -p polaris -f getting-started/jdbc/docker-compose-bootstrap-db.yml -f getting-started/jdbc/docker-compose.yml up -d

getting-started/assets/cloud_providers/deploy-azure.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ POSTGRES_ADDR=$(echo $CREATE_DB_RESPONSE | jq -r '.host')
3232
export QUARKUS_DATASOURCE_JDBC_URL=$(printf '%s' "jdbc:postgresql://$POSTGRES_ADDR/POLARIS")
3333
export QUARKUS_DATASOURCE_USERNAME=postgres
3434
export QUARKUS_DATASOURCE_PASSWORD=postgres
35-
echo ($QUARKUS_DATASOURCE_JDBC_URL)
35+
echo $QUARKUS_DATASOURCE_JDBC_URL
3636

3737
STORAGE_ACCOUNT_NAME="polaristest$RANDOM_SUFFIX"
3838
STORAGE_CONTAINER_NAME="polaris-test-container-$RANDOM_SUFFIX"
@@ -71,4 +71,4 @@ EOF
7171
-Dquarkus.container-image.build=true \
7272
--no-build-cache
7373

74-
docker compose -f getting-started/jdbc/docker-compose-bootstrap-db.yml -f getting-started/jdbc/docker-compose.yml up -d
74+
docker compose -p polaris -f getting-started/jdbc/docker-compose-bootstrap-db.yml -f getting-started/jdbc/docker-compose.yml up -d

getting-started/assets/cloud_providers/deploy-gcp.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ gcloud sql databases create POLARIS --instance=$DB_INSTANCE_NAME
3939
export QUARKUS_DATASOURCE_JDBC_URL=$(printf '%s' "jdbc:postgresql://$POSTGRES_ADDR/POLARIS")
4040
export QUARKUS_DATASOURCE_USERNAME=postgres
4141
export QUARKUS_DATASOURCE_PASSWORD=postgres
42-
echo ($QUARKUS_DATASOURCE_JDBC_URL)
42+
echo $QUARKUS_DATASOURCE_JDBC_URL
4343

4444
GCS_BUCKET_NAME="polaris-test-gcs-$RANDOM_SUFFIX"
4545
echo "GCS Bucket Name: $GCS_BUCKET_NAME"
@@ -52,4 +52,4 @@ export STORAGE_LOCATION="gs://$GCS_BUCKET_NAME/quickstart_catalog/"
5252
-Dquarkus.container-image.build=true \
5353
--no-build-cache
5454

55-
docker compose -f getting-started/jdbc/docker-compose-bootstrap-db.yml -f getting-started/jdbc/docker-compose.yml up -d
55+
docker compose -p polaris -f getting-started/jdbc/docker-compose-bootstrap-db.yml -f getting-started/jdbc/docker-compose.yml up -d

site/content/in-dev/unreleased/getting-started/deploying-polaris/quickstart-deploy-aws.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -38,21 +38,20 @@ The requirements to run the script below are:
3838
```shell
3939
chmod +x getting-started/assets/cloud_providers/deploy-aws.sh
4040
export ASSETS_PATH=$(pwd)/getting-started/assets/
41-
./getting-started/assets/cloud_providers/deploy-aws.sh
42-
```
43-
44-
Also, set the following static credentials for interacting with the Polaris server in the following exercises:
45-
46-
```shell
4741
export CLIENT_ID=root
4842
export CLIENT_SECRET=s3cr3t
43+
./getting-started/assets/cloud_providers/deploy-aws.sh
4944
```
5045

46+
## Next Steps
47+
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.
48+
49+
## Cleanup Instructions
5150
To shut down the Polaris server, run the following commands:
5251

5352
```shell
5453
export ASSETS_PATH=$(pwd)/getting-started/assets/
55-
docker compose -f getting-started/eclipselink/docker-compose.yml down
54+
docker compose -p polaris -f getting-started/eclipselink/docker-compose.yml down
5655
```
5756

5857
To deploy Polaris in a production setting, please review further recommendations at the [Configuring Polaris for Production]({{% relref "../../configuring-polaris-for-production" %}}) page.

site/content/in-dev/unreleased/getting-started/deploying-polaris/quickstart-deploy-azure.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,21 +33,20 @@ The requirements to run the script below are:
3333
```shell
3434
chmod +x getting-started/assets/cloud_providers/deploy-azure.sh
3535
export ASSETS_PATH=$(pwd)/getting-started/assets/
36-
./getting-started/assets/cloud_providers/deploy-azure.sh
37-
```
38-
39-
Also, set the following static credentials for interacting with the Polaris server in the following exercises:
40-
41-
```shell
4236
export CLIENT_ID=root
4337
export CLIENT_SECRET=s3cr3t
38+
./getting-started/assets/cloud_providers/deploy-azure.sh
4439
```
4540

41+
## Next Steps
42+
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.
43+
44+
## Cleanup Instructions
4645
To shut down the Polaris server, run the following commands:
4746

4847
```shell
4948
export ASSETS_PATH=$(pwd)/getting-started/assets/
50-
docker compose -f getting-started/eclipselink/docker-compose.yml down
49+
docker compose -p polaris -f getting-started/eclipselink/docker-compose.yml down
5150
```
5251

5352
To deploy Polaris in a production setting, please review further recommendations at the [Configuring Polaris for Production]({{% relref "../../configuring-polaris-for-production" %}}) page.

site/content/in-dev/unreleased/getting-started/deploying-polaris/quickstart-deploy-gcp.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,21 +33,20 @@ The requirements to run the script below are:
3333
```shell
3434
chmod +x getting-started/assets/cloud_providers/deploy-gcp.sh
3535
export ASSETS_PATH=$(pwd)/getting-started/assets/
36-
./getting-started/assets/cloud_providers/deploy-gcp.sh
37-
```
38-
39-
Also, set the following static credentials for interacting with the Polaris server in the following exercises:
40-
41-
```shell
4236
export CLIENT_ID=root
4337
export CLIENT_SECRET=s3cr3t
38+
./getting-started/assets/cloud_providers/deploy-gcp.sh
4439
```
4540

41+
## Next Steps
42+
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.
43+
44+
## Cleanup Instructions
4645
To shut down the Polaris server, run the following commands:
4746

4847
```shell
4948
export ASSETS_PATH=$(pwd)/getting-started/assets/
50-
docker compose -f getting-started/eclipselink/docker-compose.yml down
49+
docker compose -p polaris -f getting-started/eclipselink/docker-compose.yml down
5150
```
5251

5352
To deploy Polaris in a production setting, please review further recommendations at the [Configuring Polaris for Production]({{% relref "../../configuring-polaris-for-production" %}}) page.

site/content/in-dev/unreleased/getting-started/quickstart.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,11 +45,14 @@ To start using Polaris in Docker and launch Polaris, which is packaged with a Po
4545

4646
```shell
4747
export ASSETS_PATH=$(pwd)/getting-started/assets/
48+
export QUARKUS_DATASOURCE_JDBC_URL=jdbc:postgresql://postgres:5432/POLARIS
49+
export QUARKUS_DATASOURCE_USERNAME=postgres
50+
export QUARKUS_DATASOURCE_PASSWORD=postgres
4851
export CLIENT_ID=root
4952
export CLIENT_SECRET=s3cr3t
5053
docker compose -p polaris -f getting-started/assets/postgres/docker-compose-postgres.yml \
51-
-f getting-started/eclipselink/docker-compose-bootstrap-db.yml \
52-
-f getting-started/eclipselink/docker-compose.yml up
54+
-f getting-started/jdbc/docker-compose-bootstrap-db.yml \
55+
-f getting-started/jdbc/docker-compose.yml up -d
5356
```
5457

5558
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:

site/content/in-dev/unreleased/getting-started/using-polaris.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ weight: 400
2424

2525
## Setup
2626

27-
Define your `CLIENT_ID` & `CLIENT_SECRET` and export them for future use.
27+
Ensure your `CLIENT_ID` & `CLIENT_SECRET` variables are already defined, as they were required for starting the Polaris server earlier.
2828

2929
```shell
3030
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 "
309309
* 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).
310310
* 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.
311311
```shell
312-
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
312+
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
313313
```
314314

315315

0 commit comments

Comments
 (0)