Sync documentation of main branch

actions-user · actions-user · commit bfacdaaa29c8 · 2023-12-06T01:47:58.000Z
diff --git a/_generated-doc/main/config/all-configuration-groups-generated-doc/io.quarkus.vertx.http.runtime.AuthRuntimeConfig b/_generated-doc/main/config/all-configuration-groups-generated-doc/io.quarkus.vertx.http.runtime.AuthRuntimeConfig
diff --git a/_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.vertx.http.runtime.HttpConfiguration b/_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.vertx.http.runtime.HttpConfiguration
diff --git a/_generated-doc/main/config/quarkus-all-config.adoc b/_generated-doc/main/config/quarkus-all-config.adoc
@@ -6551,6 +6551,25 @@ endif::add-copy-button-to-env-var[]
 |
 
 
+a| [[quarkus-vertx-http_quarkus.http.auth.certificate-role-properties]]`link:#quarkus-vertx-http_quarkus.http.auth.certificate-role-properties[quarkus.http.auth.certificate-role-properties]`
+
+
+[.description]
+--
+Properties file containing the client certificate common name (CN) to role mappings. Use it only if the mTLS authentication mechanism is enabled with either `quarkus.http.ssl.client-auth=required` or `quarkus.http.ssl.client-auth=request`.
+
+Properties file is expected to have the `CN=role1,role,...,roleN` format and should be encoded using UTF-8.
+
+ifdef::add-copy-button-to-env-var[]
+Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_AUTH_CERTIFICATE_ROLE_PROPERTIES+++[]
+endif::add-copy-button-to-env-var[]
+ifndef::add-copy-button-to-env-var[]
+Environment variable: `+++QUARKUS_HTTP_AUTH_CERTIFICATE_ROLE_PROPERTIES+++`
+endif::add-copy-button-to-env-var[]
+--|path 
+|
+
+
 a| [[quarkus-vertx-http_quarkus.http.auth.realm]]`link:#quarkus-vertx-http_quarkus.http.auth.realm[quarkus.http.auth.realm]`
 
 
diff --git a/_generated-doc/main/config/quarkus-http-http-configuration.adoc b/_generated-doc/main/config/quarkus-http-http-configuration.adoc
@@ -10,6 +10,25 @@ h|[[quarkus-http-http-configuration_configuration]]link:#quarkus-http-http-confi
 h|Type
 h|Default
 
+a| [[quarkus-http-http-configuration_quarkus.http.auth.certificate-role-properties]]`link:#quarkus-http-http-configuration_quarkus.http.auth.certificate-role-properties[quarkus.http.auth.certificate-role-properties]`
+
+
+[.description]
+--
+Properties file containing the client certificate common name (CN) to role mappings. Use it only if the mTLS authentication mechanism is enabled with either `quarkus.http.ssl.client-auth=required` or `quarkus.http.ssl.client-auth=request`.
+
+Properties file is expected to have the `CN=role1,role,...,roleN` format and should be encoded using UTF-8.
+
+ifdef::add-copy-button-to-env-var[]
+Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_AUTH_CERTIFICATE_ROLE_PROPERTIES+++[]
+endif::add-copy-button-to-env-var[]
+ifndef::add-copy-button-to-env-var[]
+Environment variable: `+++QUARKUS_HTTP_AUTH_CERTIFICATE_ROLE_PROPERTIES+++`
+endif::add-copy-button-to-env-var[]
+--|path 
+|
+
+
 a| [[quarkus-http-http-configuration_quarkus.http.auth.realm]]`link:#quarkus-http-http-configuration_quarkus.http.auth.realm[quarkus.http.auth.realm]`
 
 
diff --git a/_generated-doc/main/config/quarkus-vertx-http-config-group-auth-runtime-config.adoc b/_generated-doc/main/config/quarkus-vertx-http-config-group-auth-runtime-config.adoc
@@ -10,6 +10,25 @@ h|[[quarkus-vertx-http-config-group-auth-runtime-config_configuration]]link:#qua
 h|Type
 h|Default
 
+a| [[quarkus-vertx-http-config-group-auth-runtime-config_quarkus.http.auth.certificate-role-properties]]`link:#quarkus-vertx-http-config-group-auth-runtime-config_quarkus.http.auth.certificate-role-properties[quarkus.http.auth.certificate-role-properties]`
+
+
+[.description]
+--
+Properties file containing the client certificate common name (CN) to role mappings. Use it only if the mTLS authentication mechanism is enabled with either `quarkus.http.ssl.client-auth=required` or `quarkus.http.ssl.client-auth=request`.
+
+Properties file is expected to have the `CN=role1,role,...,roleN` format and should be encoded using UTF-8.
+
+ifdef::add-copy-button-to-env-var[]
+Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_AUTH_CERTIFICATE_ROLE_PROPERTIES+++[]
+endif::add-copy-button-to-env-var[]
+ifndef::add-copy-button-to-env-var[]
+Environment variable: `+++QUARKUS_HTTP_AUTH_CERTIFICATE_ROLE_PROPERTIES+++`
+endif::add-copy-button-to-env-var[]
+--|path 
+|
+
+
 a| [[quarkus-vertx-http-config-group-auth-runtime-config_quarkus.http.auth.realm]]`link:#quarkus-vertx-http-config-group-auth-runtime-config_quarkus.http.auth.realm[quarkus.http.auth.realm]`
 
 
diff --git a/_generated-doc/main/config/quarkus-vertx-http-general-config-items.adoc b/_generated-doc/main/config/quarkus-vertx-http-general-config-items.adoc
@@ -78,6 +78,25 @@ endif::add-copy-button-to-env-var[]
 |`true`
 
 
+a| [[quarkus-vertx-http-general-config-items_quarkus.http.auth.certificate-role-properties]]`link:#quarkus-vertx-http-general-config-items_quarkus.http.auth.certificate-role-properties[quarkus.http.auth.certificate-role-properties]`
+
+
+[.description]
+--
+Properties file containing the client certificate common name (CN) to role mappings. Use it only if the mTLS authentication mechanism is enabled with either `quarkus.http.ssl.client-auth=required` or `quarkus.http.ssl.client-auth=request`.
+
+Properties file is expected to have the `CN=role1,role,...,roleN` format and should be encoded using UTF-8.
+
+ifdef::add-copy-button-to-env-var[]
+Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_AUTH_CERTIFICATE_ROLE_PROPERTIES+++[]
+endif::add-copy-button-to-env-var[]
+ifndef::add-copy-button-to-env-var[]
+Environment variable: `+++QUARKUS_HTTP_AUTH_CERTIFICATE_ROLE_PROPERTIES+++`
+endif::add-copy-button-to-env-var[]
+--|path 
+|
+
+
 a| [[quarkus-vertx-http-general-config-items_quarkus.http.auth.realm]]`link:#quarkus-vertx-http-general-config-items_quarkus.http.auth.realm[quarkus.http.auth.realm]`
 
 
diff --git a/_generated-doc/main/config/quarkus-vertx-http.adoc b/_generated-doc/main/config/quarkus-vertx-http.adoc
@@ -245,6 +245,25 @@ endif::add-copy-button-to-env-var[]
 |
 
 
+a| [[quarkus-vertx-http_quarkus.http.auth.certificate-role-properties]]`link:#quarkus-vertx-http_quarkus.http.auth.certificate-role-properties[quarkus.http.auth.certificate-role-properties]`
+
+
+[.description]
+--
+Properties file containing the client certificate common name (CN) to role mappings. Use it only if the mTLS authentication mechanism is enabled with either `quarkus.http.ssl.client-auth=required` or `quarkus.http.ssl.client-auth=request`.
+
+Properties file is expected to have the `CN=role1,role,...,roleN` format and should be encoded using UTF-8.
+
+ifdef::add-copy-button-to-env-var[]
+Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_AUTH_CERTIFICATE_ROLE_PROPERTIES+++[]
+endif::add-copy-button-to-env-var[]
+ifndef::add-copy-button-to-env-var[]
+Environment variable: `+++QUARKUS_HTTP_AUTH_CERTIFICATE_ROLE_PROPERTIES+++`
+endif::add-copy-button-to-env-var[]
+--|path 
+|
+
+
 a| [[quarkus-vertx-http_quarkus.http.auth.realm]]`link:#quarkus-vertx-http_quarkus.http.auth.realm[quarkus.http.auth.realm]`
 
 
diff --git a/_versions/main/guides/_attributes.adoc b/_versions/main/guides/_attributes.adoc
@@ -22,7 +22,7 @@
 :jandex-version: 3.1.6
 :jandex-gradle-plugin-version: 1.0.0
 :kotlin-version: 1.9.21
-:grpc-version: 1.59.0
+:grpc-version: 1.59.1
 :protoc-version: 3.25.0
 :gcf-invoker-version: 1.3.0
 :hibernate-orm-version: 6.4
diff --git a/_versions/main/guides/kafka.adoc b/_versions/main/guides/kafka.adoc
@@ -1952,10 +1952,8 @@ mp.messaging.outgoing.fruit-out.compression.type=snappy
 ----
 
 In JVM mode, it will work out of the box.
-However, to compile your application to a native executable, you need to:
-
-1. Uses GraalVM 21.+
-2. Add `quarkus.kafka.snappy.enabled=true` to your `application.properties`
+However, to compile your application to a native executable, you need to
+add `quarkus.kafka.snappy.enabled=true` to your `application.properties`.
 
 In native mode, Snappy is disabled by default as the use of Snappy requires embedding a native library and unpacking it when the application starts.
 
diff --git a/_versions/main/guides/scheduler-reference.adoc b/_versions/main/guides/scheduler-reference.adoc
@@ -164,7 +164,7 @@ So for example a Property Expression with the default value `"off"` can be used
 void myMethod() { }
 ----
 
-
+[#identity]
 === Identity
 
 By default, a unique identifier is generated for each scheduled method.
@@ -417,7 +417,7 @@ If the xref:smallrye-metrics.adoc[SmallRye Metrics extension] is present, then a
 
 == OpenTelemetry Tracing
 
-If `quarkus.scheduler.tracing.enabled` is set to `true` and the xref:opentelemetry.adoc[OpenTelemetry extension] is present then the `@io.opentelemetry.instrumentation.annotations.WithSpan` annotation is added automatically to every `@Scheduled` method. As a result, each execution of this method has a new `io.opentelemetry.api.trace.Span` associated.
+If `quarkus.scheduler.tracing.enabled` is set to `true` and the xref:opentelemetry.adoc[OpenTelemetry extension] is present then every job execution, either defined with the `@Scheduled` annotation or scheduled programmatically, automatically creates a span named after the job's xref:identity[Identity].
 
 [[virtual_threads]]
 == Run @Scheduled methods on virtual threads
diff --git a/_versions/main/guides/security-oidc-bearer-token-authentication-tutorial.adoc b/_versions/main/guides/security-oidc-bearer-token-authentication-tutorial.adoc
@@ -19,8 +19,6 @@ For more information about OIDC Bearer token authentication, see the Quarkus xre
 
 If you want to protect web applications by using OIDC Authorization Code Flow authentication, see the xref:security-oidc-code-flow-authentication.adoc[OpenID Connect authorization code flow mechanism for protecting web applications] guide.
 
-:sectnums!:
-
 == Prerequisites
 
 :prerequisites-docker:
@@ -54,9 +52,6 @@ You can clone the Git repository by running the command `git clone {quickstarts-
 
 The solution is located in the `security-openid-connect-quickstart` link:{quickstarts-tree-url}/security-openid-connect-quickstart[directory].
 
-:sectnums:
-:sectnumlevels: 3
-
 == Create the Maven project
 
 You can either create a new Maven project with the `oidc` extension or you can add the extension to an existing Maven project.
@@ -232,7 +227,7 @@ For more information, see the xref:keycloak-dev-mode[Run the application in dev
 docker run --name keycloak -e KEYCLOAK_ADMIN=admin -e KEYCLOAK_ADMIN_PASSWORD=admin -p 8180:8080 quay.io/keycloak/keycloak:{keycloak.version} start-dev
 ----
 ====
-* Where the `keycloak.version` is set to version `17.0.0` or later.
+* Where the `keycloak.version` is set to version `23.0.0` or later.
 . You can access your Keycloak Server at http://localhost:8180[localhost:8180].
 . To access the Keycloak Administration Console, log in as the `admin` user by using the following login credentials:
 
@@ -241,13 +236,13 @@ docker run --name keycloak -e KEYCLOAK_ADMIN=admin -e KEYCLOAK_ADMIN_PASSWORD=ad
 
 . Import the link:{quickstarts-tree-url}/security-openid-connect-quickstart/config/quarkus-realm.json[realm configuration file] from the upstream community repository to create a new realm.
 
-For more information, see the Keycloak documentation about link:https://www.keycloak.org/docs/latest/server_admin/index.html#_create-realm[creating a new realm].
+For more information, see the Keycloak documentation about link:https://www.keycloak.org/docs/latest/server_admin/index.html#configuring-realms[create and configure a new realm].
 
 
 [NOTE]
 ====
 If you want to use the Keycloak Admin Client to configure your server from your application, you need to include either the `quarkus-keycloak-admin-client` or the `quarkus-keycloak-admin-client-reactive` (if the application uses `quarkus-rest-client-reactive`) extension.
-For more information, see the link:{url-quarkusio-guides}security-keycloak-admin-client[Quarkus Keycloak Admin Client] guide.
+For more information, see the xref:security-keycloak-admin-client.adoc[Quarkus Keycloak Admin Client] guide.
 
 ====
 
@@ -260,8 +255,8 @@ For more information, see the link:{url-quarkusio-guides}security-keycloak-admin
 ====
 include::{includes}/devtools/dev.adoc[]
 ====
-* link:{quarkusio-guides}/security-openid-connect-dev-services[Dev Services for Keycloak] will start a Keycloak container and import a `quarkus-realm.json`.
-. Open a link:{url-quarkusio-guides}dev-ui[Dev UI], which you can find at http://localhost:8080/q/dev-ui[/q/dev-ui], then click a `Provider: Keycloak` link in an `OpenID Connect` `Dev UI` card.
+* xref:security-openid-connect-dev-services.adoc[Dev Services for Keycloak] will start a Keycloak container and import a `quarkus-realm.json`.
+. Open a xref:dev-ui.adoc[Dev UI], which you can find at http://localhost:8080/q/dev-ui[/q/dev-ui], then click a `Provider: Keycloak` link in an `OpenID Connect` `Dev UI` card.
 . When prompted to log in to a `Single Page Application` provided by `OpenID Connect Dev UI`, do the following steps:
 
  * Log in as `alice` (password: `alice`), who has a `user` role.
