-
Notifications
You must be signed in to change notification settings - Fork 495
docs: Add quick guide for downstream builds #3601
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.
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
Merged
Merged
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Maybe link to the Quarkus starter tool? https://code.quarkus.io/
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Cool link... TIL π Link added. |
||
| * 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`. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
rephrased... WDYT?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@singhpk234 : I'm merging "as is". Please feel free to suggest edits on
main:)