Skip to content

Commit 32beeaa

Browse files
committed
Sync documentation of main branch
1 parent f0449e3 commit 32beeaa

8 files changed

+106
-7
lines changed

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

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26599,6 +26599,27 @@ endif::add-copy-button-to-env-var[]
2659926599
a|`password`, `client-credentials`
2660026600
|`password`
2660126601

26602+
a| [[quarkus-keycloak-admin-client_quarkus-keycloak-admin-client-tls-configuration-name]] [.property-path]##`quarkus.keycloak.admin-client.tls-configuration-name`##
26603+
26604+
[.description]
26605+
--
26606+
The name of the TLS configuration to use.
26607+
26608+
If a name is configured, it uses the configuration from `quarkus.tls.<name>.++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown.
26609+
26610+
The default TLS configuration is *not* used by default.
26611+
26612+
26613+
ifdef::add-copy-button-to-env-var[]
26614+
Environment variable: env_var_with_copy_button:+++QUARKUS_KEYCLOAK_ADMIN_CLIENT_TLS_CONFIGURATION_NAME+++[]
26615+
endif::add-copy-button-to-env-var[]
26616+
ifndef::add-copy-button-to-env-var[]
26617+
Environment variable: `+++QUARKUS_KEYCLOAK_ADMIN_CLIENT_TLS_CONFIGURATION_NAME+++`
26618+
endif::add-copy-button-to-env-var[]
26619+
--
26620+
|string
26621+
|
26622+
2660226623

2660326624
h|[.extension-name]##Keycloak Authorization##
2660426625
h|Type
@@ -51461,7 +51482,7 @@ endif::add-copy-button-to-env-var[]
5146151482
|
5146251483

5146351484

51464-
h|[.extension-name]##Observability Dev Services##
51485+
h|[.extension-name]##Observability##
5146551486
h|Type
5146651487
h|Default
5146751488

_generated-doc/main/config/quarkus-keycloak-admin-client.adoc

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,27 @@ endif::add-copy-button-to-env-var[]
161161
a|`password`, `client-credentials`
162162
|`password`
163163

164+
a| [[quarkus-keycloak-admin-client_quarkus-keycloak-admin-client-tls-configuration-name]] [.property-path]##`quarkus.keycloak.admin-client.tls-configuration-name`##
165+
166+
[.description]
167+
--
168+
The name of the TLS configuration to use.
169+
170+
If a name is configured, it uses the configuration from `quarkus.tls.<name>.++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown.
171+
172+
The default TLS configuration is *not* used by default.
173+
174+
175+
ifdef::add-copy-button-to-env-var[]
176+
Environment variable: env_var_with_copy_button:+++QUARKUS_KEYCLOAK_ADMIN_CLIENT_TLS_CONFIGURATION_NAME+++[]
177+
endif::add-copy-button-to-env-var[]
178+
ifndef::add-copy-button-to-env-var[]
179+
Environment variable: `+++QUARKUS_KEYCLOAK_ADMIN_CLIENT_TLS_CONFIGURATION_NAME+++`
180+
endif::add-copy-button-to-env-var[]
181+
--
182+
|string
183+
|
184+
164185
|===
165186

166187

_generated-doc/main/config/quarkus-keycloak-admin-client_quarkus.keycloak.adoc

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,27 @@ endif::add-copy-button-to-env-var[]
161161
a|`password`, `client-credentials`
162162
|`password`
163163

164+
a| [[quarkus-keycloak-admin-client_quarkus-keycloak-admin-client-tls-configuration-name]] [.property-path]##`quarkus.keycloak.admin-client.tls-configuration-name`##
165+
166+
[.description]
167+
--
168+
The name of the TLS configuration to use.
169+
170+
If a name is configured, it uses the configuration from `quarkus.tls.<name>.++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown.
171+
172+
The default TLS configuration is *not* used by default.
173+
174+
175+
ifdef::add-copy-button-to-env-var[]
176+
Environment variable: env_var_with_copy_button:+++QUARKUS_KEYCLOAK_ADMIN_CLIENT_TLS_CONFIGURATION_NAME+++[]
177+
endif::add-copy-button-to-env-var[]
178+
ifndef::add-copy-button-to-env-var[]
179+
Environment variable: `+++QUARKUS_KEYCLOAK_ADMIN_CLIENT_TLS_CONFIGURATION_NAME+++`
180+
endif::add-copy-button-to-env-var[]
181+
--
182+
|string
183+
|
184+
164185
|===
165186

166187

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

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5644,6 +5644,25 @@ Build item to specify the minimal required `io.netty.allocator.maxOrder`. Quarku
56445644
_No Javadoc found_
56455645

56465646

5647+
|===
5648+
== Observability Dev Services
5649+
[.configuration-reference,cols=2*]
5650+
|===
5651+
h|Class Name
5652+
h|Attributes
5653+
5654+
5655+
5656+
5657+
a| https://github.com/quarkusio/quarkus/blob/main/extensions/observability-devservices/deployment/src/main/java/io/quarkus/observability/deployment/devui/ObservabilityDevServicesConfigBuildItem.java[`io.quarkus.observability.deployment.devui.ObservabilityDevServicesConfigBuildItem`, window="_blank"]
5658+
[.description]
5659+
--
5660+
Build item used to carry running DevService values to Dev UI.
5661+
-- a|`java.util.Map<String,String> config`
5662+
5663+
_No Javadoc found_
5664+
5665+
56475666
|===
56485667
== OpenID Connect Adapter
56495668
[.configuration-reference,cols=2*]
46.6 KB
Loading

_versions/main/guides/observability-devservices-lgtm.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,10 @@ If you miss the message you can always check the port with this Docker command:
9797
docker ps | grep grafana
9898
----
9999

100+
Another option is to use the Dev UI as the Grafana URL link will be available and if selected will open a new browser tab directly to the running Grafana instance:
101+
102+
image::dev-ui-observability-card.png[alt=Dev UI LGTM, align=center,width=80%]
103+
100104
=== Additional configuration
101105

102106
This extension will configure your `quarkus-opentelemetry` and `quarkus-micrometer-registry-otlp` extensions to send data to the OTel Collector bundled with the Grafana OTel LGTM image.

_versions/main/guides/security-keycloak-admin-client.adoc

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -195,6 +195,20 @@ quarkus.keycloak.admin-client.grant-type=CLIENT_CREDENTIALS <1>
195195

196196
NOTE: Note that the xref:security-openid-connect-client.adoc[OidcClient] can also be used to acquire tokens.
197197

198+
== Configuring TLS
199+
200+
To configure a TLS connection for the Keycloak Admin Client, use the TLS Registry extension and point the Keycloak Admin Client to respective TLS configuration.
201+
For example, you can configure mutual TLS (mTLS) like this:
202+
203+
[source,properties]
204+
----
205+
quarkus.keycloak.admin-client.tls-configuration-name=kc-mtls
206+
quarkus.tls.kc-mtls.key-store.p12.path=client-keystore.p12
207+
quarkus.tls.kc-mtls.key-store.p12.password=secret
208+
quarkus.tls.kc-mtls.trust-store.p12.path=client-truststore.p12
209+
quarkus.tls.kc-mtls.trust-store.p12.password=secret
210+
----
211+
198212
== Testing
199213

200214
The preferred approach for testing Keycloak Admin Client against Keycloak is xref:security-openid-connect-dev-services.adoc[Dev Services for Keycloak].

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

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ The TLS Registry extension is automatically included in your project when you us
2525
As a result, applications that use the TLS Registry can be ready to handle secure communications out of the box.
2626
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.
2727

28-
[#using-the-tls-registry]
28+
[[using-the-tls-registry]]
2929
== Using the TLS registry
3030

3131
To configure a TLS connection, including key and truststores, use the `+quarkus.tls.*+` properties.
@@ -126,7 +126,7 @@ quarkus.grpc.server.plain-text=false
126126
+
127127
This configuration enables mTLS by ensuring that both the server and client validate each other's certificates, which provides an additional layer of security.
128128

129-
[#referencing-a-tls-configuration]
129+
[[referencing-a-tls-configuration]]
130130
== Referencing a TLS configuration
131131

132132
To reference an example _named_ configuration that you created by using the `quarkus.tls.<name>.*` properties as explained in <<using-the-tls-registry>>
@@ -257,7 +257,7 @@ quarkus.tls.key-store.jks.alias-password=my-alias-password
257257
* Alternatively, use SNI to select the appropriate certificate and private key.
258258
Note that all keys must use the same password.
259259

260-
[#sni]
260+
[[sni]]
261261
==== SNI
262262

263263
Server Name Indication (SNI) is a TLS extension that makes it possible for a client to specify the host name to which it attempts to connect during the TLS handshake.
@@ -585,7 +585,7 @@ When an application that uses the TLS extension starts, the TLS registry perform
585585

586586
If any of these checks fail, the application will not start.
587587

588-
[#reloading-certificates]
588+
[[reloading-certificates]]
589589
== Reloading certificates
590590

591591
The `TlsConfiguration` obtained from the `TLSConfigurationRegistry` includes a mechanism for reloading certificates.
@@ -1267,12 +1267,11 @@ quarkus.http.insecure-requests=redirect
12671267
12681268
====
12691269

1270-
[[lets-encrypt-prepare]]
1271-
12721270
The challenge is served from the primary HTTP interface (accessible from your DNS domain name).
12731271

12741272
IMPORTANT: Do not start your application yet.
12751273

1274+
[[lets-encrypt-prepare]]
12761275
=== Application preparation
12771276

12781277
Before you request a Let's Encrypt certificate:

0 commit comments

Comments
 (0)