You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/src/main/asciidoc/compose-dev-services.adoc
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,7 +22,7 @@ _The Compose Specification is a developer-focused standard for defining cloud an
22
22
23
23
Compose is a widely used tool for defining and managing multi-container applications, for development and testing purposes.
24
24
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.
26
26
27
27
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.
28
28
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
78
78
instead of using the default dev service provided by the `quarkus-jdbc-postgresql` extension.
79
79
80
80
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_.
82
82
83
83
=== Multi-Service Example: Custom Network and Dependencies
84
84
@@ -154,7 +154,7 @@ For example, the PostgreSQL Dev Service looks for a service with the image name
154
154
155
155
When a match is found, the extension will:
156
156
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.)
158
158
2. Configure the application to use the discovered service
159
159
3. Skip creating its own default Dev Service container
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.
291
291
You can specify the profiles to activate by setting the `quarkus.compose.devservices.profiles` property in the `application.properties` file:
292
292
293
293
[source, yaml]
@@ -313,7 +313,7 @@ services:
313
313
314
314
=== Ignoring Services
315
315
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:
317
317
318
318
[source, yaml]
319
319
----
@@ -378,7 +378,7 @@ services:
378
378
----
379
379
380
380
You can also specify how many times a log message should appear by setting the numeric suffix value:
Compose Dev Services provides several configuration options to control how services are started, stopped and shared between application instances.
613
613
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.
615
615
When the application stops, Compose Dev Services stops the services it started.
616
616
617
617
=== Compose Project Name
@@ -627,9 +627,9 @@ Compose Dev Services determines the project name as follows:
627
627
628
628
=== Discovering already started Compose Services
629
629
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.
631
631
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,
633
633
or manually using the `docker compose up` or `podman compose up` commands.
634
634
635
635
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
664
664
665
665
You can also configure the timeout for stopping services with the `quarkus.compose.devservices.stop-timeout` property.
666
666
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:
0 commit comments