Skip to content

Commit 5024355

Browse files
rsvobodagsmet
authored andcommitted
Compose Dev Services guide fixes
(cherry picked from commit 4b33988)
1 parent ad2779c commit 5024355

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

docs/src/main/asciidoc/compose-dev-services.adoc

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ _The Compose Specification is a developer-focused standard for defining cloud an
2222

2323
Compose is a widely used tool for defining and managing multi-container applications, for development and testing purposes.
2424
A YAML description file, typically named `compose.yml`, defines the services, networks, and volumes required for your application.
25-
https://docs.docker.com/compose/[Docker Compose] is the reference implementation and https://podman-desktop.io/docs/compose[Podman Desktop] also provides out-of-box support for the Compose specification.
25+
https://docs.docker.com/compose/[Docker Compose] is the reference implementation and https://podman-desktop.io/docs/compose[Podman Desktop] also provides out-of-the-box support for the Compose specification.
2626

2727
Quarkus detects Compose files named `compose-devservices.yml` (or <<compose-devservices-compose-files>>) in your project and starts the defined services when your application runs in development or test mode.
2828
Extensions providing dev services discover these custom services and use them instead of creating default ones.
@@ -78,7 +78,7 @@ When you run the application in dev mode or execute tests, Compose Dev Services
7878
instead of using the default dev service provided by the `quarkus-jdbc-postgresql` extension.
7979

8080
As per the above configuration, the PostgreSQL container port `5432` will be exposed to a random host port
81-
and the application datasource will be configured by extracting connection information such as _user_, _password_ and the _database name_.
81+
and the application datasource will be configured by extracting connection information such as _user_, _password_, and the _database name_.
8282

8383
=== Multi-Service Example: Custom Network and Dependencies
8484

@@ -154,7 +154,7 @@ For example, the PostgreSQL Dev Service looks for a service with the image name
154154

155155
When a match is found, the extension will:
156156

157-
1. Extract connection information from the container (connection url, credentials, database name, etc.)
157+
1. Extract connection information from the container (connection URL, credentials, database name, etc.)
158158
2. Configure the application to use the discovered service
159159
3. Skip creating its own default Dev Service container
160160

@@ -287,7 +287,7 @@ quarkus.compose.devservices.files=src/main/docker/base-compose.yml,src/main/dock
287287

288288
==== Using Compose profiles
289289

290-
With profiles, Compose files can define a set of active profiles so started services is adjusted for various usages and environments.
290+
With profiles, Compose files can define a set of active profiles so that started services are adjusted for various usages and environments.
291291
You can specify the profiles to activate by setting the `quarkus.compose.devservices.profiles` property in the `application.properties` file:
292292

293293
[source, yaml]
@@ -313,7 +313,7 @@ services:
313313

314314
=== Ignoring Services
315315

316-
You can configure Compose Dev Services to ignore specific services by adding the `io.quarkus.devservices.compose.ignore` label to the service in your Compose file:
316+
You can configure Compose Dev Services to ignore specific services discovery by adding the `io.quarkus.devservices.compose.ignore` label to the service in your Compose file:
317317

318318
[source, yaml]
319319
----
@@ -378,7 +378,7 @@ services:
378378
----
379379

380380
You can also specify how many times a log message should appear by setting the numeric suffix value:
381-
`io.quarkus.devservices.compose.wait_for.logs.3: .*Worker started.*`
381+
`io.quarkus.devservices.compose.wait_for.logs.3: .\*Worker started.*`
382382

383383
=== Wait for Ports
384384

@@ -469,7 +469,7 @@ The host is set to the Docker host IP address, and the port is set to the mapped
469469

470470
[NOTE]
471471
====
472-
For database services, if the label `io.quarkus.compose.devservices.jdbc.parameters` is set, the parameters are added to the JDBC URL.
472+
For database services, if the label `io.quarkus.devservices.compose.jdbc.parameters` is set, the parameters are added to the JDBC URL.
473473
====
474474

475475
=== Custom config mapping using service labels
@@ -481,7 +481,7 @@ You can customize how environment variables and exposed ports are mapped to appl
481481
To map an environment variable to a specific application configuration property,
482482
use the `io.quarkus.devservices.compose.config_map.env.<env-var-name>` label.
483483

484-
Let's take the example of a MQTT broker:
484+
Let's take the example of an MQTT broker:
485485

486486
[source, yaml]
487487
----
@@ -611,7 +611,7 @@ export KAFKA_ADVERTISED_LISTENERS=PLAINTEXT://localhost:$PORT_9092;
611611

612612
Compose Dev Services provides several configuration options to control how services are started, stopped and shared between application instances.
613613

614-
When the application starts in development or test mode, Compose Dev Services decide whether to start services or to discover already running services based on the configuration.
614+
When the application starts in development or test mode, Compose Dev Services decides whether to start services or to discover already running services based on the configuration.
615615
When the application stops, Compose Dev Services stops the services it started.
616616

617617
=== Compose Project Name
@@ -627,9 +627,9 @@ Compose Dev Services determines the project name as follows:
627627

628628
=== Discovering already started Compose Services
629629

630-
Once the project name is determined, Compose Dev Services first tries discovering existing services with that project name.
630+
Once the project name is determined, Compose Dev Services first tries to discover existing services with that project name.
631631

632-
The already started compose project may have been already started by another Quarkus application running locally with the same project name,
632+
The already started compose project may have been started by another Quarkus application running locally with the same project name,
633633
or manually using the `docker compose up` or `podman compose up` commands.
634634

635635
Regardless of how the services were started,
@@ -664,7 +664,7 @@ This allows services to be reused by other applications or subsequent runs of th
664664

665665
You can also configure the timeout for stopping services with the `quarkus.compose.devservices.stop-timeout` property.
666666
After the timeout, Compose Dev Services will forcefully stop the services.
667-
The default timeout is chosen deliberately short to 1 second for fast cleanup, but you can increase it as needed:
667+
The default timeout is deliberately chosen to be 1 second for fast cleanup, but you can increase it as needed:
668668

669669
[source, text]
670670
----

0 commit comments

Comments
 (0)