Skip to content

Commit fec699d

Browse files
committed
Sync documentation of main branch
1 parent 228e850 commit fec699d

10 files changed

+107
-31
lines changed

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

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16029,10 +16029,12 @@ endif::add-copy-button-to-config-props[]
1602916029
--
1603016030
The HTTP host
1603116031

16032-
Defaults to 0.0.0.0
16032+
In dev/test mode this defaults to localhost, in prod mode this defaults to 0.0.0.0
1603316033

1603416034
Defaulting to 0.0.0.0 makes it easier to deploy Quarkus to container, however it is not suitable for dev/test mode as other people on the network can connect to your development machine.
1603516035

16036+
As an exception, when running in Windows Subsystem for Linux (WSL), the HTTP host defaults to 0.0.0.0 even in dev/test mode since using localhost makes the application inaccessible.
16037+
1603616038

1603716039
ifdef::add-copy-button-to-env-var[]
1603816040
Environment variable: env_var_with_copy_button:+++QUARKUS_MANAGEMENT_HOST+++[]
@@ -16042,7 +16044,7 @@ Environment variable: `+++QUARKUS_MANAGEMENT_HOST+++`
1604216044
endif::add-copy-button-to-env-var[]
1604316045
--
1604416046
|string
16045-
|
16047+
|required icon:exclamation-circle[title=Configuration property is required]
1604616048

1604716049
a| [[quarkus-vertx-http_quarkus-management-host-enabled]] [.property-path]##link:#quarkus-vertx-http_quarkus-management-host-enabled[`quarkus.management.host-enabled`]##
1604816050
ifdef::add-copy-button-to-config-props[]
@@ -80998,7 +81000,7 @@ endif::add-copy-button-to-config-props[]
8099881000

8099981001
[.description]
8100081002
--
81001-
The hostname verification algorithm to use in case the server's identity should be checked. Should be `HTTPS`, `LDAPS` or an `NONE` (default).
81003+
The hostname verification algorithm to use in case the server's identity should be checked. Should be `HTTPS`, `LDAPS` or `NONE` (default).
8100281004

8100381005
If set to `NONE`, it does not verify the hostname.
8100481006

@@ -81997,7 +81999,7 @@ endif::add-copy-button-to-config-props[]
8199781999

8199882000
[.description]
8199982001
--
82000-
The hostname verification algorithm to use in case the server's identity should be checked. Should be `HTTPS`, `LDAPS` or an `NONE` (default).
82002+
The hostname verification algorithm to use in case the server's identity should be checked. Should be `HTTPS`, `LDAPS` or `NONE` (default).
8200182003

8200282004
If set to `NONE`, it does not verify the hostname.
8200382005

@@ -90800,7 +90802,7 @@ endif::add-copy-button-to-config-props[]
9080090802

9080190803
[.description]
9080290804
--
90803-
The hostname verification algorithm to use in case the server's identity should be checked. Should be `HTTPS` (default), `LDAPS` or an `NONE`.
90805+
The hostname verification algorithm to use in case the server's identity should be checked. Should be `HTTPS` (default), `LDAPS` or `NONE`.
9080490806

9080590807
If set to `NONE`, it does not verify the hostname.
9080690808

@@ -91734,7 +91736,7 @@ endif::add-copy-button-to-config-props[]
9173491736

9173591737
[.description]
9173691738
--
91737-
The hostname verification algorithm to use in case the server's identity should be checked. Should be `HTTPS` (default), `LDAPS` or an `NONE`.
91739+
The hostname verification algorithm to use in case the server's identity should be checked. Should be `HTTPS` (default), `LDAPS` or `NONE`.
9173891740

9173991741
If set to `NONE`, it does not verify the hostname.
9174091742

_generated-doc/main/config/quarkus-redis-client.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2503,7 +2503,7 @@ endif::add-copy-button-to-config-props[]
25032503

25042504
[.description]
25052505
--
2506-
The hostname verification algorithm to use in case the server's identity should be checked. Should be `HTTPS`, `LDAPS` or an `NONE` (default).
2506+
The hostname verification algorithm to use in case the server's identity should be checked. Should be `HTTPS`, `LDAPS` or `NONE` (default).
25072507

25082508
If set to `NONE`, it does not verify the hostname.
25092509

@@ -3502,7 +3502,7 @@ endif::add-copy-button-to-config-props[]
35023502

35033503
[.description]
35043504
--
3505-
The hostname verification algorithm to use in case the server's identity should be checked. Should be `HTTPS`, `LDAPS` or an `NONE` (default).
3505+
The hostname verification algorithm to use in case the server's identity should be checked. Should be `HTTPS`, `LDAPS` or `NONE` (default).
35063506

35073507
If set to `NONE`, it does not verify the hostname.
35083508

_generated-doc/main/config/quarkus-redis-client_quarkus.redis.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2503,7 +2503,7 @@ endif::add-copy-button-to-config-props[]
25032503

25042504
[.description]
25052505
--
2506-
The hostname verification algorithm to use in case the server's identity should be checked. Should be `HTTPS`, `LDAPS` or an `NONE` (default).
2506+
The hostname verification algorithm to use in case the server's identity should be checked. Should be `HTTPS`, `LDAPS` or `NONE` (default).
25072507

25082508
If set to `NONE`, it does not verify the hostname.
25092509

@@ -3502,7 +3502,7 @@ endif::add-copy-button-to-config-props[]
35023502

35033503
[.description]
35043504
--
3505-
The hostname verification algorithm to use in case the server's identity should be checked. Should be `HTTPS`, `LDAPS` or an `NONE` (default).
3505+
The hostname verification algorithm to use in case the server's identity should be checked. Should be `HTTPS`, `LDAPS` or `NONE` (default).
35063506

35073507
If set to `NONE`, it does not verify the hostname.
35083508

_generated-doc/main/config/quarkus-tls-registry.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -794,7 +794,7 @@ endif::add-copy-button-to-config-props[]
794794

795795
[.description]
796796
--
797-
The hostname verification algorithm to use in case the server's identity should be checked. Should be `HTTPS` (default), `LDAPS` or an `NONE`.
797+
The hostname verification algorithm to use in case the server's identity should be checked. Should be `HTTPS` (default), `LDAPS` or `NONE`.
798798

799799
If set to `NONE`, it does not verify the hostname.
800800

@@ -1728,7 +1728,7 @@ endif::add-copy-button-to-config-props[]
17281728

17291729
[.description]
17301730
--
1731-
The hostname verification algorithm to use in case the server's identity should be checked. Should be `HTTPS` (default), `LDAPS` or an `NONE`.
1731+
The hostname verification algorithm to use in case the server's identity should be checked. Should be `HTTPS` (default), `LDAPS` or `NONE`.
17321732

17331733
If set to `NONE`, it does not verify the hostname.
17341734

_generated-doc/main/config/quarkus-tls-registry_quarkus.tls.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -794,7 +794,7 @@ endif::add-copy-button-to-config-props[]
794794

795795
[.description]
796796
--
797-
The hostname verification algorithm to use in case the server's identity should be checked. Should be `HTTPS` (default), `LDAPS` or an `NONE`.
797+
The hostname verification algorithm to use in case the server's identity should be checked. Should be `HTTPS` (default), `LDAPS` or `NONE`.
798798

799799
If set to `NONE`, it does not verify the hostname.
800800

@@ -1728,7 +1728,7 @@ endif::add-copy-button-to-config-props[]
17281728

17291729
[.description]
17301730
--
1731-
The hostname verification algorithm to use in case the server's identity should be checked. Should be `HTTPS` (default), `LDAPS` or an `NONE`.
1731+
The hostname verification algorithm to use in case the server's identity should be checked. Should be `HTTPS` (default), `LDAPS` or `NONE`.
17321732

17331733
If set to `NONE`, it does not verify the hostname.
17341734

_generated-doc/main/config/quarkus-vertx-http_quarkus.management.adoc

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -279,10 +279,12 @@ endif::add-copy-button-to-config-props[]
279279
--
280280
The HTTP host
281281

282-
Defaults to 0.0.0.0
282+
In dev/test mode this defaults to localhost, in prod mode this defaults to 0.0.0.0
283283

284284
Defaulting to 0.0.0.0 makes it easier to deploy Quarkus to container, however it is not suitable for dev/test mode as other people on the network can connect to your development machine.
285285

286+
As an exception, when running in Windows Subsystem for Linux (WSL), the HTTP host defaults to 0.0.0.0 even in dev/test mode since using localhost makes the application inaccessible.
287+
286288

287289
ifdef::add-copy-button-to-env-var[]
288290
Environment variable: env_var_with_copy_button:+++QUARKUS_MANAGEMENT_HOST+++[]
@@ -292,7 +294,7 @@ Environment variable: `+++QUARKUS_MANAGEMENT_HOST+++`
292294
endif::add-copy-button-to-env-var[]
293295
--
294296
|string
295-
|
297+
|required icon:exclamation-circle[title=Configuration property is required]
296298

297299
a| [[quarkus-vertx-http_quarkus-management-host-enabled]] [.property-path]##link:#quarkus-vertx-http_quarkus-management-host-enabled[`quarkus.management.host-enabled`]##
298300
ifdef::add-copy-button-to-config-props[]

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

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -953,6 +953,14 @@ _No Javadoc found_
953953

954954
_No Javadoc found_
955955

956+
`java.lang.String binaryName`
957+
958+
_No Javadoc found_
959+
960+
`java.lang.String internalName`
961+
962+
_No Javadoc found_
963+
956964
`byte[] classData`
957965

958966
_No Javadoc found_
@@ -4185,7 +4193,7 @@ h|Attributes
41854193

41864194

41874195

4188-
a| https://github.com/quarkusio/quarkus/blob/main/extensions/panache/hibernate-reactive-panache/deployment/src/main/java/io/quarkus/hibernate/reactive/panache/common/deployment/PanacheEntityClassBuildItem.java[`io.quarkus.hibernate.reactive.panache.common.deployment.PanacheEntityClassBuildItem`, window="_blank"]
4196+
a| https://github.com/quarkusio/quarkus/blob/main/extensions/panache/hibernate-reactive-panache/deployment/src/main/java/io/quarkus/hibernate/reactive/panache/deployment/PanacheEntityClassBuildItem.java[`io.quarkus.hibernate.reactive.panache.deployment.PanacheEntityClassBuildItem`, window="_blank"]
41894197
[.description]
41904198
--
41914199
Represents a regular Panache entity class.

_versions/main/guides/conditional-extension-dependencies.adoc

Lines changed: 59 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,19 +9,19 @@ include::_attributes.adoc[]
99
:summary: Trigger the inclusion on additional extensions based on certain conditions.
1010
:topics: extensions
1111

12-
Quarkus extension dependencies are usually configured in the same way as any other project dependencies in a project's build file, e.g. the Maven `pom.xml` or the Gradle build scripts. However, Quarkus also supports types of dependencies that aren't supported out-of-the-box by Maven and Gradle. Conditional Quarkus extension dependencies falls into that category.
12+
Quarkus extension dependencies are usually configured in the same way as any other project dependencies in a project's build file, for example the Maven `pom.xml` or the Gradle build scripts. However, Quarkus also supports types of dependencies that aren't supported out-of-the-box by Maven and Gradle. Conditional Quarkus extension dependencies is one such example.
1313

1414
== Conditional Dependencies
1515

16-
A conditional dependency is a dependency that is activated only if a certain condition is satisfied. If the condition is not satisfied then the dependency **must not** be activated. In that regard, conditional dependencies can be categorized as optional, meaning they may or may not appear in the resulting dependency graph.
16+
A conditional dependency is a dependency that is activated only if a certain condition is satisfied. If the condition is not satisfied then the dependency **will not** be activated. In that regard, conditional dependencies can be categorized as optional, meaning they may or may not appear in the resulting dependency graph.
1717

1818
A typical example of a conditional dependency would be a component that should be added to the classpath **only** in case all of its required dependencies are present on the classpath. If one or more of the component's required dependencies aren't available, instead of failing, the component should simply not be added.
1919

2020
== Conditional Quarkus Extension Dependencies
2121

22-
A Quarkus extension may declare one or more conditional dependencies on other Quarkus extensions. Conditional dependencies on and from non-extension artifacts aren't supported.
22+
A Quarkus extension may declare one or more conditional dependencies on other Quarkus extensions or regular Maven artifacts.
2323

24-
Let's consider the following scenario as an example: `quarkus-extension-a` has an optional dependency on `quarkus-extension-b` which should be included in a Quarkus application only if `quarkus-extension-c` is found among the application dependencies (direct or transitive). In this case, the presence of `quarkus-extension-c` is the condition which, if satisfied, will trigger inclusion of the `quarkus-extension-b` when Quarkus application dependencies are resolved.
24+
Let's consider the following scenario as an example: `quarkus-extension-a` has an optional dependency on `quarkus-extension-b` which should be included in a Quarkus application only if `quarkus-extension-c` is found among the application dependencies (direct or transitive). In this case, the presence of `quarkus-extension-c` is the condition, which, if satisfied, will trigger inclusion of the `quarkus-extension-b` when Quarkus application dependencies are resolved.
2525

2626
The condition which triggers activation of an extension is configured in the extension's `META-INF/quarkus-extension.properties`, which is included in the runtime artifact of the extension. Extension developers can add the following configuration to express the condition which would have to be satisfied for the extension to be activated:
2727

@@ -66,11 +66,13 @@ The condition which triggers activation of an extension is configured in the ext
6666
<3> configuration of the dependency condition which will have to be satisfied for this extension to be added to a Quarkus application expressed as a list of artifacts that must be present among the application dependencies;
6767
<4> an artifact key (in the format of `groupId:artifactId[:<classifier>:<extension>]` but typically simply `<groupId>:<artifactId>`) of the artifact that must be present among the application dependencies for the condition to be satisfied.
6868

69-
NOTE: In the example above the `artifact` used in the condition configuration happens to be a runtime Quarkus extension artifact but it could as well be any other artifact. There could also be more than one `artifact` element in the body of the `dependencyCondition`.
69+
NOTE: In the example above the `artifact` used in the condition configuration happens to be a runtime Quarkus extension artifact but it could as well be any other artifact.
70+
71+
The `dependencyCondition` element may contain more than `artifact`, in which case all the configured artifacts must be present on the classpath for the condition to be satisfied.
7072

7173
Now, having a dependency condition recorded in the descriptor of the `quarkus-extension-b`, other extensions may declare a conditional dependency on it.
7274

73-
NOTE: extensions with dependency conditions present in their metadata could still appear as regular dependencies in Maven `pom.xml` and Gradle build scripts.
75+
NOTE: extensions with dependency conditions present in their metadata could still appear as regular dependencies in Maven `pom.xml` and Gradle build scripts, in which case their conditions will simply be ignored.
7476

7577
A conditional dependency is configured in the runtime artifact of a Quarkus extension. In this example, the `quarkus-extension-a` will declare a conditional dependency on the `quarkus-extension-b`, which can be done in the following two ways.
7678

@@ -164,7 +166,7 @@ Conditional dependencies can also be configured in the Quarkus extension descrip
164166
</goals>
165167
<configuration>
166168
<conditionalDependencies> <3>
167-
<extension>org.acme:quarkus-extension-b:${b.version}</extension> <4>
169+
<artifact>org.acme:quarkus-extension-b:${b.version}</artifact> <4>
168170
</conditionalDependencies>
169171
</configuration>
170172
</execution>
@@ -212,7 +214,7 @@ Dev mode-only extension dependencies can be configured in the Quarkus extension
212214
</goals>
213215
<configuration>
214216
<conditionalDevDependencies> <3>
215-
<extension>org.acme:quarkus-extension-b:${b.version}</extension> <4>
217+
<artifact>org.acme:quarkus-extension-b:${b.version}</artifact> <4>
216218
</conditionalDevDependencies>
217219
</configuration>
218220
</execution>
@@ -223,11 +225,58 @@ Dev mode-only extension dependencies can be configured in the Quarkus extension
223225
----
224226
<1> the runtime Quarkus extension artifact ID;
225227
<2> the goal that generates the extension descriptor which every Quarkus runtime extension project should be configured with;
226-
<3> the dev mode conditional dependency configuration element;
227-
<4> the artifact coordinates of conditional dependencies on extensions that should be evaluated only if an application is launched in dev mode.
228+
<3> conditional dependencies that should be evaluated only in dev mode;
229+
<4> the artifact coordinates of a conditional dependency.
228230

229231
The `quarkus-extension-b`, in this example, may or may not define its own condition to be evaluated.
230232

231233
If the `quarkus-extension-b` does not define a dependency condition on its own (there is no dependency condition recorded in its `META-INF/quarkus-extension.properties`), the `quarkus-extension-b` will only be added as a dependency of the `quarkus-extension-a` in dev mode but not in other modes (prod or test).
232234

233235
If the `quarkus-extension-b` does define a dependency condition on its own (a dependency condition recorded in its `META-INF/quarkus-extension.properties`), the `quarkus-extension-b` will be added as a dependency of the `quarkus-extension-a` in dev mode only if its condition is satisfied (the artifacts it requires are present in the application dependency graph).
236+
237+
=== Dev mode dependencies on regular Maven artifacts
238+
239+
Extensions may also declare conditional dependencies on regular Maven artifacts, that are not Quarkus extensions. Given that regular Maven artifacts do not include Quarkus metadata, the condition for their inclusion is configured by an extension depending on them.
240+
241+
For example
242+
[source,xml]
243+
----
244+
<project xmlns="http://maven.apache.org/POM/4.0.0"
245+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
246+
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
247+
248+
<!-- SKIPPED CONTENT -->
249+
250+
<artifactId>quarkus-extension-a</artifactId> <1>
251+
252+
<!-- SKIPPED CONTENT -->
253+
254+
<build>
255+
<plugins>
256+
<plugin>
257+
<groupId>io.quarkus</groupId>
258+
<artifactId>quarkus-extension-maven-plugin</artifactId>
259+
<version>${quarkus.version}</version>
260+
<executions>
261+
<execution>
262+
<phase>process-resources</phase>
263+
<goals>
264+
<goal>extension-descriptor</goal> <2>
265+
</goals>
266+
<configuration>
267+
<conditionalDevDependencies> <3>
268+
<artifact>org.acme:library-b:${b.version}</artifact> <4>
269+
</conditionalDevDependencies>
270+
</configuration>
271+
</execution>
272+
</executions>
273+
</plugin>
274+
275+
<!-- SKIPPED CONTENT -->
276+
----
277+
<1> the runtime Quarkus extension artifact ID;
278+
<2> the goal that generates the extension descriptor which every Quarkus runtime extension project should be configured with;
279+
<3> conditional dependencies that should be evaluated only in dev mode;
280+
<4> the artifact coordinates of a conditional dependency.
281+
282+
In this example `library-b` is a regular Maven artifact that will be added as a dependency of the `quarkus-extension-a` only when an application is launched in dev mode.

_versions/main/guides/management-interface-reference.adoc

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,15 +40,30 @@ NOTE: The management interface is disabled when no extensions relying on it (suc
4040
By default, the management interface is exposed on the interface: `0.0.0.0` (all interfaces) and on the port `9000` (`9001` in test mode).
4141
It does not use TLS (`https`) by default.
4242

43-
You can configure the host, ports, and TLS certificates using the following properties:
43+
You can configure the host, ports, and TLS configuration name using the following properties:
4444

4545
* `quarkus.management.host` - the interface / host
4646
* `quarkus.management.port` - the port
4747
* `quarkus.management.test-port` - the port to use in test mode
48-
* `quarkus.management.ssl` - the TLS configuration, xref:http-reference#ssl[same as for the main HTTP server].
48+
* `quarkus.management.tls-configuration-name` - the TLS configuration name, xref:http-reference.adoc#using-the-tls-centralized-configuration[same as for the main HTTP server].
4949

5050
Here is a configuration example exposing the management interface on _https://localhost:9002_:
5151

52+
[source, properties]
53+
----
54+
quarkus.management.enabled=true
55+
quarkus.management.host=localhost
56+
quarkus.management.port=9002
57+
quarkus.management.tls-configuration-name=management
58+
59+
# Your TLS registry configuration
60+
...
61+
----
62+
63+
With this configuration, TLS is enabled and configured as defined in the `management` configuration of the TLS registry.
64+
65+
You can also configure the management interface with the legacy SSL configuration, as for (xref:http-reference.adoc#ssl[the main HTTP server]):
66+
5267
[source, properties]
5368
----
5469
quarkus.management.enabled=true

0 commit comments

Comments
 (0)