Skip to content

Commit

Permalink
Adapt update-extension-doc-page mojo to Quarkus 3.14.0.CR1
Browse files Browse the repository at this point in the history
  • Loading branch information
ppalaga committed Aug 14, 2024
1 parent 889904b commit 05bdba7
Show file tree
Hide file tree
Showing 330 changed files with 361 additions and 8,754 deletions.
28 changes: 17 additions & 11 deletions docs/modules/ROOT/pages/reference/extensions/core.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ A comma-separated list of Ant-path style patterns to match Camel service definit
The excludes have higher precedence than includes. The excludes defined here can also be used to veto the discoverability of services included by Camel Quarkus extensions.

Example values: `META-INF/services/org/apache/camel/foo/++*++,META-INF/services/org/apache/camel/foo/++**++/bar`
| `string`
| List of `string`
|

|icon:lock[title=Fixed at build time] [[quarkus.camel.service.discovery.include-patterns]]`link:#quarkus.camel.service.discovery.include-patterns[quarkus.camel.service.discovery.include-patterns]`
Expand All @@ -153,7 +153,7 @@ A comma-separated list of Ant-path style patterns to match Camel service definit
Note that Camel Quarkus extensions may include some services by default. The services selected here added to those services and the exclusions defined in `exclude-patterns` are applied to the union set.

Example values: `META-INF/services/org/apache/camel/foo/++*++,META-INF/services/org/apache/camel/foo/++**++/bar`
| `string`
| List of `string`
|

|icon:lock[title=Fixed at build time] [[quarkus.camel.service.registry.exclude-patterns]]`link:#quarkus.camel.service.registry.exclude-patterns[quarkus.camel.service.registry.exclude-patterns]`
Expand All @@ -163,7 +163,7 @@ A comma-separated list of Ant-path style patterns to match Camel service definit
The excludes have higher precedence than includes. The excludes defined here can also be used to veto the registration of services included by Camel Quarkus extensions.

Example values: `META-INF/services/org/apache/camel/foo/++*++,META-INF/services/org/apache/camel/foo/++**++/bar`**
| `string`
| List of `string`
|

|icon:lock[title=Fixed at build time] [[quarkus.camel.service.registry.include-patterns]]`link:#quarkus.camel.service.registry.include-patterns[quarkus.camel.service.registry.include-patterns]`
Expand All @@ -173,7 +173,7 @@ A comma-separated list of Ant-path style patterns to match Camel service definit
Note that Camel Quarkus extensions may include some services by default. The services selected here added to those services and the exclusions defined in `exclude-patterns` are applied to the union set.

Example values: `META-INF/services/org/apache/camel/foo/++*++,META-INF/services/org/apache/camel/foo/++**++/bar`
| `string`
| List of `string`
|

|icon:lock[title=Fixed at build time] [[quarkus.camel.runtime-catalog.components]]`link:#quarkus.camel.runtime-catalog.components[quarkus.camel.runtime-catalog.components]`
Expand Down Expand Up @@ -233,13 +233,13 @@ Enable automatic discovery of routes during static initialization.
|icon:lock[title=Fixed at build time] [[quarkus.camel.routes-discovery.exclude-patterns]]`link:#quarkus.camel.routes-discovery.exclude-patterns[quarkus.camel.routes-discovery.exclude-patterns]`

Used for exclusive filtering scanning of RouteBuilder classes. The exclusive filtering takes precedence over inclusive filtering. The pattern is using Ant-path style pattern. Multiple patterns can be specified separated by comma. For example to exclude all classes starting with Bar use: ++**++/Bar++*++ To exclude all routes form a specific package use: com/mycompany/bar/++*++ To exclude all routes form a specific package and its sub-packages use double wildcards: com/mycompany/bar/++**++ And to exclude all routes from two specific packages use: com/mycompany/bar/++*++,com/mycompany/stuff/++*++
| `string`
| List of `string`
|

|icon:lock[title=Fixed at build time] [[quarkus.camel.routes-discovery.include-patterns]]`link:#quarkus.camel.routes-discovery.include-patterns[quarkus.camel.routes-discovery.include-patterns]`

Used for inclusive filtering scanning of RouteBuilder classes. The exclusive filtering takes precedence over inclusive filtering. The pattern is using Ant-path style pattern. Multiple patterns can be specified separated by comma. For example to include all classes starting with Foo use: ++**++/Foo++*++ To include all routes form a specific package use: com/mycompany/foo/++*++ To include all routes form a specific package and its sub-packages use double wildcards: com/mycompany/foo/++**++ And to include all routes from two specific packages use: com/mycompany/foo/++*++,com/mycompany/stuff/++*++
| `string`
| List of `string`
|

|icon:lock[title=Fixed at build time] [[quarkus.camel.native.reflection.exclude-patterns]]`link:#quarkus.camel.native.reflection.exclude-patterns[quarkus.camel.native.reflection.exclude-patterns]`
Expand All @@ -249,7 +249,7 @@ A comma separated list of Ant-path style patterns to match class names that shou
This option narrows down the set selected by `include-patterns`. By default, no classes are excluded.

This option cannot be used to unregister classes which have been registered internally by Quarkus extensions.
| `string`
| List of `string`
|

|icon:lock[title=Fixed at build time] [[quarkus.camel.native.reflection.include-patterns]]`link:#quarkus.camel.native.reflection.include-patterns[quarkus.camel.native.reflection.include-patterns]`
Expand All @@ -274,7 +274,7 @@ quarkus.index-dependency.my-dep.artifact-id = my-artifact
```

where `my-dep` is a label of your choice to tell Quarkus that `org.my-group` and with `my-artifact` belong together.
| `string`
| List of `string`
|

|icon:lock[title=Fixed at build time] [[quarkus.camel.native.reflection.serialization-enabled]]`link:#quarkus.camel.native.reflection.serialization-enabled[quarkus.camel.native.reflection.serialization-enabled]`
Expand All @@ -283,10 +283,16 @@ If `true`, basic classes are registered for serialization; otherwise basic class
| `boolean`
| `false`

|icon:lock[title=Fixed at build time] [[quarkus.camel.csimple.on-build-time-analysis-failure]]`link:#quarkus.camel.csimple.on-build-time-analysis-failure[quarkus.camel.csimple.on-build-time-analysis-failure]`

What to do if it is not possible to extract CSimple expressions from a route definition at build time.
| `fail`, `warn`, `ignore`
| `warn`

|icon:lock[title=Fixed at build time] [[quarkus.camel.expression.on-build-time-analysis-failure]]`link:#quarkus.camel.expression.on-build-time-analysis-failure[quarkus.camel.expression.on-build-time-analysis-failure]`

What to do if it is not possible to extract expressions from a route definition at build time.
| `org.apache.camel.quarkus.core.CamelConfig.FailureRemedy`
| `fail`, `warn`, `ignore`
| `warn`

|icon:lock[title=Fixed at build time] [[quarkus.camel.expression.extraction-enabled]]`link:#quarkus.camel.expression.extraction-enabled[quarkus.camel.expression.extraction-enabled]`
Expand Down Expand Up @@ -404,13 +410,13 @@ Whether type converter statistics are enabled. By default, type converter utiliz
|icon:lock[title=Fixed at build time] [[quarkus.camel.main.shutdown.timeout]]`link:#quarkus.camel.main.shutdown.timeout[quarkus.camel.main.shutdown.timeout]`

A timeout (with millisecond precision) to wait for `CamelMain++#++stop()` to finish
| `java.time.Duration`
| link:https://docs.oracle.com/en/java/javase/17/docs/api/java/time/Duration.html[`Duration`] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]]
| `PT3S`

|icon:lock[title=Fixed at build time] [[quarkus.camel.main.arguments.on-unknown]]`link:#quarkus.camel.main.arguments.on-unknown[quarkus.camel.main.arguments.on-unknown]`

The action to take when `CamelMain` encounters an unknown argument. fail - Prints the `CamelMain` usage statement and throws a `RuntimeException` ignore - Suppresses any warnings and the application startup proceeds as normal warn - Prints the `CamelMain` usage statement but allows the application startup to proceed as normal
| `org.apache.camel.quarkus.core.CamelConfig.FailureRemedy`
| `fail`, `warn`, `ignore`
| `warn`
|===

Expand Down
21 changes: 21 additions & 0 deletions docs/modules/ROOT/pages/reference/extensions/cxf-soap.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -309,3 +309,24 @@ quarkus.cxf.codegen.wsdl2java.additional-params = -validate
----
====


[id="extensions-cxf-soap-additional-camel-quarkus-configuration"]
== Additional Camel Quarkus configuration

[width="100%",cols="80,5,15",options="header"]
|===
| Configuration property | Type | Default


|icon:lock[title=Fixed at build time] [[quarkus.camel.cxf.class-generation.exclude-patterns]]`link:#quarkus.camel.cxf.class-generation.exclude-patterns[quarkus.camel.cxf.class-generation.exclude-patterns]`

For CXF service interfaces to work properly, some ancillary classes (such as request and response wrappers) need to be generated at build time. Camel Quarkus lets the `quarkus-cxf` extension to do this for all service interfaces found in the class path except the ones matching the patterns in this property.

`org.apache.cxf.ws.security.sts.provider.SecurityTokenService` is excluded by default due to link:https://issues.apache.org/jira/browse/CXF-8834[https://issues.apache.org/jira/browse/CXF-8834]
| List of `string`
| `org.apache.cxf.ws.security.sts.provider.SecurityTokenService`
|===

[.configuration-legend]
{doc-link-icon-lock}[title=Fixed at build time] Configuration property fixed at build time. All other configuration properties are overridable at runtime.

4 changes: 2 additions & 2 deletions docs/modules/ROOT/pages/reference/extensions/debug.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -79,13 +79,13 @@ quarkus.camel.debug.enabled=true

|icon:lock[title=Fixed at build time] [[quarkus.camel.debug.enabled]]`link:#quarkus.camel.debug.enabled[quarkus.camel.debug.enabled]`


Set whether to enable Camel debugging support.
| `boolean`
| `false`

|icon:lock[title=Fixed at build time] [[quarkus.camel.debug.suspend]]`link:#quarkus.camel.debug.suspend[quarkus.camel.debug.suspend]`


Indicates whether the _suspend mode_ is enabled or not. If `true` the message processing is immediately suspended until the method `attach()` is called.
| `boolean`
| `false`
|===
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,12 @@ The file cluster service could further be tuned by tweaking `quarkus.camel.clust
| Configuration property | Type | Default


|icon:lock[title=Fixed at build time] [[quarkus.camel.cluster.file.enabled]]`link:#quarkus.camel.cluster.file.enabled[quarkus.camel.cluster.file.enabled]`

Whether a File Lock Cluster Service should be automatically configured according to 'quarkus.camel.cluster.file.++*++' configurations.
| `boolean`
| `true`

|icon:lock[title=Fixed at build time] [[quarkus.camel.cluster.file.id]]`link:#quarkus.camel.cluster.file.id[quarkus.camel.cluster.file.id]`

The cluster service ID (defaults to null).
Expand All @@ -86,7 +92,13 @@ The root path (defaults to null).
|icon:lock[title=Fixed at build time] [[quarkus.camel.cluster.file.order]]`link:#quarkus.camel.cluster.file.order[quarkus.camel.cluster.file.order]`

The service lookup order/priority (defaults to 2147482647).
| `java.lang.Integer`
| `int`
|

|icon:lock[title=Fixed at build time] [[quarkus.camel.cluster.file.attributes.-attributes]]`link:#quarkus.camel.cluster.file.attributes.-attributes[quarkus.camel.cluster.file.attributes."attributes"]`

The custom attributes associated to the service (defaults to empty map).
| `Map<String,String>`
|

|icon:lock[title=Fixed at build time] [[quarkus.camel.cluster.file.acquire-lock-delay]]`link:#quarkus.camel.cluster.file.acquire-lock-delay[quarkus.camel.cluster.file.acquire-lock-delay]`
Expand All @@ -100,12 +112,6 @@ The time to wait before starting to try to acquire lock (defaults to 1000ms).
The time to wait between attempts to try to acquire lock (defaults to 10000ms).
| `string`
|

|icon:lock[title=Fixed at build time] [[quarkus.camel.cluster.file.attributes.-attributes]]`link:#quarkus.camel.cluster.file.attributes.-attributes[quarkus.camel.cluster.file.attributes."attributes"]`

The custom attributes associated to the service (defaults to empty map).
| `java.lang.String`
|
|===

[.configuration-legend]
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/ROOT/pages/reference/extensions/graphql.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ https://quarkus.io/guides/native-and-ssl[Quarkus SSL guide].
|icon:lock[title=Fixed at build time] [[quarkus.camel.graphql.query-files]]`link:#quarkus.camel.graphql.query-files[quarkus.camel.graphql.query-files]`

A comma separated list of paths to files containing GraphQL queries for use by GraphQL endpoints. Query files that only need to be accessible from the classpath should be specified on this property. Paths can either be schemeless (E.g graphql/my-query.graphql) or be prefixed with the classpath: URI scheme (E.g classpath:graphql/my-query.graphql). Other URI schemes are not supported.
| `string`
| List of `string`
|
|===

Expand Down
4 changes: 2 additions & 2 deletions docs/modules/ROOT/pages/reference/extensions/grpc.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -189,13 +189,13 @@ Camel Quarkus gRPC code generation can scan dependencies for .proto files that c
|icon:lock[title=Fixed at build time] [[quarkus.camel.grpc.codegen.scan-for-proto-includes.-scan-for-proto-includes]]`link:#quarkus.camel.grpc.codegen.scan-for-proto-includes.-scan-for-proto-includes[quarkus.camel.grpc.codegen.scan-for-proto-includes."scan-for-proto-includes"]`

Package path or file glob pattern includes per dependency containing .proto files to be considered for inclusion.
| `java.util.List`
| List of `Map<String,List<String>>`
|

|icon:lock[title=Fixed at build time] [[quarkus.camel.grpc.codegen.scan-for-proto-excludes.-scan-for-proto-excludes]]`link:#quarkus.camel.grpc.codegen.scan-for-proto-excludes.-scan-for-proto-excludes[quarkus.camel.grpc.codegen.scan-for-proto-excludes."scan-for-proto-excludes"]`

Package path or file glob pattern includes per dependency containing .proto files to be considered for exclusion.
| `java.util.List`
| List of `Map<String,List<String>>`
|
|===

Expand Down
6 changes: 3 additions & 3 deletions docs/modules/ROOT/pages/reference/extensions/jfr.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -100,13 +100,13 @@ Directory to store the recording. By default the current directory will be used.
| [[quarkus.camel.jfr.startup-recorder-duration]]`link:#quarkus.camel.jfr.startup-recorder-duration[quarkus.camel.jfr.startup-recorder-duration]`

How long time to run the startup recorder. Use 0 (default) to keep the recorder running until the JVM is exited. Use -1 to stop the recorder right after Camel has been started (to only focus on potential Camel startup performance bottlenecks) Use a positive value to keep recording for N seconds. When the recorder is stopped then the recording is auto saved to disk (note: save to disk can be disabled by setting startupRecorderDir to false).
| `java.lang.Long`
| `long`
|

| [[quarkus.camel.jfr.startup-recorder-max-depth]]`link:#quarkus.camel.jfr.startup-recorder-max-depth[quarkus.camel.jfr.startup-recorder-max-depth]`

To filter our sub steps at a maximum depth. Use -1 for no maximum. Use 0 for no sub steps. Use 1 for max 1 sub step, and so forth. The default is -1.
| `java.lang.Integer`
| `int`
|

| [[quarkus.camel.jfr.startup-recorder-profile]]`link:#quarkus.camel.jfr.startup-recorder-profile[quarkus.camel.jfr.startup-recorder-profile]`
Expand All @@ -118,7 +118,7 @@ To use a specific Java Flight Recorder profile configuration, such as default or
| [[quarkus.camel.jfr.startup-recorder-recording]]`link:#quarkus.camel.jfr.startup-recorder-recording[quarkus.camel.jfr.startup-recorder-recording]`

To enable Java Flight Recorder to start a recording and automatic dump the recording to disk after startup is complete. This requires that camel-jfr is on the classpath. The default is false.
| `java.lang.Boolean`
| `boolean`
|
|===

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/ROOT/pages/reference/extensions/kamelet.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ This artifact add all the kamelets available in the catalog to your Camel Quarku
List of kamelets identifiers to pre-load at build time.

Each individual identifier is used to set the related `org.apache.camel.model.RouteTemplateDefinition` id.
| `string`
| List of `string`
|
|===

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,12 @@ The kubernetes cluster service could further be tuned by tweaking `quarkus.camel
| Configuration property | Type | Default


|icon:lock[title=Fixed at build time] [[quarkus.camel.cluster.kubernetes.enabled]]`link:#quarkus.camel.cluster.kubernetes.enabled[quarkus.camel.cluster.kubernetes.enabled]`

Whether a Kubernetes Cluster Service should be automatically configured according to 'quarkus.camel.cluster.kubernetes.++*++' configurations.
| `boolean`
| `true`

|icon:lock[title=Fixed at build time] [[quarkus.camel.cluster.kubernetes.rebalancing]]`link:#quarkus.camel.cluster.kubernetes.rebalancing[quarkus.camel.cluster.kubernetes.rebalancing]`

Whether the camel master namespace leaders should be distributed evenly across all the camel contexts in the cluster.
Expand All @@ -89,7 +95,7 @@ The URL of the Kubernetes master (read from Kubernetes client properties by defa
| [[quarkus.camel.cluster.kubernetes.connection-timeout-millis]]`link:#quarkus.camel.cluster.kubernetes.connection-timeout-millis[quarkus.camel.cluster.kubernetes.connection-timeout-millis]`

The connection timeout in milliseconds to use when making requests to the Kubernetes API server.
| `java.lang.Integer`
| `int`
|

| [[quarkus.camel.cluster.kubernetes.namespace]]`link:#quarkus.camel.cluster.kubernetes.namespace[quarkus.camel.cluster.kubernetes.namespace]`
Expand All @@ -107,31 +113,31 @@ The name of the current pod (autodetected from container host name by default).
| [[quarkus.camel.cluster.kubernetes.jitter-factor]]`link:#quarkus.camel.cluster.kubernetes.jitter-factor[quarkus.camel.cluster.kubernetes.jitter-factor]`

The jitter factor to apply in order to prevent all pods to call Kubernetes APIs in the same instant (defaults to 1.2).
| `java.lang.Double`
| `double`
|

| [[quarkus.camel.cluster.kubernetes.lease-duration-millis]]`link:#quarkus.camel.cluster.kubernetes.lease-duration-millis[quarkus.camel.cluster.kubernetes.lease-duration-millis]`

The default duration of the lease for the current leader (defaults to 15000).
| `java.lang.Long`
| `long`
|

| [[quarkus.camel.cluster.kubernetes.renew-deadline-millis]]`link:#quarkus.camel.cluster.kubernetes.renew-deadline-millis[quarkus.camel.cluster.kubernetes.renew-deadline-millis]`

The deadline after which the leader must stop its services because it may have lost the leadership (defaults to 10000).
| `java.lang.Long`
| `long`
|

| [[quarkus.camel.cluster.kubernetes.retry-period-millis]]`link:#quarkus.camel.cluster.kubernetes.retry-period-millis[quarkus.camel.cluster.kubernetes.retry-period-millis]`

The time between two subsequent attempts to check and acquire the leadership. It is randomized using the jitter factor (defaults to 2000).
| `java.lang.Long`
| `long`
|

| [[quarkus.camel.cluster.kubernetes.order]]`link:#quarkus.camel.cluster.kubernetes.order[quarkus.camel.cluster.kubernetes.order]`

Service lookup order/priority (defaults to 2147482647).
| `java.lang.Integer`
| `int`
|

| [[quarkus.camel.cluster.kubernetes.resource-name]]`link:#quarkus.camel.cluster.kubernetes.resource-name[quarkus.camel.cluster.kubernetes.resource-name]`
Expand All @@ -143,13 +149,13 @@ The name of the lease resource used to do optimistic locking (defaults to 'leade
| [[quarkus.camel.cluster.kubernetes.lease-resource-type]]`link:#quarkus.camel.cluster.kubernetes.lease-resource-type[quarkus.camel.cluster.kubernetes.lease-resource-type]`

The lease resource type used in Kubernetes, either 'config-map' or 'lease' (defaults to 'lease').
| `org.apache.camel.component.kubernetes.cluster.LeaseResourceType`
| `config-map`, `lease`
|

| [[quarkus.camel.cluster.kubernetes.labels.-labels]]`link:#quarkus.camel.cluster.kubernetes.labels.-labels[quarkus.camel.cluster.kubernetes.labels."labels"]`

The labels key/value used to identify the pods composing the cluster, defaults to empty map.
| `java.lang.String`
| `Map<String,String>`
|
|===

Expand Down
Loading

0 comments on commit 05bdba7

Please sign in to comment.