Skip to content

Commit

Permalink
Sync documentation of main branch
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Oct 28, 2023
1 parent 51bca82 commit 91612bc
Show file tree
Hide file tree
Showing 16 changed files with 143 additions and 21 deletions.
Original file line number Diff line number Diff line change
@@ -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}}]
[{"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}}]

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -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":"<default>","javaDocSiteLink":"","docMapKey":"persistence-unit-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.security-jpa","enum":false}}]
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
io.quarkus.security.jpa.deployment.SecurityJpaBuildTimeConfig
30 changes: 27 additions & 3 deletions _generated-doc/main/config/quarkus-all-config.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -51209,17 +51209,19 @@ 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+++[]
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`


Expand Down Expand Up @@ -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
|`<default>`


h|[[quarkus-security-webauthn_quarkus-security-webauthn-security-webauthn]]link:#quarkus-security-webauthn_quarkus-security-webauthn-security-webauthn[Security WebAuthn]

h|Type
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,17 +59,19 @@ 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+++[]
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`

|===
Original file line number Diff line number Diff line change
Expand Up @@ -120,17 +120,19 @@ 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+++[]
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`


Expand Down
8 changes: 5 additions & 3 deletions _generated-doc/main/config/quarkus-opentelemetry.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -194,17 +194,19 @@ 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+++[]
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`


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,17 +78,19 @@ 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+++[]
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`


Expand Down
Original file line number Diff line number Diff line change
@@ -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
|`<default>`

|===
29 changes: 29 additions & 0 deletions _generated-doc/main/config/quarkus-security-jpa.adoc
Original file line number Diff line number Diff line change
@@ -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
|`<default>`

|===
19 changes: 19 additions & 0 deletions _versions/main/guides/config.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion _versions/main/guides/reactive-event-bus.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions _versions/main/guides/security-jpa.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
5 changes: 5 additions & 0 deletions _versions/main/guides/security-overview.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
10 changes: 7 additions & 3 deletions _versions/main/guides/vertx-reference.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand All @@ -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()));
}
}
Expand Down

0 comments on commit 91612bc

Please sign in to comment.