Skip to content

Commit

Permalink
Sync documentation of main branch
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Aug 29, 2023
1 parent fcdfd7a commit a5fc327
Show file tree
Hide file tree
Showing 5 changed files with 37 additions and 22 deletions.
28 changes: 14 additions & 14 deletions _data/versioned/main/index/quarkus.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ types:
- title: Configure data sources in Quarkus
filename: datasource.adoc
summary: Use a unified configuration model to define datasources for Java Database Connectivity (JDBC) and Reactive drivers.
categories: "getting-started, data"
categories: "data, getting-started"
id: datasources
type: reference
url: /guides/datasource
Expand All @@ -55,7 +55,7 @@ types:
- title: Logging configuration
filename: logging.adoc
summary: "Read about the use of logging API in Quarkus, configuring logging output, and using logging adapters to unify the output from other logging APIs."
categories: "getting-started, observability, core"
categories: "observability, core, getting-started"
id: logging
type: reference
url: /guides/logging
Expand Down Expand Up @@ -236,7 +236,7 @@ types:
- title: Security vulnerability detection and reporting in Quarkus
filename: security-vulnerability-detection.adoc
summary: Most of the Quarkus tags are registered in the US National Vulnerability Database (NVD) in Common Platform Enumeration (CPE) name format.
categories: "security, contributing"
categories: "contributing, security"
id: security-vulnerability-detection
type: concepts
url: /guides/security-vulnerability-detection
Expand Down Expand Up @@ -273,7 +273,7 @@ types:
- title: Building a Native Executable
filename: building-native-image.adoc
summary: Build native executables with GraalVM or Mandrel.
categories: "getting-started, native"
categories: "native, getting-started"
type: tutorial
url: /guides/building-native-image
- title: Collect metrics using Micrometer
Expand Down Expand Up @@ -338,7 +338,7 @@ types:
- title: Your second Quarkus application
filename: getting-started-dev-services.adoc
summary: This tutorial shows you how to create an application which writes to and reads from a database.
categories: "getting-started, data, core"
categories: "data, core, getting-started"
id: getting-started-dev-services-tutorial
type: tutorial
url: /guides/getting-started-dev-services
Expand Down Expand Up @@ -528,7 +528,7 @@ types:
- title: Deploying on OpenShift
filename: deploying-to-openshift.adoc
summary: This guide covers how to deploy a native application on OpenShift.
categories: "cloud, native"
categories: "native, cloud"
id: deploy-openshift
type: guide
url: /guides/deploying-to-openshift
Expand Down Expand Up @@ -583,7 +583,7 @@ types:
- title: Dev Services for Databases
filename: databases-dev-services.adoc
summary: "When testing or running in dev mode Quarkus can provide you with a zero-config database out of the box, a feature we refer to as Dev Services."
categories: "tooling, data"
categories: "data, tooling"
type: guide
url: /guides/databases-dev-services
- title: Dev Services for Elasticsearch
Expand Down Expand Up @@ -813,7 +813,7 @@ types:
- title: Kubernetes extension
filename: deploying-to-kubernetes.adoc
summary: This guide covers how to deploy a native application on Kubernetes.
categories: "cloud, native"
categories: "native, cloud"
id: deploy-kubernetes
type: guide
url: /guides/deploying-to-kubernetes
Expand Down Expand Up @@ -952,14 +952,14 @@ types:
- title: Quarkus and Gradle
filename: gradle-tooling.adoc
summary: Develop and build your Quarkus application with Gradle
categories: "tooling, native"
categories: "native, tooling"
id: gradle-tooling
type: guide
url: /guides/gradle-tooling
- title: Quarkus and Maven
filename: maven-tooling.adoc
summary: Develop and build your Quarkus application with Maven
categories: "tooling, native"
categories: "native, tooling"
id: maven-tooling
type: guide
url: /guides/maven-tooling
Expand Down Expand Up @@ -1033,7 +1033,7 @@ types:
- title: Simplified Hibernate ORM with Panache and Kotlin
filename: hibernate-orm-panache-kotlin.adoc
summary: This explains the specifics of using Hibernate ORM with Panache in a Kotlin project.
categories: "alt-languages, data"
categories: "data, alt-languages"
type: guide
url: /guides/hibernate-orm-panache-kotlin
- title: Simplified Hibernate Reactive with Panache
Expand All @@ -1051,7 +1051,7 @@ types:
- title: Simplified MongoDB with Panache and Kotlin
filename: mongodb-panache-kotlin.adoc
summary: This guide covers the usage of MongoDB using active records and repositories in a Kotlin project.
categories: "alt-languages, data"
categories: "data, alt-languages"
type: guide
url: /guides/mongodb-panache-kotlin
- title: SmallRye Fault Tolerance
Expand Down Expand Up @@ -1087,7 +1087,7 @@ types:
- title: Testing Your Application
filename: getting-started-testing.adoc
summary: "This guide covers testing in JVM mode, native mode, and injection of resources into tests"
categories: "tooling, native, core"
categories: "native, tooling, core"
id: testing
type: guide
url: /guides/getting-started-testing
Expand Down Expand Up @@ -1223,7 +1223,7 @@ types:
- title: Using SSL With Native Executables
filename: native-and-ssl.adoc
summary: "In this guide, we will discuss how you can get your native images to support SSL, as native images don't support it out of the box."
categories: "security, native, core"
categories: "native, security, core"
type: guide
url: /guides/native-and-ssl
- title: Using Security with .properties File
Expand Down
2 changes: 0 additions & 2 deletions _versions/main/guides/getting-started-testing.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -1626,8 +1626,6 @@ The container is stopped and the config is released during the `after all` test
The fields annotated with `@Inject` and `@InjectMock` are injected after a test instance is created and unset before a test instance is destroyed.
Finally, the CDI request context is activated and terminated per each test method.

NOTE: By default, a new test instance is created for each test method. Therefore, a new CDI container is started for each test method. However, if the test class is annotated with `@org.junit.jupiter.api.TestInstance` and the test instance lifecycle is set to `org.junit.jupiter.api.TestInstance.Lifecycle.PER_CLASS` then the CDI container will be shared across all test method executions of a given test class.

=== Auto Mocking Unsatisfied Dependencies

Unlike in regular CDI environments the test does not fail if a component injects an unsatisfied dependency.
Expand Down
20 changes: 16 additions & 4 deletions _versions/main/guides/hibernate-reactive.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -283,10 +283,22 @@ know what is being done.

Here's a list of things to pay attention when using Hibernate Reactive in Quarkus:

* it's not possible to configure multiple persistence units at the moment
* it's not configurable via a `persistence.xml` file
* integration with the Envers extension is not supported
* transaction demarcation cannot be done using `jakarta.transaction.Transactional`
* Hibernate Reactive is not configurable via a `persistence.xml` file.
* This extension only considers the default persistence unit at the moment:
it's not possible to configure multiple persistence units,
or even a single named persistence unit.
* This extension cannot be used at the same time as Hibernate ORM.
See https://github.com/quarkusio/quarkus/issues/13425.
* This extension cannot be used at the same time as JDBC/Agroal.
See https://github.com/quarkusio/quarkus/issues/33380.
+
This also means this extension cannot be used at the same time as extensions that rely on JDBC,
such as the Flyway extension.
See https://github.com/quarkusio/quarkus/issues/10716.
* Integration with the Envers extension is not supported.
* Transaction demarcation cannot be done using `jakarta.transaction.Transactional` or `QuarkusTransaction`;
if you use xref:hibernate-reactive-panache.adoc[Hibernate Reactive with Panache],
consider xref:hibernate-reactive-panache.adoc#transactions[using `@WithTransaction` or `Panache.withTransaction()`] instead.

== Simplifying Hibernate Reactive with Panache

Expand Down
5 changes: 5 additions & 0 deletions _versions/main/guides/http-reference.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -437,6 +437,11 @@ include::{generated-dir}/config/quarkus-vertx-http-config-group-access-log-confi
|Vert.x MDC data (e.g. 'traceId' for OpenTelemetry) | | `%{X,mdc-key}`
|===

[NOTE]
====
Set `quarkus.http.record-request-start-time=true` to enable recording request start times when using any of the attributes related to logging request processing times.
====

[TIP]
====
Use `quarkus.http.access-log.exclude-pattern=/some/path/.*` to exclude all entries concerning the path `/some/path/...` (_including subsequent paths_) from the log.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ You may need to register a redirect URI for the authorization code flow initiate
If Keycloak does enforce it then you will see an authentication error informing you that the `redirect_uri` value is wrong.
In this case select the `Keycloak Admin` option in the right top corner, login as `admin:admin`, select the test realm and the client which Dev UI for Keycloak is configured with and add `http://localhost:8080/q/dev/io.quarkus.quarkus-oidc/provider` to `Valid Redirect URIs`. If you used `-Dquarkus.http.port` when starting Quarkus then change `8080` to the value of `quarkus.http.port`
In this case select the `Keycloak Admin` option in the right top corner, login as `admin:admin`, select the test realm and the client which Dev UI for Keycloak is configured with and add `http://localhost:8080/q/dev-ui/io.quarkus.quarkus-oidc/keycloak-provider` to `Valid Redirect URIs`. If you used `-Dquarkus.http.port` when starting Quarkus then change `8080` to the value of `quarkus.http.port`
If the container is shared between multiple applications running on different ports then you will need to register `redirect_uri` values for each of these applications.
Expand Down Expand Up @@ -318,7 +318,7 @@ image::dev-ui-oidc-devconsole-card.png[alt=Generic Dev UI OpenID Connect Card,ro

Follow the link, and you will be able to log in to your provider, get the tokens and test the application. The experience will be the same as described in the xref:keycloak-authorization-code-grant[Authorization Code Grant for Keycloak] section, where `Dev Services for Keycloak` container has been started, especially if you work with Keycloak.

You will most likely need to configure your OpenId Connect provider to support redirecting back to the `Dev Console`. Add `http://localhost:8080/q/dev-v1/io.quarkus.quarkus-oidc/provider` as one of the supported redirect and logout URLs. one of the supported redirect and logout URLs.
You will most likely need to configure your OpenId Connect provider to support redirecting back to the `Dev Console`. Add `http://localhost:8080/q/dev-ui/io.quarkus.quarkus-oidc/`providerName`-provider` as one of the supported redirect and logout URLs, where `providerName` will need to be replaced by the name of the provider shown in DevUI, for example, `auth0`.

If you work with other providers then a Dev UI experience described in the xref:keycloak-authorization-code-grant[Authorization Code Grant for Keycloak] section might differ slightly. For example, an access token may not be in a JWT format, so it won't be possible to show its internal content, though all providers should return an ID Token as JWT.

Expand Down

0 comments on commit a5fc327

Please sign in to comment.