deployit:clean

Full name:

com.xebialabs.deployit:maven-deployit-plugin:3.9.1:clean

Description:

Clean (Undeploy) the target environment.

Attributes:

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

Required Parameters

Name Type Since Description
applicationName String 3.9.0 The name of the application for this DAR file, i.e. the value of the CI-Application attribute.
Default value is: ${project.artifactId}.
mainArtifactName String - If the project packaging is ear or war, sets the CI-Name property for the EAR/WAR artifact in the DAR.
Default value is: ${project.artifactId}.

Optional Parameters

Name Type Since Description
cancelTaskOnError boolean 3.6.2 When a task falls in error, it is cancelled. Sometime it could be interesting to debug it using the UI or the CLI. When this flag is set to false, the task will be left as is.
Default value is: true.
context String - context of the deployit server
Default value is: deployit.
deletePreviouslyDeployedDar boolean - Delete the previous deployed dar. Useful if you work with the SNAPSHOT versions you don't want to keep in your repository.
Default value is: false.
deployables List - List of the deployables, including artifacts or middleware resource specification (eg Datasource)
deployeds List - List of the deployeds: extensions or complete if you use explicitDeployeds options
environment List - List of container in the target environment, if you want to create the environment through the Maven plugin.
environmentId String - Id of the environment used for the deployment.
explicitDeployeds boolean - With explicitDeployeds true, the deployed are not generated but fully loaded from the plugin configuration.
Default value is: false.
failIfNoStepsAreGenerated boolean - If a deployments leads no steps, fail the build.
Default value is: false.
generateDeployedOnUpgrade boolean 3.6.2 Flag controlling whether, during the upgrade operation, the Deployed objects should generated (like an initial deployment) or reused. For security reasons, the default value is false but should be set to true to apply the modifications (new Ear, removed links) even during upgrade.
Default value is: false.
orchestrator String 3.7.0 Set the orchestrator used during the deployment.
password String - Deployit password. See FAQ for more details
port int - Deployit Listen port. The default value of -1 will automatically use 4516 for HTTP and 4517 for HTTPS connections.
Default value is: -1.
secured boolean - If true the communication with the deployit server is secured (https).
Default value is: false.
server String 3.6.4 Id of the server in the setting.xml file, will be used if you don't specify username and password in pom.xml.
Default value is: deployit-credentials.
serverAddress String - Deployit server address
Default value is: localhost.
skipMode boolean - Activate the skip mode: generate the plan, skip all the steps, validate the task
Default value is: false.
testMode boolean - Activate the test mode, generate the plan, display all the steps, validate the task
Default value is: false.
timestampedVersion boolean - Use this attribute to add a timestamp to the version of the deployit package. by default,the SNAPSHOT versions are automatically timestamped. This flag is useful only if you want to timestamp non SNAPSHOT version.
Default value is: false.
username String - Deployit username. See FAQ for more details

Parameter Details

applicationName:

The name of the application for this DAR file, i.e. the value of the CI-Application attribute.
  • Type: java.lang.String
  • Since: 3.9.0
  • Required: Yes
  • Default: ${project.artifactId}

cancelTaskOnError:

When a task falls in error, it is cancelled. Sometime it could be interesting to debug it using the UI or the CLI. When this flag is set to false, the task will be left as is.
  • Type: boolean
  • Since: 3.6.2
  • Required: No
  • Expression: ${deployit.cancel.task.on.error}
  • Default: true

context:

context of the deployit server
  • Type: java.lang.String
  • Required: No
  • Expression: ${deployit.context}
  • Default: deployit

deletePreviouslyDeployedDar:

Delete the previous deployed dar. Useful if you work with the SNAPSHOT versions you don't want to keep in your repository.
  • Type: boolean
  • Required: No
  • Expression: ${deployit.delete.previous.dar}
  • Default: false

deployables:

List of the deployables, including artifacts or middleware resource specification (eg Datasource)
  • Type: java.util.List
  • Required: No

deployeds:

List of the deployeds: extensions or complete if you use explicitDeployeds options
  • Type: java.util.List
  • Required: No

environment:

List of container in the target environment, if you want to create the environment through the Maven plugin.
  • Type: java.util.List
  • Required: No

environmentId:

Id of the environment used for the deployment.
  • Type: java.lang.String
  • Required: No
  • Expression: ${deployit.environmentId}

explicitDeployeds:

With explicitDeployeds true, the deployed are not generated but fully loaded from the plugin configuration.
  • Type: boolean
  • Required: No
  • Default: false

failIfNoStepsAreGenerated:

If a deployments leads no steps, fail the build.
  • Type: boolean
  • Required: No
  • Default: false

generateDeployedOnUpgrade:

Flag controlling whether, during the upgrade operation, the Deployed objects should generated (like an initial deployment) or reused. For security reasons, the default value is false but should be set to true to apply the modifications (new Ear, removed links) even during upgrade.
  • Type: boolean
  • Since: 3.6.2
  • Required: No
  • Expression: ${deployit.generate.deployed.on.upgrade}
  • Default: false

mainArtifactName:

If the project packaging is ear or war, sets the CI-Name property for the EAR/WAR artifact in the DAR.
  • Type: java.lang.String
  • Required: Yes
  • Default: ${project.artifactId}

orchestrator:

Set the orchestrator used during the deployment.
  • Type: java.lang.String
  • Since: 3.7.0
  • Required: No

password:

Deployit password. See FAQ for more details
  • Type: java.lang.String
  • Required: No
  • Expression: ${deployit.password}

port:

Deployit Listen port. The default value of -1 will automatically use 4516 for HTTP and 4517 for HTTPS connections.
  • Type: int
  • Required: No
  • Expression: ${deployit.port}
  • Default: -1

secured:

If true the communication with the deployit server is secured (https).
  • Type: boolean
  • Required: No
  • Default: false

server:

Id of the server in the setting.xml file, will be used if you don't specify username and password in pom.xml.
  • Type: java.lang.String
  • Since: 3.6.4
  • Required: No
  • Expression: ${deployit.credentials}
  • Default: deployit-credentials

serverAddress:

Deployit server address
  • Type: java.lang.String
  • Required: No
  • Expression: ${deployit.server}
  • Default: localhost

skipMode:

Activate the skip mode: generate the plan, skip all the steps, validate the task
  • Type: boolean
  • Required: No
  • Default: false

testMode:

Activate the test mode, generate the plan, display all the steps, validate the task
  • Type: boolean
  • Required: No
  • Default: false

timestampedVersion:

Use this attribute to add a timestamp to the version of the deployit package. by default,the SNAPSHOT versions are automatically timestamped. This flag is useful only if you want to timestamp non SNAPSHOT version.
  • Type: boolean
  • Required: No
  • Expression: ${deployit.timestamp}
  • Default: false

username:

Deployit username. See FAQ for more details
  • Type: java.lang.String
  • Required: No
  • Expression: ${deployit.username}