Skip to content

Commit

Permalink
Fix apache#1350 List Quarkus configuration options on extension pages
Browse files Browse the repository at this point in the history
  • Loading branch information
ppalaga committed Jun 19, 2020
1 parent 14c763b commit 49f6390
Show file tree
Hide file tree
Showing 174 changed files with 2,968 additions and 1,809 deletions.
126 changes: 126 additions & 0 deletions docs/modules/ROOT/pages/extensions/core.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,129 @@ Please refer to the above links for usage and configuration details.
----

Check the xref:user-guide/index.adoc[User guide] for more information about writing Camel Quarkus applications.

== 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.main.enabled]]`link:#quarkus.camel.main.enabled[quarkus.camel.main.enabled]`

Enable `camel-main`. If `true`, routes are automatically loaded and started and the entire lifecycle of the Camel Context is under the control of the `camel-main` component. Otherwise, the application developer is responsible for performing all the mentioned tasks.
| `boolean`
| `true`

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

Enable automatic discovery of routes during static initialization.
| `boolean`
| `true`

|icon:lock[title=Fixed at build time] [[quarkus.camel.main.routes-discovery.exclude-patterns]]`link:#quarkus.camel.main.routes-discovery.exclude-patterns[quarkus.camel.main.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`
|

|icon:lock[title=Fixed at build time] [[quarkus.camel.main.routes-discovery.include-patterns]]`link:#quarkus.camel.main.routes-discovery.include-patterns[quarkus.camel.main.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`
|

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

A comma-separated list of Ant-path style patterns to match Camel service definition files in the classpath. The services defined in the matching files will not be discoverable via the `org.apache.camel.spi.FactoryFinder` mechanism.
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`
|

|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]`

A comma-separated list of Ant-path style patterns to match Camel service definition files in the classpath. The services defined in the matching files will be discoverable via the `org.apache.camel.spi.FactoryFinder` mechanism unless the given file is excluded via `exclude-patterns`.
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`
|

|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]`

A comma-separated list of Ant-path style patterns to match Camel service definition files in the classpath. The services defined in the matching files will not be added to Camel registry during application's static initialization.
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`
|

|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]`

A comma-separated list of Ant-path style patterns to match Camel service definition files in the classpath. The services defined in the matching files will be added to Camel registry during application's static initialization unless the given file is excluded via `exclude-patterns`.
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`
|

|icon:lock[title=Fixed at build time] [[quarkus.camel.runtime-catalog.components]]`link:#quarkus.camel.runtime-catalog.components[quarkus.camel.runtime-catalog.components]`

If `true` the Runtime Camel Catalog embedded in the application will contain JSON schemas of Camel components available in the application; otherwise component JSON schemas will not be available in the Runtime Camel Catalog and any attempt to access those will result in a RuntimeException.
Setting this to `false` helps to reduce the size of the native image. In JVM mode, there is no real benefit of setting this flag to `false` except for making the behavior consistent with native mode.
| `boolean`
| `true`

|icon:lock[title=Fixed at build time] [[quarkus.camel.runtime-catalog.languages]]`link:#quarkus.camel.runtime-catalog.languages[quarkus.camel.runtime-catalog.languages]`

If `true` the Runtime Camel Catalog embedded in the application will contain JSON schemas of Camel languages available in the application; otherwise language JSON schemas will not be available in the Runtime Camel Catalog and any attempt to access those will result in a RuntimeException.
Setting this to `false` helps to reduce the size of the native image. In JVM mode, there is no real benefit of setting this flag to `false` except for making the behavior consistent with native mode.
| `boolean`
| `true`

|icon:lock[title=Fixed at build time] [[quarkus.camel.runtime-catalog.dataformats]]`link:#quarkus.camel.runtime-catalog.dataformats[quarkus.camel.runtime-catalog.dataformats]`

If `true` the Runtime Camel Catalog embedded in the application will contain JSON schemas of Camel data formats available in the application; otherwise data format JSON schemas will not be available in the Runtime Camel Catalog and any attempt to access those will result in a RuntimeException.
Setting this to `false` helps to reduce the size of the native image. In JVM mode, there is no real benefit of setting this flag to `false` except for making the behavior consistent with native mode.
| `boolean`
| `true`

|icon:lock[title=Fixed at build time] [[quarkus.camel.runtime-catalog.models]]`link:#quarkus.camel.runtime-catalog.models[quarkus.camel.runtime-catalog.models]`

If `true` the Runtime Camel Catalog embedded in the application will contain JSON schemas of Camel EIP models available in the application; otherwise EIP model JSON schemas will not be available in the Runtime Camel Catalog and any attempt to access those will result in a RuntimeException.
Setting this to `false` helps to reduce the size of the native image. In JVM mode, there is no real benefit of setting this flag to `false` except for making the behavior consistent with native mode.
| `boolean`
| `true`

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

A comma separated list of Ant-path style patterns to match resources that should be excluded from the native executable. By default, resources not selected by quarkus itself are ignored. Then, inclusion of additional resources could be triggered with `includePatterns`. When the inclusion patterns is too large, eviction of previously selected resources could be triggered with `excludePatterns`.
| `string`
|

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

A comma separated list of Ant-path style patterns to match resources that should be included in the native executable. By default, resources not selected by quarkus itself are ignored. Then, inclusion of additional resources could be triggered with `includePatterns`. When the inclusion patterns is too large, eviction of previously selected resources could be triggered with `excludePatterns`.
| `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]`

A comma separated list of Ant-path style patterns to match class names that should be excluded from registering for reflection. Use the class name format as returned by the `java.lang.Class.getName()` method: package segments delimited by period `.` and inner classes by dollar sign `$`.
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`
|

|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]`

A comma separated list of Ant-path style patterns to match class names that should be registered for reflection. Use the class name format as returned by the `java.lang.Class.getName()` method: package segments delimited by period `.` and inner classes by dollar sign `$`.
By default, no classes are included. The set selected by this option can be narrowed down by `exclude-patterns`.
Note that Quarkus extensions typically register the required classes for reflection by themselves. This option is useful in situations when the built in functionality is not sufficient.
Note that this option enables the full reflective access for constructors, fields and methods. If you need a finer grained control, consider using `io.quarkus.runtime.annotations.RegisterForReflection` annotation in your Java code.
For this option to work properly, the artifacts containing the selected classes must either contain a Jandex index (`META-INF/jandex.idx`) or they must be registered for indexing using the `quarkus.index-dependency.*` family of options in `application.properties` - e.g. quarkus.index-dependency.my-dep.group-id = org.my-group 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`
|
|===

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

22 changes: 22 additions & 0 deletions docs/modules/ROOT/pages/extensions/dozer.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -53,3 +53,25 @@ It is disabled by default but can be enabled with the following configuration pr
quarkus.camel.dozer.type-converter-enabled = true
----


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


|icon:lock[title=Fixed at build time] [[quarkus.camel.dozer.mapping-files]]`link:#quarkus.camel.dozer.mapping-files[quarkus.camel.dozer.mapping-files]`

A comma separated list of Dozer XML mapping configuration file URIs.
| `string`
|

|icon:lock[title=Fixed at build time] [[quarkus.camel.dozer.type-converter-enabled]]`link:#quarkus.camel.dozer.type-converter-enabled[quarkus.camel.dozer.type-converter-enabled]`

Sets whether to configure the DozerTypeConverter for the CamelContext
| `boolean`
| `false`
|===

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

41 changes: 23 additions & 18 deletions docs/modules/ROOT/pages/extensions/fhir.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -39,32 +39,37 @@ https://quarkus.io/guides/native-and-ssl[Quarkus SSL guide].

The https://hapifhir.io/download.html[hapi-fhir] library, on which camel-fhir depends on, heavily uses reflection which affects performance in Quarkus (memory footprint, build time, CPU resources etc...). The following options are provided to improve on this:

[cols="80,.^10,.^10"]

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


|`quarkus.camel.fhir.enable-dstu2`
|icon:lock[title=Fixed at build time] [[quarkus.camel.fhir.enable-dstu2]]`link:#quarkus.camel.fhir.enable-dstu2[quarkus.camel.fhir.enable-dstu2]`

enables dstu2 resources
|boolean
|`true`
Enable FHIR DSTU2 Specs.
| `boolean`
| `true`

|`quarkus.camel.fhir.enable-dstu3`
|icon:lock[title=Fixed at build time] [[quarkus.camel.fhir.enable-dstu3]]`link:#quarkus.camel.fhir.enable-dstu3[quarkus.camel.fhir.enable-dstu3]`

enables dstu3 resources
|boolean
|`true`
Enable FHIR DSTU3 Specs.
| `boolean`
| `true`

|`quarkus.camel.fhir.enable-r4`
|icon:lock[title=Fixed at build time] [[quarkus.camel.fhir.enable-r4]]`link:#quarkus.camel.fhir.enable-r4[quarkus.camel.fhir.enable-r4]`

enables r4 resources
|boolean
|`true`
Enable FHIR R4 Specs.
| `boolean`
| `true`

|`quarkus.camel.fhir.enable-r5`
|icon:lock[title=Fixed at build time] [[quarkus.camel.fhir.enable-r5]]`link:#quarkus.camel.fhir.enable-r5[quarkus.camel.fhir.enable-r5]`

enables r5 resources
|boolean
|`true`
Enable FHIR R5 Specs.
| `boolean`
| `true`
|===

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

19 changes: 13 additions & 6 deletions docs/modules/ROOT/pages/extensions/graphql.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,18 @@ https://quarkus.io/guides/native-and-ssl[Quarkus SSL guide].

== Additional Camel Quarkus configuration

When configuring `graphql` endpoints to reference query files from the classpath, set the following configuration
property to ensure that they are available in native mode:
[width="100%",cols="80,5,15",options="header"]
|===
| Configuration property | Type | Default

[source,properties]
----
quarkus.camel.graphql.query-files = queries.graphql, classpath:graphql/my-query.graphql
----

|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`
|
|===

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

16 changes: 16 additions & 0 deletions docs/modules/ROOT/pages/extensions/microprofile-health.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -69,3 +69,19 @@ The Camel MicroProfile Health extension exposes the following configuration prop
|`true`
|===


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


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

Set whether to enable Camel health checks
| `boolean`
| `true`
|===

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

40 changes: 40 additions & 0 deletions docs/modules/ROOT/pages/extensions/microprofile-metrics.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -195,3 +195,43 @@ Set whether to enable the `MicroProfileMetricsCamelContextEventNotifier` for cap
|`true`
|===


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


|icon:lock[title=Fixed at build time] [[quarkus.camel.metrics.enable-route-policy]]`link:#quarkus.camel.metrics.enable-route-policy[quarkus.camel.metrics.enable-route-policy]`

Set whether to enable the MicroProfileMetricsRoutePolicyFactory for capturing metrics on route processing times.
| `boolean`
| `true`

|icon:lock[title=Fixed at build time] [[quarkus.camel.metrics.enable-message-history]]`link:#quarkus.camel.metrics.enable-message-history[quarkus.camel.metrics.enable-message-history]`

Set whether to enable the MicroProfileMetricsMessageHistoryFactory for capturing metrics on individual route node processing times. Depending on the number of configured route nodes, there is the potential to create a large volume of metrics. Therefore, this option is disabled by default.
| `boolean`
| `false`

|icon:lock[title=Fixed at build time] [[quarkus.camel.metrics.enable-exchange-event-notifier]]`link:#quarkus.camel.metrics.enable-exchange-event-notifier[quarkus.camel.metrics.enable-exchange-event-notifier]`

Set whether to enable the MicroProfileMetricsExchangeEventNotifier for capturing metrics on exchange processing times.
| `boolean`
| `true`

|icon:lock[title=Fixed at build time] [[quarkus.camel.metrics.enable-route-event-notifier]]`link:#quarkus.camel.metrics.enable-route-event-notifier[quarkus.camel.metrics.enable-route-event-notifier]`

Set whether to enable the MicroProfileMetricsRouteEventNotifier for capturing metrics on the total number of routes and total number of routes running.
| `boolean`
| `true`

|icon:lock[title=Fixed at build time] [[quarkus.camel.metrics.enable-camel-context-event-notifier]]`link:#quarkus.camel.metrics.enable-camel-context-event-notifier[quarkus.camel.metrics.enable-camel-context-event-notifier]`

Set whether to enable the MicroProfileMetricsCamelContextEventNotifier for capturing metrics about the CamelContext, such as status and uptime.
| `boolean`
| `true`
|===

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

22 changes: 22 additions & 0 deletions docs/modules/ROOT/pages/extensions/opentracing.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -73,3 +73,25 @@ The Camel OpenTracing extension exposes the following configuration properties.
|
|===


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


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

Sets whether header keys need to be encoded
| `boolean`
| `false`

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

Sets whether to disable tracing for endpoint URIs that match the given patterns
| `string`
|
|===

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

0 comments on commit 49f6390

Please sign in to comment.