Skip to content

Commit 945d049

Browse files
committed
Sync documentation of main branch
1 parent f4abad6 commit 945d049

10 files changed

+5603
-443
lines changed

_generated-doc/main/config/quarkus-all-config.adoc

Lines changed: 369 additions & 352 deletions
Large diffs are not rendered by default.

_generated-doc/main/config/quarkus-oidc_quarkus.keycloak.devservices.adoc renamed to _generated-doc/main/config/quarkus-devservices-keycloak.adoc

Lines changed: 60 additions & 24 deletions
Large diffs are not rendered by default.

_generated-doc/main/config/quarkus-oidc_quarkus.keycloak.adoc renamed to _generated-doc/main/config/quarkus-devservices-keycloak_quarkus.keycloak.adoc

Lines changed: 58 additions & 27 deletions
Large diffs are not rendered by default.

_generated-doc/main/config/quarkus-oidc.adoc

Lines changed: 5038 additions & 0 deletions
Large diffs are not rendered by default.

_generated-doc/main/config/quarkus-oidc_quarkus.oidc.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-oidc-devui-web-cli
6262

6363
[.description]
6464
--
65-
The WebClient timeout. Use this property to configure how long an HTTP client used by Dev UI handlers will wait for a response when requesting tokens from OpenId Connect Provider and sending them to the service endpoint. This timeout is also used by the OIDC dev service admin client.
65+
The WebClient timeout. Use this property to configure how long an HTTP client used by Dev UI handlers will wait for a response when requesting tokens from OpenId Connect Provider and sending them to the service endpoint.
6666

6767

6868
ifdef::add-copy-button-to-env-var[]

_generated-doc/main/infra/quarkus-all-build-items.adoc

Lines changed: 38 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -3638,6 +3638,44 @@ _No Javadoc found_
36383638
_No Javadoc found_
36393639

36403640

3641+
|===
3642+
== DevServices - Keycloak
3643+
[.configuration-reference,cols=2*]
3644+
|===
3645+
h|Class Name
3646+
h|Attributes
3647+
3648+
3649+
3650+
3651+
a| https://github.com/quarkusio/quarkus/blob/main/extensions/devservices/keycloak/src/main/java/io/quarkus/devservices/keycloak/KeycloakDevServicesConfigBuildItem.java[`io.quarkus.devservices.keycloak.KeycloakDevServicesConfigBuildItem`, window="_blank"]
3652+
[.description]
3653+
--
3654+
_No Javadoc found_
3655+
-- a|`java.util.Map<String,String> config`
3656+
3657+
_No Javadoc found_
3658+
3659+
`java.util.Map<String,Object> properties`
3660+
3661+
_No Javadoc found_
3662+
3663+
`boolean containerRestarted`
3664+
3665+
_No Javadoc found_
3666+
3667+
3668+
3669+
3670+
a| https://github.com/quarkusio/quarkus/blob/main/extensions/devservices/keycloak/src/main/java/io/quarkus/devservices/keycloak/KeycloakDevServicesRequiredBuildItem.java[`io.quarkus.devservices.keycloak.KeycloakDevServicesRequiredBuildItem`, window="_blank"]
3671+
[.description]
3672+
--
3673+
A marker build item signifying that integrating extensions (like OIDC and OIDC client) are enabled. The Keycloak Dev Service will be started in DEV mode if at least one item is produced and the Dev Service is not disabled in other fashion.
3674+
-- a|`io.quarkus.devservices.keycloak.Capability capability`
3675+
3676+
_No Javadoc found_
3677+
3678+
36413679
|===
36423680
== Elasticsearch REST client common
36433681
[.configuration-reference,cols=2*]
@@ -5657,40 +5695,6 @@ Build item used to carry running DevService values to Dev UI.
56575695
_No Javadoc found_
56585696

56595697

5660-
|===
5661-
== OpenID Connect Adapter
5662-
[.configuration-reference,cols=2*]
5663-
|===
5664-
h|Class Name
5665-
h|Attributes
5666-
5667-
5668-
5669-
5670-
a| https://github.com/quarkusio/quarkus/blob/main/extensions/oidc/deployment/src/main/java/io/quarkus/oidc/deployment/devservices/keycloak/KeycloakDevServicesConfigBuildItem.java[`io.quarkus.oidc.deployment.devservices.keycloak.KeycloakDevServicesConfigBuildItem`, window="_blank"]
5671-
[.description]
5672-
--
5673-
_No Javadoc found_
5674-
-- a|`java.util.Map<String,String> config`
5675-
5676-
_No Javadoc found_
5677-
5678-
`java.util.Map<String,Object> properties`
5679-
5680-
_No Javadoc found_
5681-
5682-
`boolean containerRestarted`
5683-
5684-
_No Javadoc found_
5685-
5686-
5687-
5688-
5689-
a| https://github.com/quarkusio/quarkus/blob/main/extensions/oidc/deployment/src/main/java/io/quarkus/oidc/deployment/devservices/OidcDevServicesBuildItem.java[`io.quarkus.oidc.deployment.devservices.OidcDevServicesBuildItem`, window="_blank"]
5690-
[.description]
5691-
--
5692-
Marker build item which indicates that Dev Services for OIDC are provided by another extension. Dev Services for Keycloak will be disabled if this item is detected.
5693-
-- a|None
56945698
|===
56955699
== OpenID Connect Client
56965700
[.configuration-reference,cols=2*]

_versions/main/guides/cdi-reference.adoc

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1331,6 +1331,28 @@ public void register(RegistrationContext context) {
13311331

13321332
<1> The argument is the bindings source class.
13331333

1334+
=== `Instance.Handle.close()` Behavior
1335+
1336+
Per the CDI specification, the `Instance.Handle.close()` method always delegates to `destroy()`.
1337+
In ArC, this is only true in the <<strict_mode>>.
1338+
1339+
In the default mode, the `close()` method only delegates to `destroy()` when the bean is `@Dependent` (or when the instance handle does not represent a CDI contextual object).
1340+
When the instance handle represents a bean of any other scope, the `close()` method does nothing; the bean is left as is and will be destroyed whenever its context is destroyed.
1341+
1342+
This is to make the following code behave as one would naively expect:
1343+
1344+
[source,java]
1345+
----
1346+
Instance<T> instance = ...;
1347+
try (Instance.Handle<T> handle : instance.getHandle()) {
1348+
T value = handle.get();
1349+
... use value ...
1350+
}
1351+
----
1352+
1353+
The `@Dependent` beans are destroyed immediately, while other beans are not destroyed at all.
1354+
This is important when multiple beans of different scopes might be returned by the `Instance`.
1355+
13341356
[[reactive_pitfalls]]
13351357
== Pitfalls with Reactive Programming
13361358

_versions/main/guides/dev-services.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ The Keycloak Dev Service will be enabled when the `quarkus-oidc` extension is pr
102102
the server address has not been explicitly configured. More information can be found in the
103103
xref:security-openid-connect-dev-services.adoc[OIDC Dev Services Guide].
104104

105-
include::{generated-dir}/config/quarkus-oidc_quarkus.keycloak.devservices.adoc[opts=optional, leveloffset=+1]
105+
include::{generated-dir}/config/quarkus-devservices-keycloak_quarkus.keycloak.adoc[opts=optional, leveloffset=+1]
106106

107107
=== Kubernetes
108108

_versions/main/guides/security-oidc-configuration-properties-reference.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ include::{generated-dir}/config/quarkus-oidc_quarkus.oidc.adoc[opts=optional, le
1919

2020
== Keycloak Dev Services configuration
2121

22-
include::{generated-dir}/config/quarkus-oidc_quarkus.keycloak.adoc[opts=optional, leveloffset=+1]
22+
include::{generated-dir}/config/quarkus-devservices-keycloak_quarkus.keycloak.adoc[opts=optional, leveloffset=+1]
2323

2424
== References
2525

_versions/main/guides/tls-registry-reference.adoc

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,11 @@ The TLS Registry consolidates settings and supports multiple named configuration
2121
Therefore, you can tailor TLS settings for different application parts.
2222
This flexibility is particularly useful when different components require distinct security configurations.
2323

24-
The TLS Registry extension is automatically included in your project when you use compatible extensions, such as Quarkus REST, gRPC, or Reactive Routes.
24+
The TLS Registry extension is automatically included in your project when you use compatible extensions, such as Quarkus REST, gRPC
25+
ifndef::no-reactive-routes[]
26+
, or Reactive Routes
27+
endif::no-reactive-routes[]
28+
.
2529
As a result, applications that use the TLS Registry can be ready to handle secure communications out of the box.
2630
TLS Registry also provides features like automatic certificate reloading, Let's Encrypt (ACME) integration, Kubernetes Cert-Manager support, and compatibility with various keystore formats, such as PKCS12, PEM, and JKS.
2731

@@ -655,6 +659,7 @@ quarkus.tls.http.key-store.pem.0.key=tls.key
655659
IMPORTANT: Impacted server and client may need to listen to the `CertificateReloadedEvent` to apply the new certificates.
656660
This is automatically done for the Quarkus HTTP server, including the management interface if it is enabled.
657661

662+
ifndef::no-kubernetes-secrets-or-cert-manager[]
658663
== Using Kubernetes secrets or cert-manager
659664

660665
When running in Kubernetes, you can use Kubernetes secrets to store the keystores and truststores.
@@ -765,6 +770,9 @@ The generated secret includes the following files:
765770
%prod.quarkus.http.tls-configuration-name=http
766771
%prod.quarkus.http.insecure-requests=disabled
767772
----
773+
endif::no-kubernetes-secrets-or-cert-manager[]
774+
// The reason for this ifndef condition is that this content is not supported in product docs.
775+
// Feel free to add more content to this chapter, but make sure this condition encloses it.
768776

769777
== Working with OpenShift serving certificates
770778

@@ -1211,6 +1219,7 @@ sudo update-ca-certificates
12111219
sudo security -v remove-trusted-cert -d /Users/clement/.quarkus/quarkus-dev-root-ca.pem
12121220
----
12131221

1222+
ifndef::no-lets-encrypt[]
12141223
[[lets-encrypt]]
12151224
== Automatic certificate management with Let's Encrypt
12161225

@@ -1313,7 +1322,7 @@ java -jar quarkus-run.jar
13131322
.. Keep the application running and request your first Let's Encrypt certificate.
13141323

13151324
[[lets-encrypt-issue-certificate]]
1316-
=== Issue a certificate:
1325+
=== Issue a certificate
13171326

13181327
. From the application directory, run the `issue-certificate` command to acquire your first Let's Encrypt certificate:
13191328
+
@@ -1363,7 +1372,7 @@ Once the Let's Encrypt certificate chain and private key have been successfully
13631372
The TLS registry is notified when a new certificate and private key are ready, and it automatically reloads them.
13641373

13651374
[[lets-encrypt-ngrok]]
1366-
=== Testing with ngrok:
1375+
=== Testing with ngrok
13671376

13681377
link:https://ngrok.com/[ngrok] can be used to provide a secure HTTPS tunnel to your application running on localhost, and make it easy to test HTTPS based applications.
13691378

@@ -1394,3 +1403,6 @@ ngrok http --domain <YOUR-NGROK-DOMAIN> 8080 --scheme http <1>
13941403
Note that the application will be accessible from `http://YOUR-NGROK-DOMAIN` on port `80` but redirected to your local machine on port `8080`.
13951404

13961405
. Test the Quarkus Let's Encrypt ACME feature from your local machine.
1406+
endif::no-lets-encrypt[]
1407+
// The reason for this ifndef condition is that this content is not supported in product docs.
1408+
// Feel free to add more content to this chapter, but make sure this condition encloses it.

0 commit comments

Comments
 (0)