Skip to content

Commit 9799e85

Browse files
dimas-bHonahX
andauthored
Add configuration notes to README.md (#964)
* Add configuration notes to README.md Co-authored-by: Honah J. <[email protected]>
1 parent 6c0b983 commit 9799e85

File tree

2 files changed

+14
-0
lines changed

2 files changed

+14
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,14 @@ using different configurations. Check the `./getting-started` directory for more
9696
- `kubectl get deployment -n polaris` - To check the status of the deployment.
9797
- `kubectl describe deployment polaris-deployment -n polaris` - To troubleshoot if things aren't working as expected.
9898

99+
#### Configuring Polaris
100+
101+
Polaris Servers can be configured using a variety of ways.
102+
Please see the [Configuration Guide](site/content/in-dev/unreleased/configuration.md)
103+
for more information.
104+
105+
Default configuration values can be found in `quarkus/defaults/src/main/resources/application.properties`.
106+
99107
#### Building docs
100108

101109
- Docs are generated using [Hugo](https://gohugo.io/) using the [Docsy](https://www.docsy.dev/docs/) theme.

site/content/in-dev/unreleased/configuration.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,12 @@ read-only mode, as Polaris only reads the configuration file once, at startup.
7777

7878
## Polaris Configuration Options Reference
7979

80+
Most common configuration settings that users may want to change are:
81+
- `polaris.persistence.type` (see the [Configuring Apache Polaris for Production]({{% ref "configuring-polaris-for-production.md" %}})
82+
guide for specific instructions).
83+
- `polaris.features.defaults.SUPPORTED_CATALOG_STORAGE_TYPES=["S3","GCS","AZURE"]`.
84+
- Note: this excludes the default `FILE` storage type, which is not meaningful in a distributed deployment.
85+
8086
The following configuration options are available for Polaris:
8187

8288
TODO

0 commit comments

Comments
 (0)