From 91612bc4e6f164b5adf60c1865612de44142d60d Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Sat, 28 Oct 2023 01:51:34 +0000 Subject: [PATCH] Sync documentation of main branch --- ...runtime.config.runtime.TracesRuntimeConfig | 2 +- ...y.runtime.config.runtime.OTelRuntimeConfig | 2 +- ....jpa.deployment.SecurityJpaBuildTimeConfig | 1 + ....jpa.deployment.SecurityJpaBuildTimeConfig | 1 + .../main/config/quarkus-all-config.adoc | 30 +++++++++++++++++-- ...-config-runtime-traces-runtime-config.adoc | 8 +++-- ...us-opentelemetry-general-config-items.adoc | 8 +++-- .../main/config/quarkus-opentelemetry.adoc | 8 +++-- ...l-config-runtime-o-tel-runtime-config.adoc | 8 +++-- ...ty-jpa-security-jpa-build-time-config.adoc | 29 ++++++++++++++++++ .../main/config/quarkus-security-jpa.adoc | 29 ++++++++++++++++++ _versions/main/guides/config.adoc | 19 ++++++++++++ _versions/main/guides/reactive-event-bus.adoc | 2 +- _versions/main/guides/security-jpa.adoc | 2 ++ _versions/main/guides/security-overview.adoc | 5 ++++ _versions/main/guides/vertx-reference.adoc | 10 +++++-- 16 files changed, 143 insertions(+), 21 deletions(-) create mode 100644 _generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.security.jpa.deployment.SecurityJpaBuildTimeConfig create mode 100644 _generated-doc/main/config/extensions-configuration-roots-list/quarkus-security-jpa.adoc/io.quarkus.security.jpa.deployment.SecurityJpaBuildTimeConfig create mode 100644 _generated-doc/main/config/quarkus-security-jpa-security-jpa-build-time-config.adoc create mode 100644 _generated-doc/main/config/quarkus-security-jpa.adoc diff --git a/_generated-doc/main/config/all-configuration-groups-generated-doc/io.quarkus.opentelemetry.runtime.config.runtime.TracesRuntimeConfig b/_generated-doc/main/config/all-configuration-groups-generated-doc/io.quarkus.opentelemetry.runtime.config.runtime.TracesRuntimeConfig index d70e24e330..26bca5c84b 100644 --- a/_generated-doc/main/config/all-configuration-groups-generated-doc/io.quarkus.opentelemetry.runtime.config.runtime.TracesRuntimeConfig +++ b/_generated-doc/main/config/all-configuration-groups-generated-doc/io.quarkus.opentelemetry.runtime.config.runtime.TracesRuntimeConfig @@ -1 +1 @@ -[{"configDocKey":{"type":"java.lang.Boolean","key":".suppress-non-application-uris","additionalKeys":[],"configDoc":"Suppress non-application uris from trace collection. This will suppress tracing of `/q` endpoints.\n\nProviding a custom `io.opentelemetry.sdk.trace.samplers.Sampler` CDI Bean will ignore this setting.\n\nThis is a Quarkus specific property. Suppressing non-application uris is enabled by default.\n\nFallbacks to the legacy property `quarkus.opentelemetry.tracer.suppress-non-application-uris` or defaults to `true`.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"suppress-non-application-uris","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".include-static-resources","additionalKeys":[],"configDoc":"Include static resources from trace collection.\n\nThis is a Quarkus specific property. Include static resources is disabled by default. Providing a custom `io.opentelemetry.sdk.trace.samplers.Sampler` CDI Bean will ignore this setting.\n\nFallbacks to the legacy property `quarkus.opentelemetry.tracer.include-static-resources` or defaults to `false`.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"include-static-resources","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Double","key":".sampler.arg","additionalKeys":[],"configDoc":"An argument to the configured tracer if supported, for example a ratio.\n\nFallbacks to the legacy property `quarkus.opentelemetry.tracer.sampler.ratio` or defaults to `1.0`.","withinAMap":false,"defaultValue":"1.0d","javaDocSiteLink":"","docMapKey":"sampler-arg","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}] \ No newline at end of file +[{"configDocKey":{"type":"java.lang.Boolean","key":".suppress-non-application-uris","additionalKeys":[],"configDoc":"Suppress non-application uris from trace collection. This will suppress tracing of `/q` endpoints.\n\nProviding a custom `io.opentelemetry.sdk.trace.samplers.Sampler` CDI Bean will ignore this setting.\n\nThis is a Quarkus specific property. Suppressing non-application uris is enabled by default.\n\nFallbacks to the legacy property `quarkus.opentelemetry.tracer.suppress-non-application-uris` or defaults to `true`.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"suppress-non-application-uris","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".include-static-resources","additionalKeys":[],"configDoc":"Include static resources from trace collection.\n\nThis is a Quarkus specific property. Include static resources is disabled by default. Providing a custom `io.opentelemetry.sdk.trace.samplers.Sampler` CDI Bean will ignore this setting.\n\nFallbacks to the legacy property `quarkus.opentelemetry.tracer.include-static-resources` or defaults to `false`.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"include-static-resources","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".sampler.arg","additionalKeys":[],"configDoc":"Sampler argument. Depends on the `quarkus.otel.traces.sampler` property. Fallbacks to the legacy property `quarkus.opentelemetry.tracer.sampler.ratio`.\n\nWhen setting the stock sampler to `traceidratio` or `parentbased_traceidratio` you need to set a `double` compatible value between `0.0d` and `1.0d`, like `0.01d` or `0.5d`. It is kept as a `String` to allow the flexible customisation of alternative samplers.\n\nDefaults to `1.0d`.","withinAMap":false,"defaultValue":"1.0d","javaDocSiteLink":"","docMapKey":"sampler-arg","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.opentelemetry.runtime.config.runtime.OTelRuntimeConfig b/_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.opentelemetry.runtime.config.runtime.OTelRuntimeConfig index c0717e25c3..2633e35962 100644 --- a/_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.opentelemetry.runtime.config.runtime.OTelRuntimeConfig +++ b/_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.opentelemetry.runtime.config.runtime.OTelRuntimeConfig @@ -1 +1 @@ -[{"configDocKey":{"type":"boolean","key":"quarkus.otel.sdk.disabled","additionalKeys":[],"configDoc":"If true, disable the OpenTelemetry SDK. Runtime configuration.\n\nDefaults to `false`.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"sdk-disabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.otel.traces.suppress-non-application-uris","additionalKeys":[],"configDoc":"Suppress non-application uris from trace collection. This will suppress tracing of `/q` endpoints.\n\nProviding a custom `io.opentelemetry.sdk.trace.samplers.Sampler` CDI Bean will ignore this setting.\n\nThis is a Quarkus specific property. Suppressing non-application uris is enabled by default.\n\nFallbacks to the legacy property `quarkus.opentelemetry.tracer.suppress-non-application-uris` or defaults to `true`.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"suppress-non-application-uris","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.otel.traces.include-static-resources","additionalKeys":[],"configDoc":"Include static resources from trace collection.\n\nThis is a Quarkus specific property. Include static resources is disabled by default. Providing a custom `io.opentelemetry.sdk.trace.samplers.Sampler` CDI Bean will ignore this setting.\n\nFallbacks to the legacy property `quarkus.opentelemetry.tracer.include-static-resources` or defaults to `false`.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"include-static-resources","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"java.lang.Double","key":"quarkus.otel.traces.sampler.arg","additionalKeys":[],"configDoc":"An argument to the configured tracer if supported, for example a ratio.\n\nFallbacks to the legacy property `quarkus.opentelemetry.tracer.sampler.ratio` or defaults to `1.0`.","withinAMap":false,"defaultValue":"1.0d","javaDocSiteLink":"","docMapKey":"sampler-arg","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.otel.attribute.value.length.limit","additionalKeys":[],"configDoc":"The maximum length of attribute values. Applies to spans and logs.\n\nBy default, there is no limit.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"value-length-limit","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.otel.attribute.count.limit","additionalKeys":[],"configDoc":"The maximum number of attributes. Applies to spans, span events, span links, and logs.\n\nDefault is `128`.","withinAMap":false,"defaultValue":"128","javaDocSiteLink":"","docMapKey":"count-limit","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.otel.span.attribute.value.length.limit","additionalKeys":[],"configDoc":"The maximum length of span attribute values. Takes precedence over `otel.attribute.value.length.limit`.\n\nBy default, there is no limit.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"attribute-value-length-limit","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.otel.span.attribute.count.limit","additionalKeys":[],"configDoc":"The maximum number of attributes per span. Takes precedence over `otel.attribute.count.limit`.\n\nDefault is `128`.","withinAMap":false,"defaultValue":"128","javaDocSiteLink":"","docMapKey":"attribute-count-limit","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.otel.span.event.count.limit","additionalKeys":[],"configDoc":"The maximum number of events per span.\n\nDefault is `128`.","withinAMap":false,"defaultValue":"128","javaDocSiteLink":"","docMapKey":"event-count-limit","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.otel.span.link.count.limit","additionalKeys":[],"configDoc":"The maximum number of links per span.\n\nDefault is `128`.","withinAMap":false,"defaultValue":"128","javaDocSiteLink":"","docMapKey":"link-count-limit","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.otel.bsp.schedule.delay","additionalKeys":[],"configDoc":"The interval, in milliseconds, between two consecutive exports.\n\nDefault is `5000`.","withinAMap":false,"defaultValue":"5S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"schedule-delay","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.otel.bsp.max.queue.size","additionalKeys":[],"configDoc":"The maximum queue size.\n\nDefault is `2048`.","withinAMap":false,"defaultValue":"2048","javaDocSiteLink":"","docMapKey":"max-queue-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.otel.bsp.max.export.batch.size","additionalKeys":[],"configDoc":"The maximum batch size.\n\nDefault is `512`.","withinAMap":false,"defaultValue":"512","javaDocSiteLink":"","docMapKey":"max-export-batch-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.otel.bsp.export.timeout","additionalKeys":[],"configDoc":"The maximum allowed time, in milliseconds, to export data.\n\nDefault is `30s`.","withinAMap":false,"defaultValue":"30S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"export-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.otel.resource.attributes","additionalKeys":[],"configDoc":"Specify resource attributes in the following format: `key1=val1,key2=val2,key3=val3`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"resource-attributes","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.otel.service.name","additionalKeys":[],"configDoc":"Specify logical service name. Takes precedence over service.name defined with otel.resource.attributes and from quarkus.application.name.\n\nDefaults to `quarkus.application.name`.","withinAMap":false,"defaultValue":"${quarkus.application.name:unset}","javaDocSiteLink":"","docMapKey":"service-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.otel.experimental.resource.disabled-keys","additionalKeys":[],"configDoc":"Specify resource attribute keys that are filtered.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"experimental-resource-disabled-keys","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.otel","enum":false}}] \ No newline at end of file +[{"configDocKey":{"type":"boolean","key":"quarkus.otel.sdk.disabled","additionalKeys":[],"configDoc":"If true, disable the OpenTelemetry SDK. Runtime configuration.\n\nDefaults to `false`.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"sdk-disabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.otel.traces.suppress-non-application-uris","additionalKeys":[],"configDoc":"Suppress non-application uris from trace collection. This will suppress tracing of `/q` endpoints.\n\nProviding a custom `io.opentelemetry.sdk.trace.samplers.Sampler` CDI Bean will ignore this setting.\n\nThis is a Quarkus specific property. Suppressing non-application uris is enabled by default.\n\nFallbacks to the legacy property `quarkus.opentelemetry.tracer.suppress-non-application-uris` or defaults to `true`.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"suppress-non-application-uris","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.otel.traces.include-static-resources","additionalKeys":[],"configDoc":"Include static resources from trace collection.\n\nThis is a Quarkus specific property. Include static resources is disabled by default. Providing a custom `io.opentelemetry.sdk.trace.samplers.Sampler` CDI Bean will ignore this setting.\n\nFallbacks to the legacy property `quarkus.opentelemetry.tracer.include-static-resources` or defaults to `false`.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"include-static-resources","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.otel.traces.sampler.arg","additionalKeys":[],"configDoc":"Sampler argument. Depends on the `quarkus.otel.traces.sampler` property. Fallbacks to the legacy property `quarkus.opentelemetry.tracer.sampler.ratio`.\n\nWhen setting the stock sampler to `traceidratio` or `parentbased_traceidratio` you need to set a `double` compatible value between `0.0d` and `1.0d`, like `0.01d` or `0.5d`. It is kept as a `String` to allow the flexible customisation of alternative samplers.\n\nDefaults to `1.0d`.","withinAMap":false,"defaultValue":"1.0d","javaDocSiteLink":"","docMapKey":"sampler-arg","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.otel.attribute.value.length.limit","additionalKeys":[],"configDoc":"The maximum length of attribute values. Applies to spans and logs.\n\nBy default, there is no limit.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"value-length-limit","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.otel.attribute.count.limit","additionalKeys":[],"configDoc":"The maximum number of attributes. Applies to spans, span events, span links, and logs.\n\nDefault is `128`.","withinAMap":false,"defaultValue":"128","javaDocSiteLink":"","docMapKey":"count-limit","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.otel.span.attribute.value.length.limit","additionalKeys":[],"configDoc":"The maximum length of span attribute values. Takes precedence over `otel.attribute.value.length.limit`.\n\nBy default, there is no limit.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"attribute-value-length-limit","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.otel.span.attribute.count.limit","additionalKeys":[],"configDoc":"The maximum number of attributes per span. Takes precedence over `otel.attribute.count.limit`.\n\nDefault is `128`.","withinAMap":false,"defaultValue":"128","javaDocSiteLink":"","docMapKey":"attribute-count-limit","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.otel.span.event.count.limit","additionalKeys":[],"configDoc":"The maximum number of events per span.\n\nDefault is `128`.","withinAMap":false,"defaultValue":"128","javaDocSiteLink":"","docMapKey":"event-count-limit","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.otel.span.link.count.limit","additionalKeys":[],"configDoc":"The maximum number of links per span.\n\nDefault is `128`.","withinAMap":false,"defaultValue":"128","javaDocSiteLink":"","docMapKey":"link-count-limit","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.otel.bsp.schedule.delay","additionalKeys":[],"configDoc":"The interval, in milliseconds, between two consecutive exports.\n\nDefault is `5000`.","withinAMap":false,"defaultValue":"5S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"schedule-delay","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.otel.bsp.max.queue.size","additionalKeys":[],"configDoc":"The maximum queue size.\n\nDefault is `2048`.","withinAMap":false,"defaultValue":"2048","javaDocSiteLink":"","docMapKey":"max-queue-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.otel.bsp.max.export.batch.size","additionalKeys":[],"configDoc":"The maximum batch size.\n\nDefault is `512`.","withinAMap":false,"defaultValue":"512","javaDocSiteLink":"","docMapKey":"max-export-batch-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.otel.bsp.export.timeout","additionalKeys":[],"configDoc":"The maximum allowed time, in milliseconds, to export data.\n\nDefault is `30s`.","withinAMap":false,"defaultValue":"30S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"export-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.otel.resource.attributes","additionalKeys":[],"configDoc":"Specify resource attributes in the following format: `key1=val1,key2=val2,key3=val3`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"resource-attributes","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.otel.service.name","additionalKeys":[],"configDoc":"Specify logical service name. Takes precedence over service.name defined with otel.resource.attributes and from quarkus.application.name.\n\nDefaults to `quarkus.application.name`.","withinAMap":false,"defaultValue":"${quarkus.application.name:unset}","javaDocSiteLink":"","docMapKey":"service-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.otel","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.otel.experimental.resource.disabled-keys","additionalKeys":[],"configDoc":"Specify resource attribute keys that are filtered.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"experimental-resource-disabled-keys","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.otel","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.security.jpa.deployment.SecurityJpaBuildTimeConfig b/_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.security.jpa.deployment.SecurityJpaBuildTimeConfig new file mode 100644 index 0000000000..c8e559ab0a --- /dev/null +++ b/_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.security.jpa.deployment.SecurityJpaBuildTimeConfig @@ -0,0 +1 @@ +[{"configDocKey":{"type":"string","key":"quarkus.security-jpa.persistence-unit-name","additionalKeys":[],"configDoc":"Selects the Hibernate ORM persistence unit. Default persistence unit is used when no value is specified.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"persistence-unit-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.security-jpa","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/main/config/extensions-configuration-roots-list/quarkus-security-jpa.adoc/io.quarkus.security.jpa.deployment.SecurityJpaBuildTimeConfig b/_generated-doc/main/config/extensions-configuration-roots-list/quarkus-security-jpa.adoc/io.quarkus.security.jpa.deployment.SecurityJpaBuildTimeConfig new file mode 100644 index 0000000000..b661741f0c --- /dev/null +++ b/_generated-doc/main/config/extensions-configuration-roots-list/quarkus-security-jpa.adoc/io.quarkus.security.jpa.deployment.SecurityJpaBuildTimeConfig @@ -0,0 +1 @@ +io.quarkus.security.jpa.deployment.SecurityJpaBuildTimeConfig \ No newline at end of file diff --git a/_generated-doc/main/config/quarkus-all-config.adoc b/_generated-doc/main/config/quarkus-all-config.adoc index bc62f91fe4..7f7c4617ce 100644 --- a/_generated-doc/main/config/quarkus-all-config.adoc +++ b/_generated-doc/main/config/quarkus-all-config.adoc @@ -51209,9 +51209,11 @@ a| [[quarkus-opentelemetry_quarkus.otel.traces.sampler.arg]]`link:#quarkus-opent [.description] -- -An argument to the configured tracer if supported, for example a ratio. +Sampler argument. Depends on the `quarkus.otel.traces.sampler` property. Fallbacks to the legacy property `quarkus.opentelemetry.tracer.sampler.ratio`. -Fallbacks to the legacy property `quarkus.opentelemetry.tracer.sampler.ratio` or defaults to `1.0`. +When setting the stock sampler to `traceidratio` or `parentbased_traceidratio` you need to set a `double` compatible value between `0.0d` and `1.0d`, like `0.01d` or `0.5d`. It is kept as a `String` to allow the flexible customisation of alternative samplers. + +Defaults to `1.0d`. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_TRACES_SAMPLER_ARG+++[] @@ -51219,7 +51221,7 @@ endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OTEL_TRACES_SAMPLER_ARG+++` endif::add-copy-button-to-env-var[] ---|double +--|string |`1.0d` @@ -63591,6 +63593,28 @@ endif::add-copy-button-to-env-var[] | +h|[[quarkus-security-jpa_quarkus-security-jpa-security-jpa]]link:#quarkus-security-jpa_quarkus-security-jpa-security-jpa[Security JPA] + +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-security-jpa_quarkus.security-jpa.persistence-unit-name]]`link:#quarkus-security-jpa_quarkus.security-jpa.persistence-unit-name[quarkus.security-jpa.persistence-unit-name]` + + +[.description] +-- +Selects the Hibernate ORM persistence unit. Default persistence unit is used when no value is specified. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECURITY_JPA_PERSISTENCE_UNIT_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECURITY_JPA_PERSISTENCE_UNIT_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +|`` + + h|[[quarkus-security-webauthn_quarkus-security-webauthn-security-webauthn]]link:#quarkus-security-webauthn_quarkus-security-webauthn-security-webauthn[Security WebAuthn] h|Type diff --git a/_generated-doc/main/config/quarkus-opentelemetry-config-group-config-runtime-traces-runtime-config.adoc b/_generated-doc/main/config/quarkus-opentelemetry-config-group-config-runtime-traces-runtime-config.adoc index 5e37b105c6..a2f4b4d72e 100644 --- a/_generated-doc/main/config/quarkus-opentelemetry-config-group-config-runtime-traces-runtime-config.adoc +++ b/_generated-doc/main/config/quarkus-opentelemetry-config-group-config-runtime-traces-runtime-config.adoc @@ -59,9 +59,11 @@ a| [[quarkus-opentelemetry-config-group-config-runtime-traces-runtime-config_qua [.description] -- -An argument to the configured tracer if supported, for example a ratio. +Sampler argument. Depends on the `quarkus.otel.traces.sampler` property. Fallbacks to the legacy property `quarkus.opentelemetry.tracer.sampler.ratio`. -Fallbacks to the legacy property `quarkus.opentelemetry.tracer.sampler.ratio` or defaults to `1.0`. +When setting the stock sampler to `traceidratio` or `parentbased_traceidratio` you need to set a `double` compatible value between `0.0d` and `1.0d`, like `0.01d` or `0.5d`. It is kept as a `String` to allow the flexible customisation of alternative samplers. + +Defaults to `1.0d`. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_TRACES_SAMPLER_ARG+++[] @@ -69,7 +71,7 @@ endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OTEL_TRACES_SAMPLER_ARG+++` endif::add-copy-button-to-env-var[] ---|double +--|string |`1.0d` |=== \ No newline at end of file diff --git a/_generated-doc/main/config/quarkus-opentelemetry-general-config-items.adoc b/_generated-doc/main/config/quarkus-opentelemetry-general-config-items.adoc index 61858b5a48..0176009ad3 100644 --- a/_generated-doc/main/config/quarkus-opentelemetry-general-config-items.adoc +++ b/_generated-doc/main/config/quarkus-opentelemetry-general-config-items.adoc @@ -120,9 +120,11 @@ a| [[quarkus-opentelemetry-general-config-items_quarkus.otel.traces.sampler.arg] [.description] -- -An argument to the configured tracer if supported, for example a ratio. +Sampler argument. Depends on the `quarkus.otel.traces.sampler` property. Fallbacks to the legacy property `quarkus.opentelemetry.tracer.sampler.ratio`. -Fallbacks to the legacy property `quarkus.opentelemetry.tracer.sampler.ratio` or defaults to `1.0`. +When setting the stock sampler to `traceidratio` or `parentbased_traceidratio` you need to set a `double` compatible value between `0.0d` and `1.0d`, like `0.01d` or `0.5d`. It is kept as a `String` to allow the flexible customisation of alternative samplers. + +Defaults to `1.0d`. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_TRACES_SAMPLER_ARG+++[] @@ -130,7 +132,7 @@ endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OTEL_TRACES_SAMPLER_ARG+++` endif::add-copy-button-to-env-var[] ---|double +--|string |`1.0d` diff --git a/_generated-doc/main/config/quarkus-opentelemetry.adoc b/_generated-doc/main/config/quarkus-opentelemetry.adoc index 2f3f6943aa..190ddbccb9 100644 --- a/_generated-doc/main/config/quarkus-opentelemetry.adoc +++ b/_generated-doc/main/config/quarkus-opentelemetry.adoc @@ -194,9 +194,11 @@ a| [[quarkus-opentelemetry_quarkus.otel.traces.sampler.arg]]`link:#quarkus-opent [.description] -- -An argument to the configured tracer if supported, for example a ratio. +Sampler argument. Depends on the `quarkus.otel.traces.sampler` property. Fallbacks to the legacy property `quarkus.opentelemetry.tracer.sampler.ratio`. -Fallbacks to the legacy property `quarkus.opentelemetry.tracer.sampler.ratio` or defaults to `1.0`. +When setting the stock sampler to `traceidratio` or `parentbased_traceidratio` you need to set a `double` compatible value between `0.0d` and `1.0d`, like `0.01d` or `0.5d`. It is kept as a `String` to allow the flexible customisation of alternative samplers. + +Defaults to `1.0d`. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_TRACES_SAMPLER_ARG+++[] @@ -204,7 +206,7 @@ endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OTEL_TRACES_SAMPLER_ARG+++` endif::add-copy-button-to-env-var[] ---|double +--|string |`1.0d` diff --git a/_generated-doc/main/config/quarkus-otel-config-runtime-o-tel-runtime-config.adoc b/_generated-doc/main/config/quarkus-otel-config-runtime-o-tel-runtime-config.adoc index 0a631808e6..e8f865eb26 100644 --- a/_generated-doc/main/config/quarkus-otel-config-runtime-o-tel-runtime-config.adoc +++ b/_generated-doc/main/config/quarkus-otel-config-runtime-o-tel-runtime-config.adoc @@ -78,9 +78,11 @@ a| [[quarkus-otel-config-runtime-o-tel-runtime-config_quarkus.otel.traces.sample [.description] -- -An argument to the configured tracer if supported, for example a ratio. +Sampler argument. Depends on the `quarkus.otel.traces.sampler` property. Fallbacks to the legacy property `quarkus.opentelemetry.tracer.sampler.ratio`. -Fallbacks to the legacy property `quarkus.opentelemetry.tracer.sampler.ratio` or defaults to `1.0`. +When setting the stock sampler to `traceidratio` or `parentbased_traceidratio` you need to set a `double` compatible value between `0.0d` and `1.0d`, like `0.01d` or `0.5d`. It is kept as a `String` to allow the flexible customisation of alternative samplers. + +Defaults to `1.0d`. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_TRACES_SAMPLER_ARG+++[] @@ -88,7 +90,7 @@ endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OTEL_TRACES_SAMPLER_ARG+++` endif::add-copy-button-to-env-var[] ---|double +--|string |`1.0d` diff --git a/_generated-doc/main/config/quarkus-security-jpa-security-jpa-build-time-config.adoc b/_generated-doc/main/config/quarkus-security-jpa-security-jpa-build-time-config.adoc new file mode 100644 index 0000000000..b4c25c9ed1 --- /dev/null +++ b/_generated-doc/main/config/quarkus-security-jpa-security-jpa-build-time-config.adoc @@ -0,0 +1,29 @@ + +:summaryTableId: quarkus-security-jpa-security-jpa-build-time-config +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference, cols="80,.^10,.^10"] +|=== + +h|[[quarkus-security-jpa-security-jpa-build-time-config_configuration]]link:#quarkus-security-jpa-security-jpa-build-time-config_configuration[Configuration property] + +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-security-jpa-security-jpa-build-time-config_quarkus.security-jpa.persistence-unit-name]]`link:#quarkus-security-jpa-security-jpa-build-time-config_quarkus.security-jpa.persistence-unit-name[quarkus.security-jpa.persistence-unit-name]` + + +[.description] +-- +Selects the Hibernate ORM persistence unit. Default persistence unit is used when no value is specified. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECURITY_JPA_PERSISTENCE_UNIT_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECURITY_JPA_PERSISTENCE_UNIT_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +|`` + +|=== \ No newline at end of file diff --git a/_generated-doc/main/config/quarkus-security-jpa.adoc b/_generated-doc/main/config/quarkus-security-jpa.adoc new file mode 100644 index 0000000000..d375d10e2d --- /dev/null +++ b/_generated-doc/main/config/quarkus-security-jpa.adoc @@ -0,0 +1,29 @@ + +:summaryTableId: quarkus-security-jpa +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference.searchable, cols="80,.^10,.^10"] +|=== + +h|[[quarkus-security-jpa_configuration]]link:#quarkus-security-jpa_configuration[Configuration property] + +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-security-jpa_quarkus.security-jpa.persistence-unit-name]]`link:#quarkus-security-jpa_quarkus.security-jpa.persistence-unit-name[quarkus.security-jpa.persistence-unit-name]` + + +[.description] +-- +Selects the Hibernate ORM persistence unit. Default persistence unit is used when no value is specified. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECURITY_JPA_PERSISTENCE_UNIT_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECURITY_JPA_PERSISTENCE_UNIT_NAME+++` +endif::add-copy-button-to-env-var[] +--|string +|`` + +|=== \ No newline at end of file diff --git a/_versions/main/guides/config.adoc b/_versions/main/guides/config.adoc index 9bd5cfa17b..b934b9a1b9 100644 --- a/_versions/main/guides/config.adoc +++ b/_versions/main/guides/config.adoc @@ -133,6 +133,25 @@ public String hello() { TIP: Use `@io.smallrye.config.ConfigMapping` annotation to group multiple configurations in a single interface. Please, check the https://smallrye.io/smallrye-config/Main/config/mappings/[Config Mappings] documentation. +[[secrets-in-environment-properties]] +== Store secrets in an environment properties file + +A secret (such as a password, a personal access token or an API key) must not end up in version control +for security reasons. One way is to store them in a local environment properties (`.env`) file: + +. Store the secret in the `.env` file in the project root directory. ++ +.The .env file +[source,properties] +---- +foo.api-key=ThisIsSecret +---- + +. Add the `.env` file to `.gitignore`. + +`mvn quarkus:dev` automatically picks up the properties in the `.env` file, +similar to those in the `application.properties` file. + == Update the test We also need to update the functional test to reflect the changes made to the endpoint. diff --git a/_versions/main/guides/reactive-event-bus.adoc b/_versions/main/guides/reactive-event-bus.adoc index 8d6197323b..b1c03416d0 100644 --- a/_versions/main/guides/reactive-event-bus.adoc +++ b/_versions/main/guides/reactive-event-bus.adoc @@ -26,7 +26,7 @@ However, it is limited to single-event behavior (no stream) and to local message == Installing This mechanism uses the Vert.x EventBus, so you need to enable the `vertx` extension to use this feature. -If you are creating a new project, set the `extensions` parameter are follows: +If you are creating a new project, set the `extensions` parameter as follows: :create-app-artifact-id: vertx-quickstart :create-app-extensions: vertx,resteasy-reactive diff --git a/_versions/main/guides/security-jpa.adoc b/_versions/main/guides/security-jpa.adoc index 6340b379c0..e93fd32110 100644 --- a/_versions/main/guides/security-jpa.adoc +++ b/_versions/main/guides/security-jpa.adoc @@ -185,6 +185,8 @@ For applications running in a production environment, do not store passwords as However, it is possible to store passwords as plain text with the `@Password(PasswordType.CLEAR)` annotation when operating in a test environment. ==== +include::{generated-dir}/config/quarkus-security-jpa.adoc[opts=optional, leveloffset=+2] + == References * xref:security-getting-started-tutorial.adoc[Getting Started with Security using Basic authentication and Jakarta Persistence] diff --git a/_versions/main/guides/security-overview.adoc b/_versions/main/guides/security-overview.adoc index 3433549fee..101845c562 100644 --- a/_versions/main/guides/security-overview.adoc +++ b/_versions/main/guides/security-overview.adoc @@ -78,6 +78,11 @@ Secrets engines are components that store, generate, or encrypt data. Quarkus provides comprehensive HashiCorp Vault support. For more information, see the link:{vault-guide}[Quarkus and HashiCorp Vault] documentation. +== Secrets in environment properties + +Quarkus provides support to store secrets in environment properties. +See xref:config.adoc#secrets-in-environment-properties[store secrets in an environment properties file]. + [[secure-serialization]] === Secure serialization diff --git a/_versions/main/guides/vertx-reference.adoc b/_versions/main/guides/vertx-reference.adoc index ab03d689f7..3247a6ef8c 100644 --- a/_versions/main/guides/vertx-reference.adoc +++ b/_versions/main/guides/vertx-reference.adoc @@ -854,7 +854,7 @@ So use SockJS, you need to configure the bridge, especially the addresses that w [source, java] ---- -package org.acme.vertx; +package org.acme; import io.vertx.core.Vertx; import io.vertx.ext.bridge.PermittedOptions; @@ -875,9 +875,13 @@ public class SockJsExample { public void init(@Observes Router router) { SockJSHandler sockJSHandler = SockJSHandler.create(vertx); - sockJSHandler.bridge(new SockJSBridgeOptions() + Router bridge = sockJSHandler.bridge(new SockJSBridgeOptions() .addOutboundPermitted(new PermittedOptions().setAddress("ticks"))); - router.route("/eventbus/*").handler(sockJSHandler); + router.route("/eventbus/*").subRouter(bridge); + + AtomicInteger counter = new AtomicInteger(); + vertx.setPeriodic(1000, + ignored -> vertx.eventBus().publish("ticks", counter.getAndIncrement())); } }