Sync documentation of main branch

actions-user · actions-user · commit 6b9da87b0ce3 · 2024-09-24T02:02:59.000Z
diff --git a/_generated-doc/main/config/quarkus-all-config.adoc b/_generated-doc/main/config/quarkus-all-config.adoc
@@ -11903,6 +11903,45 @@ endif::add-copy-button-to-env-var[]
 |`All proxy addresses are trusted`
 
 
+h|[[quarkus-vertx-http_section_quarkus-http-websocket-server]] [.section-name.section-level0]##WebSocket Server configuration##
+h|Type
+h|Default
+
+a| [[quarkus-vertx-http_quarkus-http-websocket-server-max-frame-size]] [.property-path]##`quarkus.http.websocket-server.max-frame-size`##
+
+[.description]
+--
+The maximum amount of data that can be sent in a single frame. Messages larger than this must be broken up into continuation frames. Default 65536 (from HttpServerOptions of Vert.X HttpServerOptions)
+
+
+ifdef::add-copy-button-to-env-var[]
+Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_WEBSOCKET_SERVER_MAX_FRAME_SIZE+++[]
+endif::add-copy-button-to-env-var[]
+ifndef::add-copy-button-to-env-var[]
+Environment variable: `+++QUARKUS_HTTP_WEBSOCKET_SERVER_MAX_FRAME_SIZE+++`
+endif::add-copy-button-to-env-var[]
+--
+|int
+|
+
+a| [[quarkus-vertx-http_quarkus-http-websocket-server-max-message-size]] [.property-path]##`quarkus.http.websocket-server.max-message-size`##
+
+[.description]
+--
+The maximum WebSocket message size. Default 262144 (from HttpServerOptions of Vert.X HttpServerOptions)
+
+
+ifdef::add-copy-button-to-env-var[]
+Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_WEBSOCKET_SERVER_MAX_MESSAGE_SIZE+++[]
+endif::add-copy-button-to-env-var[]
+ifndef::add-copy-button-to-env-var[]
+Environment variable: `+++QUARKUS_HTTP_WEBSOCKET_SERVER_MAX_MESSAGE_SIZE+++`
+endif::add-copy-button-to-env-var[]
+--
+|int
+|
+
+
 a|icon:lock[title=Fixed at build time] [[quarkus-vertx-http_quarkus-management-enabled]] [.property-path]##`quarkus.management.enabled`##
 
 [.description]
@@ -51831,7 +51870,7 @@ Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_IMAGE_NAME+++`
 endif::add-copy-button-to-env-var[]
 --
 |string
-|`quay.io/keycloak/keycloak:25.0.4`
+|`quay.io/keycloak/keycloak:25.0.6`
 
 a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-keycloak-devservices-keycloak-x-image]] [.property-path]##`quarkus.keycloak.devservices.keycloak-x-image`##
 
diff --git a/_generated-doc/main/config/quarkus-oidc_quarkus.keycloak.adoc b/_generated-doc/main/config/quarkus-oidc_quarkus.keycloak.adoc
@@ -44,7 +44,7 @@ Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_IMAGE_NAME+++`
 endif::add-copy-button-to-env-var[]
 --
 |string
-|`quay.io/keycloak/keycloak:25.0.4`
+|`quay.io/keycloak/keycloak:25.0.6`
 
 a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-keycloak-devservices-keycloak-x-image]] [.property-path]##`quarkus.keycloak.devservices.keycloak-x-image`##
 
diff --git a/_generated-doc/main/config/quarkus-oidc_quarkus.keycloak.devservices.adoc b/_generated-doc/main/config/quarkus-oidc_quarkus.keycloak.devservices.adoc
@@ -40,7 +40,7 @@ Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_IMAGE_NAME+++`
 endif::add-copy-button-to-env-var[]
 --
 |string
-|`quay.io/keycloak/keycloak:25.0.4`
+|`quay.io/keycloak/keycloak:25.0.6`
 
 a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-keycloak-devservices_quarkus-keycloak-devservices-keycloak-x-image]] [.property-path]##`quarkus.keycloak.devservices.keycloak-x-image`##
 
diff --git a/_generated-doc/main/config/quarkus-vertx-http_quarkus.http.adoc b/_generated-doc/main/config/quarkus-vertx-http_quarkus.http.adoc
@@ -2983,6 +2983,45 @@ endif::add-copy-button-to-env-var[]
 |`All proxy addresses are trusted`
 
 
+h|[[quarkus-vertx-http_section_quarkus-http-websocket-server]] [.section-name.section-level0]##WebSocket Server configuration##
+h|Type
+h|Default
+
+a| [[quarkus-vertx-http_quarkus-http-websocket-server-max-frame-size]] [.property-path]##`quarkus.http.websocket-server.max-frame-size`##
+
+[.description]
+--
+The maximum amount of data that can be sent in a single frame. Messages larger than this must be broken up into continuation frames. Default 65536 (from HttpServerOptions of Vert.X HttpServerOptions)
+
+
+ifdef::add-copy-button-to-env-var[]
+Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_WEBSOCKET_SERVER_MAX_FRAME_SIZE+++[]
+endif::add-copy-button-to-env-var[]
+ifndef::add-copy-button-to-env-var[]
+Environment variable: `+++QUARKUS_HTTP_WEBSOCKET_SERVER_MAX_FRAME_SIZE+++`
+endif::add-copy-button-to-env-var[]
+--
+|int
+|
+
+a| [[quarkus-vertx-http_quarkus-http-websocket-server-max-message-size]] [.property-path]##`quarkus.http.websocket-server.max-message-size`##
+
+[.description]
+--
+The maximum WebSocket message size. Default 262144 (from HttpServerOptions of Vert.X HttpServerOptions)
+
+
+ifdef::add-copy-button-to-env-var[]
+Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_WEBSOCKET_SERVER_MAX_MESSAGE_SIZE+++[]
+endif::add-copy-button-to-env-var[]
+ifndef::add-copy-button-to-env-var[]
+Environment variable: `+++QUARKUS_HTTP_WEBSOCKET_SERVER_MAX_MESSAGE_SIZE+++`
+endif::add-copy-button-to-env-var[]
+--
+|int
+|
+
+
 |===
 
 ifndef::no-duration-note[]
diff --git a/_generated-doc/main/infra/quarkus-all-build-items.adoc b/_generated-doc/main/infra/quarkus-all-build-items.adoc
@@ -8543,6 +8543,10 @@ _No Javadoc found_
 
 _No Javadoc found_
 
+`java.util.Map<String,RuntimeValue> recordedValues` 
+
+_No Javadoc found_
+
 
 
 
@@ -8943,6 +8947,17 @@ _No Javadoc found_
 
 
 
+a| https://github.com/quarkusio/quarkus/blob/main/extensions/vertx-http/deployment/src/main/java/io/quarkus/vertx/http/deployment/VertxDevUILogBuildItem.java[`io.quarkus.vertx.http.deployment.VertxDevUILogBuildItem`, window="_blank"]
+[.description]
+--
+Used to create the publisher for the vertx access log in dev ui
+-- a|`io.quarkus.runtime.RuntimeValue<SubmissionPublisher<String>> publisher` 
+
+_No Javadoc found_
+
+
+
+
 a| https://github.com/quarkusio/quarkus/blob/main/extensions/vertx-http/deployment/src/main/java/io/quarkus/vertx/http/deployment/VertxWebRouterBuildItem.java[`io.quarkus.vertx.http.deployment.VertxWebRouterBuildItem`, window="_blank"]
 [.description]
 --
@@ -9087,6 +9102,25 @@ _No Javadoc found_
 
 
 
+a| https://github.com/quarkusio/quarkus/blob/main/extensions/vertx-http/dev-ui-spi/src/main/java/io/quarkus/devui/spi/buildtime/FooterLogBuildItem.java[`io.quarkus.devui.spi.buildtime.FooterLogBuildItem`, window="_blank"]
+[.description]
+--
+Add a log to the footer of dev ui
+-- a|`java.lang.String name` 
+
+_No Javadoc found_
+
+`java.util.function.Supplier<Flow.Publisher<String>> publisherSupplier` 
+
+_No Javadoc found_
+
+`io.quarkus.runtime.RuntimeValue<SubmissionPublisher<String>> runtimePublisher` 
+
+_No Javadoc found_
+
+
+
+
 a| https://github.com/quarkusio/quarkus/blob/main/extensions/vertx-http/dev-ui-spi/src/main/java/io/quarkus/devui/spi/page/FooterPageBuildItem.java[`io.quarkus.devui.spi.page.FooterPageBuildItem`, window="_blank"]
 [.description]
 --
diff --git a/_versions/main/guides/_attributes.adoc b/_versions/main/guides/_attributes.adoc
@@ -18,7 +18,7 @@
 :infinispan-protostream-version: ${infinispan.protostream.version}
 :logstash-image: docker.io/elastic/logstash:8.15.0
 :kibana-image: docker.io/elastic/kibana:8.15.0
-:keycloak-docker-image: quay.io/keycloak/keycloak:25.0.4
+:keycloak-docker-image: quay.io/keycloak/keycloak:25.0.6
 :jandex-version: 3.2.2
 :jandex-gradle-plugin-version: 1.0.0
 :kotlin-version: 2.0.20
@@ -63,6 +63,7 @@
 :vault-datasource-guide: https://quarkiverse.github.io/quarkiverse-docs/quarkus-vault/dev/vault-datasource.html
 :micrometer-registry-guide: https://quarkiverse.github.io/quarkiverse-docs/quarkus-micrometer-registry/dev/index.html
 :quarkus-migration-guide: https://github.com/quarkusio/quarkus/wiki/Migration-Guides[Migration Guides]
+:quarkus-tls-registry-reference-guide: TLS registry reference
 // .
 :create-app-group-id: org.acme
 :create-cli-group-id: {create-app-group-id}
diff --git a/_versions/main/guides/dev-ui.adoc b/_versions/main/guides/dev-ui.adoc
@@ -47,7 +47,7 @@ Extensions can:
 
 - <<add-links-to-an-extension-card,Add links to an extension card>>
 - <<add-full-pages,Add full custom pages>>
-- <<add-a-log-file,Add a log stream>>
+- <<add-a-footer-tab,Add a footer tab>>
 - <<add-a-section-menu,Add a section menu>>
 - <<custom-cards,Create a custom card>>
 
@@ -822,7 +822,7 @@ https://github.com/quarkusio/quarkus/blob/main/extensions/vertx-http/dev-ui-reso
 ====== Log
 
 The log controller is used to add control buttons to a (footer) log.
-See <<Add a log file>>.
+See <<Add a footer tab>>.
 
 image::dev-ui-log-control-v2.png[alt=Dev UI Log control,role="center"]
 
@@ -1145,9 +1145,9 @@ See the https://github.com/quarkusio/quarkus/tree/main/extensions/vertx-http/dev
 The state in Dev UI uses https://github.com/gitaarik/lit-state[LitState]. You can read more about it in their https://gitaarik.github.io/lit-state/build/[documentation].
 
 
-== Add a log file
+== Add a footer tab
 
-Apart from adding a card and a page, extensions can add a log to the footer. This is useful for logging things that are happening continuously. A page will lose connection to the backend when navigating away from that page, and a log in the footer will be permanently connected.
+Apart from adding a card and a page, extensions can add a tab to the footer. This is useful for things that are happening continuously. A page will lose connection to the backend when navigating away from that page, and a log in the footer will be permanently connected.
 
 Adding something to the footer works exactly like adding a Card, except you use a `FooterPageBuildItem` rather than a `CardPageBuildItem`.
 
@@ -1179,6 +1179,59 @@ export class QwcJokesLog extends LitElement {
 
 https://github.com/phillip-kruger/quarkus-jokes/blob/main/deployment/src/main/resources/dev-ui/qwc-jokes-log.js[Example code]
 
+=== Add a log to the footer
+
+There is an easy way to add a log stream to the footer, without having to create the above mentioned footer. 
+If you just want to stream a log to a tab you can just produce a `FooterLogBuildItem`. This way you only provide a name and a `Flow.Publisher<String>` for your log.
+
+Here is an example from the Dev Services deployment module:
+
+[source,java]
+----
+@BuildStep(onlyIf = { IsDevelopment.class })
+public List<DevServiceDescriptionBuildItem> config(
+        // ...
+        BuildProducer<FooterLogBuildItem> footerLogProducer){
+
+        // ...
+
+    // Dev UI Log stream
+    for (DevServiceDescriptionBuildItem service : serviceDescriptions) {
+        if (service.getContainerInfo() != null) {
+            footerLogProducer.produce(new FooterLogBuildItem(service.getName(), () -> {
+                return createLogPublisher(service.getContainerInfo().getId());
+            }));
+        }
+    }
+}
+
+// ...
+
+private Flow.Publisher<String> createLogPublisher(String containerId) {
+    try (FrameConsumerResultCallback resultCallback = new FrameConsumerResultCallback()) {
+        SubmissionPublisher<String> publisher = new SubmissionPublisher<>();
+        resultCallback.addConsumer(OutputFrame.OutputType.STDERR,
+                frame -> publisher.submit(frame.getUtf8String()));
+        resultCallback.addConsumer(OutputFrame.OutputType.STDOUT,
+                frame -> publisher.submit(frame.getUtf8String()));
+        LogContainerCmd logCmd = DockerClientFactory.lazyClient()
+                .logContainerCmd(containerId)
+                .withFollowStream(true)
+                .withTailAll()
+                .withStdErr(true)
+                .withStdOut(true);
+        logCmd.exec(resultCallback);
+
+        return publisher;
+    } catch (Exception e) {
+        throw new RuntimeException(e);
+    }
+}
+
+----
+
+
+
 == Add a section menu
 
 This allows an extension to link a page directly in the section Menu.
diff --git a/_versions/main/guides/picocli.adoc b/_versions/main/guides/picocli.adoc
@@ -298,6 +298,10 @@ annotationProcessor 'info.picocli:picocli-codegen'
 == Development Mode
 
 In the development mode, i.e. when running `mvn quarkus:dev`, the application is executed and restarted every time the `Space bar` key is pressed. You can also pass arguments to your command line app via the `quarkus.args` system property, e.g. `mvn quarkus:dev -Dquarkus.args='--help'` and `mvn quarkus:dev -Dquarkus.args='-c -w --val 1'`. For gradle project arguments can be passed using `--quarkus-args`.
+[NOTE]
+====
+If you're creating a typical Quarkus application (e.g., HTTP-based services) that includes command-line functionality, you'll need to handle the application's lifecycle differently. In the `Runnable.run()` method of your command, make sure to use `Quarkus.waitForExit()` or `Quarkus.asyncExit()`. This will prevent the application from shutting down prematurely and ensure a proper shutdown process.
+====
 
 == Kubernetes support
 
diff --git a/_versions/main/guides/security-keycloak-authorization.adoc b/_versions/main/guides/security-keycloak-authorization.adoc
@@ -226,7 +226,7 @@ To start a Keycloak server, use the following Docker command:
 docker run --name keycloak -e KEYCLOAK_ADMIN=admin -e KEYCLOAK_ADMIN_PASSWORD=admin -p 8543:8443 -v "$(pwd)"/config/keycloak-keystore.jks:/etc/keycloak-keystore.jks quay.io/keycloak/keycloak:{keycloak.version} start  --hostname-strict=false --https-key-store-file=/etc/keycloak-keystore.jks
 ----
 
-where `keycloak.version` must be `25.0.4` or later and the `keycloak-keystore.jks` can be found in https://github.com/quarkusio/quarkus-quickstarts/blob/main/security-keycloak-authorization-quickstart/config/keycloak-keystore.jks[quarkus-quickstarts/security-keycloak-authorization-quickstart/config].
+where `keycloak.version` must be `25.0.6` or later and the `keycloak-keystore.jks` can be found in https://github.com/quarkusio/quarkus-quickstarts/blob/main/security-keycloak-authorization-quickstart/config/keycloak-keystore.jks[quarkus-quickstarts/security-keycloak-authorization-quickstart/config].
 
 Try to access your Keycloak server at https://localhost:8543[localhost:8543].
 
diff --git a/_versions/main/guides/security-oidc-bearer-token-authentication-tutorial.adoc b/_versions/main/guides/security-oidc-bearer-token-authentication-tutorial.adoc
@@ -217,7 +217,7 @@ For more information, see the <<bearer-token-tutorial-keycloak-dev-mode>> sectio
 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 `25.0.4` or later.
+* Where the `keycloak.version` is set to version `25.0.6` 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:
 
diff --git a/_versions/main/guides/security-oidc-code-flow-authentication-tutorial.adoc b/_versions/main/guides/security-oidc-code-flow-authentication-tutorial.adoc
@@ -201,7 +201,7 @@ To start a Keycloak server, use Docker and run the following command:
 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 `keycloak.version` is set to `25.0.4` or later.
+where `keycloak.version` is set to `25.0.6` or later.
 
 You can access your Keycloak Server at http://localhost:8180[localhost:8180].
 
diff --git a/_versions/main/guides/security-openid-connect-client.adoc b/_versions/main/guides/security-openid-connect-client.adoc
@@ -507,7 +507,7 @@ To start a Keycloak Server, you can use Docker and just run the following comman
 docker run --name keycloak -e KEYCLOAK_ADMIN=admin -e KEYCLOAK_ADMIN_PASSWORD=admin -p 8180:8080 quay.io/keycloak/keycloak:{keycloak.version} start-dev
 ----
 
-Set `{keycloak.version}` to `25.0.2` or later.
+Set `{keycloak.version}` to `25.0.6` or later.
 
 You can access your Keycloak Server at http://localhost:8180[localhost:8180].
 
diff --git a/_versions/main/guides/security-openid-connect-dev-services.adoc b/_versions/main/guides/security-openid-connect-dev-services.adoc
@@ -258,7 +258,7 @@ For more information, see xref:security-oidc-bearer-token-authentication.adoc#be
 [[keycloak-initialization]]
 === Keycloak initialization
 
-The `quay.io/keycloak/keycloak:25.0.4` image which contains a Keycloak distribution powered by Quarkus is used to start a container by default.
+The `quay.io/keycloak/keycloak:25.0.6` image which contains a Keycloak distribution powered by Quarkus is used to start a container by default.
 `quarkus.keycloak.devservices.image-name` can be used to change the Keycloak image name.
 For example, set it to `quay.io/keycloak/keycloak:19.0.3-legacy` to use a Keycloak distribution powered by WildFly.
 Be aware that a Quarkus-based Keycloak distribution is only available starting from Keycloak `20.0.0`.
diff --git a/_versions/main/guides/security-openid-connect-multitenancy.adoc b/_versions/main/guides/security-openid-connect-multitenancy.adoc
@@ -356,7 +356,7 @@ To start a Keycloak server, you can use Docker and run the following command:
 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 `keycloak.version` is set to `25.0.4` or higher.
+where `keycloak.version` is set to `25.0.6` or higher.
 
 Access your Keycloak server at http://localhost:8180[localhost:8180].
 
@@ -894,19 +894,21 @@ quarkus.oidc.tenant-b.credentials.secret=${tenant-b-client-secret}
 
 Tenant resolution for the OIDC `web-app` applications must be done at least 3 times during an authorization code flow, when the OIDC tenant-specific configuration affects how each of the following steps is run.
 
-==== Step 1: Unauthenticated user accesses an endpoint and is redirected to OIDC provider
+.Step 1: Unauthenticated user accesses an endpoint and is redirected to OIDC provider
 
 When an unauthenticated user accesses a secured path, the user is redirected to the OIDC provider to authenticate and the tenant configuration is used to build the redirect URI.
 
 All the static and dynamic tenant resolution options listed in the <<static-tenant-resolution>> and <<tenant-config-resolver>> sections can be used to resolve a tenant.
 
-==== Step 2: The user is redirected back to the endpoint
+.Step 2: The user is redirected back to the endpoint
 
 After the provider authentication, the user is redirected back to the Quarkus endpoint and the tenant configuration is used to complete the authorization code flow.
 
 All the static and dynamic tenant resolution options listed in the <<static-tenant-resolution>> and <<tenant-config-resolver>> sections can be used to resolve a tenant. Before the tenant resolution begins, the authorization code flow `state cookie` is used to set the already resolved tenant configuration id as a RoutingContext `tenant-id` attribute: both custom dynamic `TenantConfigResolver` and static `TenantResolver` tenant resolvers can check it.
 
-==== Step 3: Authenticated user accesses the secured path using the session cookie: the tenant configuration determines how the session cookie is verified and refreshed. Before the tenant resolution begins, the authorization code flow `session cookie` is used to set the already resolved tenant configuration id as a RoutingContext `tenant-id` attribute: both custom dynamic `TenantConfigResolver` and static `TenantResolver` tenant resolvers can check it.
+.Step 3: Authenticated user accesses the secured path using the session cookie
+
+The tenant configuration determines how the session cookie is verified and refreshed. Before the tenant resolution begins, the authorization code flow `session cookie` is used to set the already resolved tenant configuration id as a RoutingContext `tenant-id` attribute: both custom dynamic `TenantConfigResolver` and static `TenantResolver` tenant resolvers can check it.
 
 For example, here is how a custom `TenantConfigResolver` can avoid creating the already resolved tenant configuration, that may otherwise require blocking reads from the database or other remote sources:
 
diff --git a/_versions/main/guides/tls-registry-reference.adoc b/_versions/main/guides/tls-registry-reference.adoc
@@ -4,7 +4,7 @@ and pull requests should be submitted there:
 https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc
 ////
 [id="tls-registry-reference"]
-= TLS registry reference
+= {quarkus-tls-registry-reference-guide}
 include::_attributes.adoc[]
 :categories: web
 :summary: TLS registry configuration and usage
