compose:up

Full name:

org.honton.chas:compose-maven-plugin:0.0.24:up

Description:

Turn on compose application

Attributes:

  • Requires a Maven project to be executed.
  • The goal is thread-safe and supports parallel builds.
  • Binds by default to the lifecycle phase: pre-integration-test.

Required Parameters

Name Type Since Description
<logs> String - (no description)
Default value is: ${project.build.directory}/compose-logs.
User property is: compose.logs.
<project> String - Compose project name
Default value is: ${project.artifactId}.
User property is: compose.project.
<startupLogs> String - Directory for container startup logs
Default value is: ${project.build.directory}/compose-startup.
User property is: compose.startup.

Optional Parameters

Name Type Since Description
<alias> Map<String,String> - Map<String,String> of user property aliases. After maven user properties are assigned with host port values, each alias is interpolated and is assigned.
<allServiceHealthy> boolean - If true, check all services are healthy, including services that have downstream services
Default value is: false.
User property is: compose.allServiceHealthy.
<cli> String - docker compose command line interface
Default value is: docker-compose.
User property is: compose.cli.
<env> Map<String,String> - Environment variables to apply
<noHealthCheck> boolean - If true, health checks are skipped.
Default value is: false.
User property is: compose.noHealthCheck.
<skip> boolean - Skip compose goal
Default value is: false.
User property is: compose.skip.
<timeout> int - Number of seconds to wait for compose commands
Default value is: 90.
User property is: compose.timeout.

Parameter Details

<alias>

Map<String,String> of user property aliases. After maven user properties are assigned with host port values, each alias is interpolated and is assigned.
  • Type: java.util.Map<java.lang.String, java.lang.String>
  • Required: No

<allServiceHealthy>

If true, check all services are healthy, including services that have downstream services
  • Type: boolean
  • Required: No
  • User Property: compose.allServiceHealthy
  • Default: false

<cli>

docker compose command line interface
  • Type: java.lang.String
  • Required: No
  • User Property: compose.cli
  • Default: docker-compose

<env>

Environment variables to apply
  • Type: java.util.Map<java.lang.String, java.lang.String>
  • Required: No

<logs>

(no description)
  • Type: java.lang.String
  • Required: Yes
  • User Property: compose.logs
  • Default: ${project.build.directory}/compose-logs

<noHealthCheck>

If true, health checks are skipped.
  • Type: boolean
  • Required: No
  • User Property: compose.noHealthCheck
  • Default: false

<project>

Compose project name
  • Type: java.lang.String
  • Required: Yes
  • User Property: compose.project
  • Default: ${project.artifactId}

<skip>

Skip compose goal
  • Type: boolean
  • Required: No
  • User Property: compose.skip
  • Default: false

<startupLogs>

Directory for container startup logs
  • Type: java.lang.String
  • Required: Yes
  • User Property: compose.startup
  • Default: ${project.build.directory}/compose-startup

<timeout>

Number of seconds to wait for compose commands
  • Type: int
  • Required: No
  • User Property: compose.timeout
  • Default: 90