Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add configuration notes to README.md #964

Merged
merged 4 commits into from
Feb 7, 2025
Merged

Add configuration notes to README.md #964

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a693efb
Add configuration notes to README.md
dimas-b Feb 7, 2025
2dc44f9
review: move config examples to configuration.md
dimas-b Feb 7, 2025
142ad09
Update site/content/in-dev/unreleased/configuration.md
dimas-b Feb 7, 2025
fb8216c
review: link from README to configuration.md
dimas-b Feb 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,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](https://polaris.apache.org/in-dev/unreleased/configuration/)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we use relative path here as well?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure. I suppose people often view this README on GH or locally.

Copy link
Contributor

@flyrain flyrain Feb 7, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have test a relative path as the following. Either GH and local(in IDE) usage are fine. Just a bit concern of inconsistency, as once we got releases. A link like this https://polaris.apache.org/in-dev/unreleased/configuration/ will be changed.

- See [README in `site/`](site/README.md) for more information.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed to a relative link to configuration.md. This is a link between .md files, not to the generated docs, but that works for me.

for more information.

Default configuration values can be found in `quarkus/defaults/src/main/resources/application.properties`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not a blocker to this PR, but I'm still concerned as this file contains both build-time and runtime configs. I'm not sure if there is a better way to reduce the confusion from the users, other than documenting them well. Open for suggestions.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it help if we had a different section for build-time properties in application.properties with a comment explaining how they work?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah, that definitely helps.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#970


#### Building docs

- Docs are generated using [Hugo](https://gohugo.io/) using the [Docsy](https://www.docsy.dev/docs/) theme.
Expand Down
6 changes: 6 additions & 0 deletions site/content/in-dev/unreleased/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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](https://polaris.apache.org/in-dev/unreleased/configuring-polaris-for-production/)
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
Expand Down