This is an automated email from the ASF dual-hosted git repository.
dimas 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 9799e850 Add configuration notes to README.md (#964)
9799e850 is described below
commit 9799e850b8f468cab2b20165108dc41bbf951fbc
Author: Dmitri Bourlatchkov <[email protected]>
AuthorDate: Fri Feb 7 18:16:51 2025 -0500
Add configuration notes to README.md (#964)
* Add configuration notes to README.md
Co-authored-by: Honah J. <[email protected]>
---
README.md | 8 ++++++++
site/content/in-dev/unreleased/configuration.md | 6 ++++++
2 files changed, 14 insertions(+)
diff --git a/README.md b/README.md
index a6fa906f..e1155c37 100644
--- a/README.md
+++ b/README.md
@@ -96,6 +96,14 @@ using different configurations. Check the
`./getting-started` directory for more
- `kubectl get deployment -n polaris` - To check the status of the deployment.
- `kubectl describe deployment polaris-deployment -n polaris` - To
troubleshoot if things aren't working as expected.
+#### Configuring Polaris
+
+Polaris Servers can be configured using a variety of ways.
+Please see the [Configuration
Guide](site/content/in-dev/unreleased/configuration.md)
+for more information.
+
+Default configuration values can be found in
`quarkus/defaults/src/main/resources/application.properties`.
+
#### Building docs
- Docs are generated using [Hugo](https://gohugo.io/) using the
[Docsy](https://www.docsy.dev/docs/) theme.
diff --git a/site/content/in-dev/unreleased/configuration.md
b/site/content/in-dev/unreleased/configuration.md
index d155b6c2..911d9a06 100644
--- a/site/content/in-dev/unreleased/configuration.md
+++ b/site/content/in-dev/unreleased/configuration.md
@@ -77,6 +77,12 @@ read-only mode, as Polaris only reads the configuration file
once, at startup.
## Polaris Configuration Options Reference
+Most common configuration settings that users may want to change are:
+- `polaris.persistence.type` (see the [Configuring Apache Polaris for
Production]({{% ref "configuring-polaris-for-production.md" %}})
+ guide for specific instructions).
+-
`polaris.features.defaults.SUPPORTED_CATALOG_STORAGE_TYPES=["S3","GCS","AZURE"]`.
+ - Note: this excludes the default `FILE` storage type, which is not
meaningful in a distributed deployment.
+
The following configuration options are available for Polaris:
TODO
