You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@polaris.apache.org by "harryc3139 (via GitHub)" <gi...@apache.org> on 2026/10/05 12:05:59 UTC
[PR] Distribution: Ship commented-out application.properties templates [polaris]
harryc3139 opened a new pull request, #5702:
URL: https://github.com/apache/polaris/pull/5702
The docs say Polaris reads `$PWD/config/application.properties`, but in the binary distribution
`bin/server` and `bin/admin` run from `server/` and `admin/`. The real paths are therefore
`server/config/application.properties` and `admin/config/application.properties`, and neither file
exists today.
This PR ships both files with every property commented out, so default behaviour is unchanged. They
cover a short, curated set of commonly changed properties and link to the configuration reference.
The docs and the distribution README now name both locations. Docker images are not affected.
I chose a curated set over the full property list because a full list would be hard to keep in sync
with the code. I'm happy to switch if preferred (see my comment on the issue).
**Testing:** `./gradlew :polaris-distribution:check :polaris-distribution:distTar rat` passes. I also
extracted the tarball, changed the ports in `server/config/application.properties` and ran
`bin/server`; it started on the new ports.
## Checklist
- [x] ๐ก๏ธ Don't disclose security issues! (contact security@apache.org)
- [x] ๐ Clearly explained why the changes are needed, or linked related issues: Fixes #
- [x] ๐งช Added/updated tests with good coverage, or manually tested (and explained how)
- [x] ๐ก Added comments for complex logic
- [x] ๐งพ Updated `CHANGELOG.md` (if needed)
- [x] ๐ Updated documentation in `site/content/in-dev/unreleased` (if needed)
Fixes #2686
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Distribution: Ship commented-out application.properties templates [polaris]
Posted by "dimas-b (via GitHub)" <gi...@apache.org>.
dimas-b commented on code in PR #5702:
URL: https://github.com/apache/polaris/pull/5702#discussion_r4187250232
##########
runtime/distribution/admin/config/application.properties:
##########
@@ -0,0 +1,43 @@
+#
+# 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.
+#
+
+# Polaris admin tool configuration, read by bin/admin at startup.
+#
+# Every property in this file is commented out, so the admin tool uses its built-in defaults.
+# To change a setting, remove the leading '#' and edit the value. Unless noted otherwise, the
+# value shown is the default.
+#
+# System properties (-Dname=value) and environment variables take precedence over this file.
+#
+# This file only lists a few commonly changed settings. For the full list, see
+# https://polaris.apache.org/releases/latest/configuration/
+
+# ---- Persistence ----
+
+# The admin tool must connect to the same metastore as the Polaris server, see
+# server/config/application.properties.
+#polaris.persistence.type=relational-jdbc
Review Comment:
If this file in meant to be edited in-place, could this complicate upgrades based on the binary dist? I mean local changes would be easy to lose ๐ค
Should we instead allow users to (easily) point to a local `application.properties` file in a location of their choosing?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Distribution: Ship commented-out application.properties templates [polaris]
Posted by "dimas-b (via GitHub)" <gi...@apache.org>.
dimas-b commented on code in PR #5702:
URL: https://github.com/apache/polaris/pull/5702#discussion_r4187250232
##########
runtime/distribution/admin/config/application.properties:
##########
@@ -0,0 +1,43 @@
+#
+# 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.
+#
+
+# Polaris admin tool configuration, read by bin/admin at startup.
+#
+# Every property in this file is commented out, so the admin tool uses its built-in defaults.
+# To change a setting, remove the leading '#' and edit the value. Unless noted otherwise, the
+# value shown is the default.
+#
+# System properties (-Dname=value) and environment variables take precedence over this file.
+#
+# This file only lists a few commonly changed settings. For the full list, see
+# https://polaris.apache.org/releases/latest/configuration/
+
+# ---- Persistence ----
+
+# The admin tool must connect to the same metastore as the Polaris server, see
+# server/config/application.properties.
+#polaris.persistence.type=relational-jdbc
Review Comment:
If this file in meant to be edited in-place, could this complicate upgrades based on the binary dist? I mean local changes would be easy to lose ๐ค
Should we instead allow users to (easily) point to a local `application.properties` file in a location of their choosing?
(non-blocking)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Distribution: Ship commented-out application.properties templates [polaris]
Posted by "harryc3139 (via GitHub)" <gi...@apache.org>.
harryc3139 commented on code in PR #5702:
URL: https://github.com/apache/polaris/pull/5702#discussion_r4237283970
##########
runtime/distribution/admin/config/application.properties:
##########
@@ -0,0 +1,43 @@
+#
+# 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.
+#
+
+# Polaris admin tool configuration, read by bin/admin at startup.
+#
+# Every property in this file is commented out, so the admin tool uses its built-in defaults.
+# To change a setting, remove the leading '#' and edit the value. Unless noted otherwise, the
+# value shown is the default.
+#
+# System properties (-Dname=value) and environment variables take precedence over this file.
+#
+# This file only lists a few commonly changed settings. For the full list, see
+# https://polaris.apache.org/releases/latest/configuration/
+
+# ---- Persistence ----
+
+# The admin tool must connect to the same metastore as the Polaris server, see
+# server/config/application.properties.
+#polaris.persistence.type=relational-jdbc
Review Comment:
Good point, in-place edits would be left behind when a new release is extracted. Quarkus already supports this via `QUARKUS_CONFIG_LOCATIONS`, and it works through `bin/server` as-is (tested; it also overrides `server/config/application.properties`). Added a note about it to `binary-distribution.md`.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Distribution: Ship commented-out application.properties templates [polaris]
Posted by "snazy (via GitHub)" <gi...@apache.org>.
snazy commented on PR #5702:
URL: https://github.com/apache/polaris/pull/5702#issuecomment-6121373125
Should we add two new `application.properties` files or rather attempt to look into reusing the existing (default) ones?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Distribution: Ship commented-out application.properties templates [polaris]
Posted by "orca-review-bot (via GitHub)" <gi...@apache.org>.
orca-review-bot commented on code in PR #5702:
URL: https://github.com/apache/polaris/pull/5702#discussion_r4364562580
##########
site/content/in-dev/unreleased/getting-started/binary-distribution.md:
##########
@@ -52,3 +52,28 @@ You can verify the server is running by checking the health endpoint:
```bash
curl http://localhost:8182/q/health
```
+
+## Configuration
+
+The binary distribution includes one configuration file for each component:
+
+- `server/config/application.properties` for the Polaris server (`bin/server`);
+- `admin/config/application.properties` for the admin tool (`bin/admin`).
+
+All the properties in these files are commented out, so both components use their default
+configuration. To change a setting, uncomment the property and edit its value, then restart the
Review Comment:
"then restart the server" reads as server-only, but this paragraph covers the admin tool too. Can we say "restart the server (or re-run the admin tool)"?
<sub>๐ค AI-generated review comment โ agents make mistakes, so please verify before acting on it.</sub>
##########
runtime/distribution/server/config/application.properties:
##########
@@ -0,0 +1,73 @@
+#
+# 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.
+#
+
+# Polaris server configuration, read by bin/server at startup.
+#
+# Every property in this file is commented out, so the server uses its built-in defaults.
+# To change a setting, remove the leading '#' and edit the value. Unless noted otherwise, the
+# value shown is the default.
Review Comment:
These "default" values are copied by hand from `runtime/defaults/.../application.properties`, and nothing keeps the two in sync. They all match today. But if a default changes later, this file will quietly show the old value while still claiming it's the default. Can we either drop the "value shown is the default" wording, or add a small check in `:polaris-distribution:check` that compares the values? Same in `admin/config/application.properties`.
<sub>๐ค AI-generated review comment โ agents make mistakes, so please verify before acting on it.</sub>
##########
runtime/distribution/server/config/application.properties:
##########
@@ -0,0 +1,73 @@
+#
+# 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.
+#
+
+# Polaris server configuration, read by bin/server at startup.
+#
+# Every property in this file is commented out, so the server uses its built-in defaults.
+# To change a setting, remove the leading '#' and edit the value. Unless noted otherwise, the
+# value shown is the default.
+#
+# System properties (-Dname=value) and environment variables take precedence over this file.
+#
+# This file only lists a few commonly changed settings. For the full list, see
+# https://polaris.apache.org/releases/latest/configuration/
Review Comment:
This file ships inside a versioned tarball, but the link goes to `releases/latest`. Once a newer release is out, users on this one will land on docs that may list properties they don't have. Should it point at the matching release's docs instead? Same in the admin file.
<sub>๐ค AI-generated review comment โ agents make mistakes, so please verify before acting on it.</sub>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org