Overview
- Introduction
- Usage
- Goals
- FAQ
- Release notes
Examples
- Simple deployment
- Generate DAR
- Tag your deployables
- Testing the configuration
- Deploy configuration files
- Deploy and Run functional tests
- Deploy and Run performance tests
Project Documentation
XL Deploy Plugin
The XL Deploy Plugin is used to deploy a Deployment Package to an single environment.
Definition: Deployment is the 'series of activities needed to make an application available to end users'. This includes the full scope of deployment activities: de-installation of the old software packages, installation of the new software packages, updating the data source(s), modifying firewall settings, reconfiguring the web server and restarting all services involved. Or rephrased in more simple terms: deployment is everything needed to ensure that if a developer, tester or end user opens his browser and types in www.my-application.com, he will see the application up and running, fully functional with (live) data.
This plugin is in particular handy to perform integration tests for other Maven plugins.
IMPORTANT: Since version 4.0.0. this plugin requires Java 7.
Goals Overview
The plugin has 4 goals meant to participate in the default build lifecycle:
- deployit:generate-deployment-package Generate a Deployment Package.
- deployit:import import a generated dar file into a remote XL Deploy server.
- deployit:deploy Deploy the DAR (Deployment Archive) to a single environment.
- deployit:clean Undeploy the deployment package from the target environment.
Usage
General instructions on how to use the XL Deploy Plugin can be found on the usage page. Some more specific use cases are described in the examples given below.
In case you still have questions regarding the plugin's usage, please have a look at the FAQ and feel free to contact the user mailing list. The posts to the mailing list are archived and could already contain the answer to your question as part of an older thread. Hence, it is also worth browsing/searching the mail archive.
If you feel like the plugin is missing a feature or has a defect, you can fill a feature request or bug report in our issue tracker. When creating a new issue, please provide a comprehensive description of your concern. Especially for fixing bugs it is crucial that the developers can reproduce your problem. For this reason, entire debug logs, POMs or most preferably little demo projects attached to the issue are very much appreciated. Of course, patches are welcome, too. Contributors can check out the project from our source repository and will find supplementary information in the guide to helping with Maven.
Examples
The following example configurations are available to illustrate selected use cases in more detail:
- Simple deployment to a target environment Server.
- Generate DAR.
- Tag your deployables.
- Simple deployment and Clean to a test environment and clean after the integration-test phase.
- Test Mode to compute the change plan and to display the steps without executing them.
- Skip Mode to skip all the steps of the computed change plan.
- Deployment Configuration Files and perform replacement before deployment.
- Deploy and Run functional tests
- Deploy and Performance functional tests