brooklyn-maven-plugin - brooklyn:deploy

brooklyn:deploy

Full name:

io.brooklyn.maven:brooklyn-maven-plugin:0.3.0:deploy

Description:

Instruct an existing Brooklyn server to deploy the given blueprint.

Attributes:

Requires a Maven project to be executed.
Binds by default to the lifecycle phase: pre-integration-test.

Required Parameters

Name	Type	Since	Description
blueprint	`String`	`-`	The location of the blueprint to deploy. Either a file on disk or a remote URL. User property is: `brooklyn.blueprint`.

Optional Parameters

Name	Type	Since	Description
applicationIdProperty	`String`	`-`	The property to set to the started application's id. Default value is: `brooklyn.app`.
blueprintEncoding	`String`	`-`	The encoding of the blueprint to deploy. Default value is: `UTF-8`. User property is: `brooklyn.blueprintEncoding`.
ignoreSkipTests	`Boolean`	`-`	Configure the goal to ignore `skipTests`. Useful if your use of the plugin is outside of the default pre- and post-integration-test phases. Default value is: `false`. User property is: `ignoreSkipTests`.
password	`String`	`-`	The password for the user at the Brooklyn server. User property is: `brooklyn.password`.
pollPeriod	`Integer`	`-`	The period that should be waited between successive polls of the Brooklyn server. Default value is: `5`. User property is: `brooklyn.pollPeriod`.
pollUnit	`TimeUnit`	`-`	The unit associated with `pollPeriod`. Default value is: `SECONDS`. User property is: `brooklyn.pollUnit`.
server	`URL`	`-`	The URL of the Brooklyn server to communicate with. User property is: `brooklyn.server`.
skipITs	`Boolean`	`-`	Configure the goal to skip execution. Default value is: `false`. User property is: `skipITs`.
skipTests	`Boolean`	`-`	Configure the goal to skip execution. Default value is: `false`. User property is: `skipTests`.
stopAppOnDeployError	`boolean`	`-`	The deploy goal throws a `MojoFailureException` if `waitForRunning` is true and the deployed application's status is `Status.ERROR`. If this property is true the plugin will attempt to stop the application before throwing. If false it will leave the application alive. Default value is: `true`.
tearDownOnFailure	`boolean`	`-`	Sets whether servers started by `StartBrooklynMojo` should be stopped if execution of the goal fails. Default value is: `true`. User property is: `brooklyn.tearDownOnFailure`.
timeout	`Integer`	`-`	The duration mojos should wait for actions at Brooklyn to complete. Default value is: `5`. User property is: `brooklyn.timeout`.
timeoutUnit	`TimeUnit`	`-`	The unit associated with `timeout`. Default value is: `MINUTES`. User property is: `brooklyn.timeoutUnit`.
username	`String`	`-`	The user to connect to the Brooklyn server as. User property is: `brooklyn.user`.
waitForRunning	`boolean`	`-`	Configure the plugin to wait for the deployed blueprint to be `running` or to throw a `MojoFailureException` if it is not running within the configured `timeout`. If a deployment fails when this property is set then any goals configured in the post-integration-test phase will not run. Default value is: `true`.

Parameter Details

applicationIdProperty:

The property to set to the started application's id.

Type: java.lang.String
Required: No
Default: brooklyn.app

blueprint:

The location of the blueprint to deploy. Either a file on disk or a remote URL.

Type: java.lang.String
Required: Yes
User Property: brooklyn.blueprint

blueprintEncoding:

The encoding of the blueprint to deploy.

Type: java.lang.String
Required: No
User Property: brooklyn.blueprintEncoding
Default: UTF-8

ignoreSkipTests:

Configure the goal to ignore skipTests. Useful if your use of the plugin is outside of the default pre- and post-integration-test phases.

Type: java.lang.Boolean
Required: No
User Property: ignoreSkipTests
Default: false

password:

The password for the user at the Brooklyn server.

Type: java.lang.String
Required: No
User Property: brooklyn.password

pollPeriod:

The period that should be waited between successive polls of the Brooklyn server.

Type: java.lang.Integer
Required: No
User Property: brooklyn.pollPeriod
Default: 5

pollUnit:

The unit associated with pollPeriod.

Type: java.util.concurrent.TimeUnit
Required: No
User Property: brooklyn.pollUnit
Default: SECONDS

server:

The URL of the Brooklyn server to communicate with.

Type: java.net.URL
Required: No
User Property: brooklyn.server

skipITs:

Configure the goal to skip execution.

Type: java.lang.Boolean
Required: No
User Property: skipITs
Default: false

skipTests:

Configure the goal to skip execution.

Type: java.lang.Boolean
Required: No
User Property: skipTests
Default: false

stopAppOnDeployError:

The deploy goal throws a MojoFailureException if waitForRunning is true and the deployed application's status is Status.ERROR. If this property is true the plugin will attempt to stop the application before throwing. If false it will leave the application alive.

Type: boolean
Required: No
Default: true

tearDownOnFailure:

Sets whether servers started by StartBrooklynMojo should be stopped if execution of the goal fails.

Type: boolean
Required: No
User Property: brooklyn.tearDownOnFailure
Default: true

timeout:

The duration mojos should wait for actions at Brooklyn to complete.

Type: java.lang.Integer
Required: No
User Property: brooklyn.timeout
Default: 5

timeoutUnit:

The unit associated with timeout.

Type: java.util.concurrent.TimeUnit
Required: No
User Property: brooklyn.timeoutUnit
Default: MINUTES

username:

The user to connect to the Brooklyn server as.

Type: java.lang.String
Required: No
User Property: brooklyn.user

waitForRunning:

Configure the plugin to wait for the deployed blueprint to be running or to throw a MojoFailureException if it is not running within the configured timeout. If a deployment fails when this property is set then any goals configured in the post-integration-test phase will not run.

Type: boolean
Required: No
Default: true