adutra commented on code in PR #469: URL: https://github.com/apache/polaris/pull/469#discussion_r1915289726
########## dropwizard/service/README-quarkus.md: ########## @@ -0,0 +1,97 @@ +<!-- + 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. +--> + +This module contains the Polaris Service powered by Quarkus (instead of Dropwizard). + +# Main differences + +* Bean injection (CDI) is made using `@ApplicationScoped` annotation on class and injected in other classes using `@Inject` annotation (https://quarkus.io/guides/cdi-reference). +* Codehale metrics registry and opentelemetry boilerplate (prometheus exporter included) are not needed anymore: Quarkus provides it "out of the box" (https://quarkus.io/guides/opentelemetry) +* `PolarisHealthCheck` is not needed anymore: Quarkus provides it "out of the box" (https://quarkus.io/guides/smallrye-health) +* `TimedApplicationEventListener` and the `@TimedApi` annotation are replaced by Quarkus (micrometer) `@Timed` annotation (https://quarkus.io/guides/telemetry-micrometer) +* `PolarisJsonLayoutFactory` is not needed anymore: Quarkus provides it by configuration (using `quarkus.log.*` configuration) +* `PolarisApplication` is not needed, Quarkus provide a "main" application out of the box (it's possible to provide `QuarkusApplication` for control the startup and also using `@Startup` annotation) +* CORS boilerplate is not needed anymore: Quarkus supports it via configuration (using `quarkus.http.cors.*` configuration) +* CLI is not part of `polaris-service` anymore, we have (will have) a dedicated module (`polaris-cli`) + +# Build and run + +To build `polaris-service` you simply do: + +``` +./gradlew :polaris-service:build +``` + +The build creates ready to run package: +* in the `build/quarkus-app` folder, you can run with `java -jar quarkus-run.jar` +* the `build/distributions` folder contains tar/zip distributions you can extract + +You can directly run Polaris service (in the build scope) using: + +``` +./gradlew :polaris-quarkus-service:quarkusRun +``` + +You can run in Dev mode as well: + +``` +./gradlew --console=plain :polaris-quarkus-service:quarkusDev +``` + +You can directly build a Docker image using: + +``` +./gradlew :polaris-quarkus-service:imageBuild +``` + +# Configuration + +The main configuration file is not the `application.properties`. The default configuration is +packaged as part of the `polaris-quarkus-service`. `polaris-quarkus-service` uses several +configuration sources (in this order): +* system properties +* environment variables +* `.env` file in the current working directory +* `$PWD/config/application.properties` file +* the `application.properties` packaged in the `polaris-quarkus-service` application Review Comment: Incorporated the above changes in #700. FYI. -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
