Skip to content

Commit

Permalink
Add Dev Services configuration reference in all relevant guides
Browse files Browse the repository at this point in the history
Slightly related to quarkusio#45892
  • Loading branch information
gsmet committed Feb 13, 2025
1 parent 1bdd69f commit 26a0c73
Show file tree
Hide file tree
Showing 9 changed files with 41 additions and 9 deletions.
5 changes: 5 additions & 0 deletions docs/src/main/asciidoc/amqp-dev-services.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -58,3 +58,8 @@ quarkus.amqp.devservices.image-name=quay.io/artemiscloud/activemq-artemis-broker
IMPORTANT: The configured image must be _compatible_ with the `activemq-artemis-broker` one.
The container is launched with the `AMQ_USER`, `AMQ_PASSWORD` and `AMQ_EXTRA_ARGS` environment variables.
The ports 5672 and 8161 (web console) are exposed.

[[configuration-reference-devservices]]
== Configuration reference

include::{generated-dir}/config/quarkus-messaging-amqp_quarkus.amqp.devservices.adoc[opts=optional, leveloffset=+1]
10 changes: 5 additions & 5 deletions docs/src/main/asciidoc/infinispan-dev-services.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,11 @@ Quarkus supports a feature called Dev Services that allows you to create various
If you have docker running and have not configured `quarkus.infinispan-client.hosts`,
Quarkus will automatically start an Infinispan container when running tests or dev mode, and automatically configure the connection.

The following properties are available to customize the Infinispan Dev Services:

include::{generated-dir}/config/quarkus-infinispan-client_quarkus.infinispan-client.devservices.adoc[opts=optional, leveloffset=+1]

When running the production version of the application, the Infinispan connection need to be configured as normal,
so if you want to include a production database config in your `application.properties` and continue to use Dev Services
we recommend that you use the `%prod.` profile to define your Infinispan settings.

Dev Services for Infinispan relies on Docker to start the server.
Dev Services for Infinispan relies on Docker/Podman to start the server.

== Connecting to the running Infinispan Server

Expand Down Expand Up @@ -207,3 +203,7 @@ The default service name is `infinispan`.

Sharing is enabled by default in dev mode, but disabled in test mode.
You can disable the sharing with `quarkus.infinispan-client.devservices.shared=false`

== Configuration reference

include::{generated-dir}/config/quarkus-infinispan-client_quarkus.infinispan-client.devservices.adoc[opts=optional, leveloffset=+1]
5 changes: 5 additions & 0 deletions docs/src/main/asciidoc/kafka-dev-services.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -115,3 +115,8 @@ quarkus.kafka.devservices.redpanda.transaction-enabled=false
----

NOTE: Redpanda transactions does not support exactly-once processing.

[[configuration-reference-devservices]]
== Configuration reference

include::{generated-dir}/config/quarkus-kafka-client_quarkus.kafka.devservices.adoc[opts=optional, leveloffset=+1]
4 changes: 4 additions & 0 deletions docs/src/main/asciidoc/kubernetes-dev-services.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -55,3 +55,7 @@ quarkus.kubernetes-client.devservices.api-version=1.22
`api-only` only starts a Kubernetes API Server. If you need a fully-featured Kubernetes cluster that can spin up Pods, you can use `k3s` or `kind`. Note that they both requires to run in Docker privileged mode.

If `api-version` is not set, the latest version for the given flavor will be used. Otherwise, the version must match a https://github.com/dajudge/kindcontainer/blob/master/k8s-versions.json[version supported by the given flavor].

== Configuration reference

include::{generated-dir}/config/quarkus-kubernetes-client_quarkus.kubernetes-client.devservices.adoc[opts=optional, leveloffset=+1]
4 changes: 4 additions & 0 deletions docs/src/main/asciidoc/mongodb-dev-services.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,7 @@ The default service name is `mongodb`.

Sharing is enabled by default in dev mode, but disabled in test mode.
You can disable the sharing with `quarkus.mongodb.devservices.shared=false`.

== Configuration reference

include::{generated-dir}/config/quarkus-mongodb-client_quarkus.mongodb.devservices.adoc[opts=optional, leveloffset=+1]
5 changes: 5 additions & 0 deletions docs/src/main/asciidoc/pulsar-dev-services.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -69,3 +69,8 @@ The following example enables transaction support:
quarkus.pulsar.devservices.broker-config.transaction-coordinator-enabled=true
quarkus.pulsar.devservices.broker-config.system-topic-enabled=true
----

[[configuration-reference-devservices]]
== Configuration reference

include::{generated-dir}/config/quarkus-messaging-pulsar_quarkus.pulsar.devservices.adoc[opts=optional, leveloffset=+1]
5 changes: 5 additions & 0 deletions docs/src/main/asciidoc/rabbitmq-dev-services.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -137,3 +137,8 @@ Additionally, any additional arguments can be provided to the binding's definiti
----
quarkus.rabbitmq.devservices.bindings.a-binding.arguments.non-std-option=value
----

[[configuration-reference-devservices]]
== Configuration reference

include::{generated-dir}/config/quarkus-messaging-rabbitmq_quarkus.rabbitmq.devservices.adoc[opts=optional, leveloffset=+1]
8 changes: 4 additions & 4 deletions docs/src/main/asciidoc/redis-dev-services.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,6 @@ Quarkus supports a feature called Dev Services that allows you to create various
What that means practically, is that if you have docker running and have not configured `quarkus.redis.hosts`,
Quarkus will automatically start a Redis container when running tests or dev mode, and automatically configure the connection.

Available properties to customize the Redis Dev Service.

include::{generated-dir}/config/quarkus-redis-client_quarkus.redis.devservices.adoc[opts=optional, leveloffset=+1]

When running the production version of the application, the Redis connection need to be configured as normal,
so if you want to include a production database config in your `application.properties` and continue to use Dev Services
we recommend that you use the `%prod.` profile to define your Redis settings.
Expand All @@ -41,3 +37,7 @@ The default service name is `redis`.

Sharing is enabled by default in dev mode, but disabled in test mode.
You can disable the sharing with `quarkus.redis.devservices.shared=false`.

== Configuration reference

include::{generated-dir}/config/quarkus-redis-client_quarkus.redis.devservices.adoc[opts=optional, leveloffset=+1]
Original file line number Diff line number Diff line change
Expand Up @@ -432,6 +432,10 @@ image::dev-ui-oidc-dev-svc-login-for-custom-users.png[alt=Dev Services for OIDC

Whichever user you choose, no password is required.

== Configuration reference

include::{generated-dir}/config/quarkus-devservices-keycloak_quarkus.keycloak.adoc[opts=optional, leveloffset=+1]

== References

* xref:dev-ui.adoc[Dev UI]
Expand Down

0 comments on commit 26a0c73

Please sign in to comment.