From 6b632f47bee25fa16ee525c51e6ea66d7282a7a2 Mon Sep 17 00:00:00 2001 From: Dmitri Bourlatchkov Date: Wed, 28 Jan 2026 13:44:19 -0500 Subject: [PATCH 1/3] docs: Add quick guide for downstream builds --- .../in-dev/unreleased/downstream-build.md | 55 +++++++++++++++++++ 1 file changed, 55 insertions(+) create mode 100644 site/content/in-dev/unreleased/downstream-build.md diff --git a/site/content/in-dev/unreleased/downstream-build.md b/site/content/in-dev/unreleased/downstream-build.md new file mode 100644 index 0000000000..cca613e2b6 --- /dev/null +++ b/site/content/in-dev/unreleased/downstream-build.md @@ -0,0 +1,55 @@ +--- +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +title: Building a Custom Server Based on Polaris +type: docs +weight: 1005 +--- + +This page proposes a method for building custom servers based on Apache Polaris. + +Polaris produces several jars. These jars may be used to build custom catalog server +according to the terms of the license included in Polaris distributions. + +## General Principles + +* Create a module in your project (Maven, Gradle or any other build tool) for a Quarkus Application. +* Include `polaris-runtime-service` as a runtime or compile-time dependency. +* Include / exclude other dependencies according to the project's needs (e.g., an alternative JDBC driver). +* Do not include `polaris-runtime-defaults` or `polaris-server` as dependencies. +* Provide your own `application.properties` file for your Quarkus build. +* Define your own Quarkus Application Name and Version (do not use "Apache Polaris" as the application name). + +## Background + +The `polaris-server` module is intended to be a particular way to build a Polaris server. It includes +dependencies that are considered essential for the Apache Polaris distribution. This is not necessarily +the case for downstream builds, which may want to exclude some features and include others (perhaps +custom implementations of some Polaris SPI interfaces). + +The `polaris-runtime-defaults` module is intended to hold `application.properties` configured for the +default Apache Polaris distribution. While it may be tempting to reuse it in a downstream build and +add overrides for some properties, practice shows that in this case it becomes very hard to predict +the effects of property customizations in the downstream build. While it may be relevant to Gradle builds +only, it is much more clear to have the full set of properties in a custom `application.properties` file +without any other `application.properties` files in transitive dependencies. + +The `polaris-runtime-service` module contains standard service endpoint implementations and is intended +to be reused. Custom [CDI](https://quarkus.io/guides/cdi-reference) beans may be used in downstream +projects to override / enhance beans provided by `polaris-runtime-service`. From 34ec44a60e5324dde0d9fba9604fe87e96898447 Mon Sep 17 00:00:00 2001 From: Dmitri Bourlatchkov Date: Wed, 28 Jan 2026 15:56:44 -0500 Subject: [PATCH 2/3] review: add link --- site/content/in-dev/unreleased/downstream-build.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/site/content/in-dev/unreleased/downstream-build.md b/site/content/in-dev/unreleased/downstream-build.md index cca613e2b6..adc4a646d9 100644 --- a/site/content/in-dev/unreleased/downstream-build.md +++ b/site/content/in-dev/unreleased/downstream-build.md @@ -29,7 +29,8 @@ according to the terms of the license included in Polaris distributions. ## General Principles -* Create a module in your project (Maven, Gradle or any other build tool) for a Quarkus Application. +* Create a module in your project (Maven, Gradle or any other build tool) for a +[Quarkus Application](https://code.quarkus.io/). * Include `polaris-runtime-service` as a runtime or compile-time dependency. * Include / exclude other dependencies according to the project's needs (e.g., an alternative JDBC driver). * Do not include `polaris-runtime-defaults` or `polaris-server` as dependencies. From 2d2f3549640c16af5c54dbd325bb8a70ad6deca8 Mon Sep 17 00:00:00 2001 From: Dmitri Bourlatchkov Date: Fri, 30 Jan 2026 12:28:03 -0500 Subject: [PATCH 3/3] review: rephrase first line --- site/content/in-dev/unreleased/downstream-build.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/content/in-dev/unreleased/downstream-build.md b/site/content/in-dev/unreleased/downstream-build.md index adc4a646d9..e1b870c6df 100644 --- a/site/content/in-dev/unreleased/downstream-build.md +++ b/site/content/in-dev/unreleased/downstream-build.md @@ -22,7 +22,7 @@ type: docs weight: 1005 --- -This page proposes a method for building custom servers based on Apache Polaris. +This page highlights a few keys points for building custom servers based on Apache Polaris. Polaris produces several jars. These jars may be used to build custom catalog server according to the terms of the license included in Polaris distributions.