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 1369461e Docs: adapt quickstart.md to Quarkus (#829)
1369461e is described below
commit 1369461eb98c79ade21a96110fbee6cca5c9a412
Author: Alexandre Dutra <[email protected]>
AuthorDate: Tue Jan 21 20:23:27 2025 +0100
Docs: adapt quickstart.md to Quarkus (#829)
---
site/content/in-dev/unreleased/quickstart.md | 38 ++++++++++++++++++----------
1 file changed, 24 insertions(+), 14 deletions(-)
diff --git a/site/content/in-dev/unreleased/quickstart.md
b/site/content/in-dev/unreleased/quickstart.md
index 1cdb7dab..aa5081dc 100644
--- a/site/content/in-dev/unreleased/quickstart.md
+++ b/site/content/in-dev/unreleased/quickstart.md
@@ -97,42 +97,52 @@ To start using Polaris in Docker, launch Polaris while
Docker is running:
```shell
cd ~/polaris
-docker compose -f docker-compose.yml up --build
+./gradlew clean :polaris-quarkus-server:assemble
-Dquarkus.container-image.build=true
+docker run -p 8181:8181 -p 8182:8182 apache/polaris:latest
```
-Once the `polaris-polaris` container is up, you can continue to [Defining a
Catalog](#defining-a-catalog).
+You should see output for some time as Polaris builds and starts up.
Eventually, you won’t see any more logs and should see messages that resemble
the following:
-### Building Polaris
+```
+INFO [io.quarkus] [,] [,,,] (Quarkus Main Thread) Apache Polaris Server
<version> on JVM (powered by Quarkus <version>) started in 2.656s. Listening
on: http://localhost:8181. Management interface listening on
http://0.0.0.0:8182.
+INFO [io.quarkus] [,] [,,,] (Quarkus Main Thread) Profile prod activated.
+INFO [io.quarkus] [,] [,,,] (Quarkus Main Thread) Installed features: [...]
+```
-Run Polaris locally with:
+### Running Polaris as a Standalone Process
+
+The easiest way to run Polaris locally is to start the Polaris server from the
+`quarkus/server/build` directory (after building Polaris):
```shell
cd ~/polaris
-./gradlew runApp
+# Build the server
+./gradlew clean :polaris-quarkus-server:assemble
+# Start the server
+java -jar quarkus/server/build/quarkus-app/quarkus-run.jar
```
You should see output for some time as Polaris builds and starts up.
Eventually, you won’t see any more logs and should see messages that resemble
the following:
```
-INFO [...] [main] [] o.e.j.s.handler.ContextHandler: Started
i.d.j.MutableServletContextHandler@...
-INFO [...] [main] [] o.e.j.server.AbstractConnector: Started application@...
-INFO [...] [main] [] o.e.j.server.AbstractConnector: Started admin@...
-INFO [...] [main] [] o.eclipse.jetty.server.Server: Started Server@...
+realm: <realm> root principal credentials: <client-id>:<client-secret>
+INFO [io.quarkus] [,] [,,,] (Quarkus Main Thread) polaris-quarkus-service
<version> on JVM (powered by Quarkus <version>) started in 2.656s. Listening
on: http://localhost:8181. Management interface listening on
http://0.0.0.0:8182.
+INFO [io.quarkus] [,] [,,,] (Quarkus Main Thread) Profile prod activated.
Live Coding activated.
+INFO [io.quarkus] [,] [,,,] (Quarkus Main Thread) Installed features: [...]
```
At this point, Polaris is running.
-## Bootstrapping Polaris
-
For this tutorial, we'll launch an instance of Polaris that stores entities
only in-memory. This means that any entities that you define will be destroyed
when Polaris is shut down. It also means that Polaris will automatically
bootstrap itself with root credentials. For more information on how to
configure Polaris for production usage, see the [docs]({{% ref
"configuring-polaris-for-production" %}}).
-When Polaris is launched using in-memory mode the root principal credentials
can be found in stdout on initial startup. For example:
+When Polaris is launched using an in-memory metastore, the root principal
credentials can be found
+in stdout on initial startup. Look for a line that resembles the following:
```
-realm: default-realm root principal credentials: <client-id>:<client-secret>
+realm: <realm> root principal credentials: <client-id>:<client-secret>
```
-Be sure to note of these credentials as we'll be using them below. You can
also set these credentials as environment variables for use with the Polaris
CLI:
+Be sure to take note of these credentials as we'll be using them below. You
can also set these credentials as environment variables for use with the
Polaris CLI:
```shell
export CLIENT_ID=<client-id>
