From ed725962261205c891586225ca48e7c3f06463fe Mon Sep 17 00:00:00 2001 From: owenowenisme Date: Fri, 25 Apr 2025 23:46:50 +0800 Subject: [PATCH 1/6] added set env in README Signed-off-by: owenowenisme --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 7e443acc26..08c2a26244 100644 --- a/README.md +++ b/README.md @@ -71,6 +71,10 @@ Apache Polaris is built using Gradle with Java 21+ and Docker 27+. - `./gradlew run` - To run the Polaris server locally; the server is reachable at localhost:8181. This is also suitable for running regression tests, or for connecting with Spark. - `./regtests/run_spark_sql.sh` - To connect from Spark SQL. Here are some example commands to run in the Spark SQL shell: +- Set your own credentials using the environment variable `POLARIS_BOOTSTRAP_CREDENTIALS=POLARIS,root,s3cr3t` where: + - `POLARIS` is the realm + - `root` is the CLIENT_ID + - `s3cr3t` is the CLIENT_SECRET ```sql create database db1; show databases; From b53b0961834051cc88d548b888a3286d439dd435 Mon Sep 17 00:00:00 2001 From: owenowenisme Date: Fri, 25 Apr 2025 23:52:48 +0800 Subject: [PATCH 2/6] fix Signed-off-by: owenowenisme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 08c2a26244..93f55d2f4e 100644 --- a/README.md +++ b/README.md @@ -71,7 +71,7 @@ Apache Polaris is built using Gradle with Java 21+ and Docker 27+. - `./gradlew run` - To run the Polaris server locally; the server is reachable at localhost:8181. This is also suitable for running regression tests, or for connecting with Spark. - `./regtests/run_spark_sql.sh` - To connect from Spark SQL. Here are some example commands to run in the Spark SQL shell: -- Set your own credentials using the environment variable `POLARIS_BOOTSTRAP_CREDENTIALS=POLARIS,root,s3cr3t` where: +- Set your own credentials using the environment variable `export POLARIS_BOOTSTRAP_CREDENTIALS=POLARIS,root,s3cr3t` where: - `POLARIS` is the realm - `root` is the CLIENT_ID - `s3cr3t` is the CLIENT_SECRET From 919e59e50e8010362f74d9f2bd129bc6840245b6 Mon Sep 17 00:00:00 2001 From: owenowenisme Date: Sat, 26 Apr 2025 07:37:43 +0800 Subject: [PATCH 3/6] update readme Signed-off-by: owenowenisme --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 93f55d2f4e..a6201d522d 100644 --- a/README.md +++ b/README.md @@ -69,12 +69,13 @@ Apache Polaris is built using Gradle with Java 21+ and Docker 27+. - `./gradlew assemble` - To skip tests. - `./gradlew test` - To run unit tests and integration tests. - `./gradlew run` - To run the Polaris server locally; the server is reachable at - localhost:8181. This is also suitable for running regression tests, or for connecting with Spark. + localhost:8181. This is also suitable for running regression tests, or for connecting with Spark. + - If you start Polaris as a direct java process via `./gradlew run`, you can set your own credentials using the environment variable `export POLARIS_BOOTSTRAP_CREDENTIALS=POLARIS,root,secret` where: + - `POLARIS` is the realm + - `root` is the CLIENT_ID + - `secret` is the CLIENT_SECRET + - If credentials are not set, it will use preset credentials `POLARIS,root,secret` - `./regtests/run_spark_sql.sh` - To connect from Spark SQL. Here are some example commands to run in the Spark SQL shell: -- Set your own credentials using the environment variable `export POLARIS_BOOTSTRAP_CREDENTIALS=POLARIS,root,s3cr3t` where: - - `POLARIS` is the realm - - `root` is the CLIENT_ID - - `s3cr3t` is the CLIENT_SECRET ```sql create database db1; show databases; From 8df00b179bb6150efb9f6869ff3d69423478466e Mon Sep 17 00:00:00 2001 From: owenowenisme Date: Sat, 26 Apr 2025 09:31:43 +0800 Subject: [PATCH 4/6] update readme Signed-off-by: owenowenisme --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a6201d522d..4fd1098793 100644 --- a/README.md +++ b/README.md @@ -70,11 +70,11 @@ Apache Polaris is built using Gradle with Java 21+ and Docker 27+. - `./gradlew test` - To run unit tests and integration tests. - `./gradlew run` - To run the Polaris server locally; the server is reachable at localhost:8181. This is also suitable for running regression tests, or for connecting with Spark. - - If you start Polaris as a direct java process via `./gradlew run`, you can set your own credentials using the environment variable `export POLARIS_BOOTSTRAP_CREDENTIALS=POLARIS,root,secret` where: + - If you start Polaris via `./gradlew run`, you can set your own credentials by specifying system property `./gradlew run -Dpolaris.bootstrap.credentials=POLARIS,root,secret` where: - `POLARIS` is the realm - `root` is the CLIENT_ID - `secret` is the CLIENT_SECRET - - If credentials are not set, it will use preset credentials `POLARIS,root,secret` + - If credentials are not set, it will use preset credentials `POLARIS,root,secret` - `./regtests/run_spark_sql.sh` - To connect from Spark SQL. Here are some example commands to run in the Spark SQL shell: ```sql create database db1; From 0f809f904a67164135031c0e4270eb076798f4ce Mon Sep 17 00:00:00 2001 From: owenowenisme Date: Sat, 26 Apr 2025 14:29:06 +0800 Subject: [PATCH 5/6] remove bullet level Signed-off-by: owenowenisme --- README.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 4fd1098793..d444b69bdb 100644 --- a/README.md +++ b/README.md @@ -68,13 +68,12 @@ Apache Polaris is built using Gradle with Java 21+ and Docker 27+. - `./gradlew build` - To build and run tests. Make sure Docker is running, as the integration tests depend on it. - `./gradlew assemble` - To skip tests. - `./gradlew test` - To run unit tests and integration tests. -- `./gradlew run` - To run the Polaris server locally; the server is reachable at - localhost:8181. This is also suitable for running regression tests, or for connecting with Spark. - - If you start Polaris via `./gradlew run`, you can set your own credentials by specifying system property `./gradlew run -Dpolaris.bootstrap.credentials=POLARIS,root,secret` where: - - `POLARIS` is the realm - - `root` is the CLIENT_ID - - `secret` is the CLIENT_SECRET - - If credentials are not set, it will use preset credentials `POLARIS,root,secret` +- `./gradlew run` - To run the Polaris server locally; the server is reachable at + localhost:8181. This is also suitable for running regression tests, or for connecting with Spark. Set your own credentials by specifying system property `./gradlew run -Dpolaris.bootstrap.credentials=POLARIS,root,secret` where: + - `POLARIS` is the realm + - `root` is the CLIENT_ID + - `secret` is the CLIENT_SECRET + - If credentials are not set, it will use preset credentials `POLARIS,root,secret` - `./regtests/run_spark_sql.sh` - To connect from Spark SQL. Here are some example commands to run in the Spark SQL shell: ```sql create database db1; From 2835c1a4c82d365da11213a7c016cdd523d01269 Mon Sep 17 00:00:00 2001 From: owenowenisme Date: Sat, 26 Apr 2025 14:30:07 +0800 Subject: [PATCH 6/6] update Signed-off-by: owenowenisme --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index d444b69bdb..bf887d4aaa 100644 --- a/README.md +++ b/README.md @@ -68,8 +68,7 @@ Apache Polaris is built using Gradle with Java 21+ and Docker 27+. - `./gradlew build` - To build and run tests. Make sure Docker is running, as the integration tests depend on it. - `./gradlew assemble` - To skip tests. - `./gradlew test` - To run unit tests and integration tests. -- `./gradlew run` - To run the Polaris server locally; the server is reachable at - localhost:8181. This is also suitable for running regression tests, or for connecting with Spark. Set your own credentials by specifying system property `./gradlew run -Dpolaris.bootstrap.credentials=POLARIS,root,secret` where: +- `./gradlew run` - To run the Polaris server locally; the server is reachable at localhost:8181. This is also suitable for running regression tests, or for connecting with Spark. Set your own credentials by specifying system property `./gradlew run -Dpolaris.bootstrap.credentials=POLARIS,root,secret` where: - `POLARIS` is the realm - `root` is the CLIENT_ID - `secret` is the CLIENT_SECRET