A Maven plugin to simplify the running of Ansible playbooks from within a Maven Project.
Available from the Central Repository
- ansible:help displays the available goals and parameters
- ansible:ansible executes an ansible module, using the ansible executable
- ansible:playbook runs an ansible playbook, using the ansible-playbook executable
- ansible:pull set up a remote copy of ansible, using the ansible-pull executable
See the integration tests for examples of using the plugin within a project
To execute the ansible ping module with the host as localhost
<plugin>
<groupId>co.escapeideas.maven</groupId>
<artifactId>ansible-maven-plugin</artifactId>
<version>1.3.0</version>
<executions>
<execution>
<id>ansible</id>
<goals>
<goal>ansible</goal>
</goals>
</execution>
</executions>
</plugin>
From the command line
mvn co.escapeideas.maven:ansible-maven-plugin:ansible -Dansible.moduleName=ping -Dansible.hosts=localhost
or in short form
mvn ansible:ansible -Dansible.moduleName=ping -Dansible.hosts=localhost
To run the playbook playbook.yml
<plugin>
<groupId>co.escapeideas.maven</groupId>
<artifactId>ansible-maven-plugin</artifactId>
<version>1.3.0</version>
<executions>
<execution>
<id>ansible-playbook</id>
<goals>
<goal>playbook</goal>
</goals>
</execution>
</executions>
</plugin>
From the command line
mvn co.escapeideas.maven:ansible-maven-plugin:playbook -Dansible.playbook=playbook.yml
or in short form
mvn ansible:playbook -Dansible.playbook=playbook.yml
To pull the repo git://example.com/repo
<plugin>
<groupId>co.escapeideas.maven</groupId>
<artifactId>ansible-maven-plugin</artifactId>
<version>1.3.0</version>
<executions>
<execution>
<id>ansible-pull</id>
<goals>
<goal>pull</goal>
</goals>
</execution>
<configuration>
<directory>somewhere</directory>
<url>git://example.com/repo<url>
</configuration>
</executions>
</plugin>
From the command line
mvn co.escapeideas.maven:ansible-maven-plugin:pull -Dansible.url='git://example.com/repo' -Dansible.directory=somewhere
or in short form
mvn ansible:pull -Dansible.url='git://example.com/repo' -Dansible.directory=somewhere
Binds by default to the lifecycle phase: pre-integration-test
| Name | Type | Description | Required |
|---|---|---|---|
| background | Integer | Run asynchronously, failing after this number of seconds | No |
| connection | String | Connection type to use | No |
| executable | String | The executable to use for this execution, defaults to ansible | Yes |
| failOnAnsibleError | boolean | If true, the build will fail when the ansible command returns an error(a non zero exit status), defaults to false | No |
| forks | Integer | The number of parallel processes to use | No |
| hosts | String | Pattern for matching hosts to run the module against, defaults to localhost | Yes |
| inventory | File | The inventory host file | No |
| limit | String | Limit selected hosts to an additional pattern | No |
| logDirectory | File | If present the plugin will log the output of the execution to files in this directory | No |
| moduleArgs | String | Module arguments | No |
| moduleName | String | Module name to execute, defaults to ping | Yes |
| modulePath | File | The path to the ansible module library | No |
| options | List | Additional options to be included in the command | No |
| pollInterval | Integer | The poll interval if using background | No |
| privateKey | File | Use this file to authenticate the connection | No |
| promoteDebugAsInfo | boolean | Output messages will be promoted from debug messages to info messages, defaults to false | No |
| remoteUser | String | Connect as this user | No |
| timeout | Integer | Override the SSH timeout in seconds | No |
| vaultPasswordFile | File | Vault password file | No |
| workingDirectory | File | The directory in which to run, defaults to project.build.directory or the java tmp directory if it does not exist | Yes |
To use a parameter on the command line, prefix it with ansible.
Binds by default to the lifecycle phase: pre-integration-test
| Name | Type | Description | Required |
|---|---|---|---|
| connection | String | Connection type to use | No |
| executable | String | The executable to use for this execution, defaults to ansible-playbook | Yes |
| extraVars | List | Additional variables as key=value or YAML/JSON | No |
| failOnAnsibleError | boolean | If true, the build will fail when the ansible command returns an error(a non zero exit status), defaults to false | No |
| forks | Integer | The number of parallel processes to use | No |
| inventory | File | The inventory host file | No |
| limit | String | Limit selected hosts to an additional pattern | No |
| logDirectory | File | If present the plugin will log the output of the execution to files in this directory | No |
| modulePath | File | The path to the ansible module library | No |
| options | List | Additional options to be included in the command | No |
| playbook | File | The playbook to run, defaults to playbook.yml | Yes |
| pollInterval | Integer | The poll interval if using background | No |
| privateKey | File | Use this file to authenticate the connection | No |
| promoteDebugAsInfo | boolean | Output messages will be promoted from debug messages to info messages, defaults to false | No |
| skipTags | String | Only run plays and tasks whose tags do not match these values | No |
| startAtTask | String | Start the playbook at the task matching this name | No |
| syntaxCheck | boolean | Perform a syntax check on the playbook, but do not execute it, defaults to false | No |
| remoteUser | String | Connect as this user | No |
| tags | String | Only run plays and tasks tagged with these values | No |
| timeout | Integer | Override the SSH timeout in seconds | No |
| vaultPasswordFile | File | Vault password file | No |
| workingDirectory | File | The directory in which to run, defaults to project.build.directory or the java tmp directory if it does not exist | Yes |
To use a parameter on the command line, prefix it with ansible.
Binds by default to the lifecycle phase: pre-integration-test
| Name | Type | Description | Required |
|---|---|---|---|
| checkout | String | The branch, tag or commit to checkout | No |
| executable | String | The executable to use for this execution, defaults to ansible-pull | Yes |
| extraVars | String | Additional variables as key=value or YAML/JSON | No |
| failOnAnsibleError | boolean | If true, the build will fail when the ansible command returns an error(a non zero exit status), defaults to false | No |
| force | boolean | Run the playbook even if the repository could not be updated, defaults to false | No |
| inventory | File | The inventory host file | No |
| logDirectory | File | If present the plugin will log the output of the execution to files in this directory | No |
| moduleName | String | Module name used to check out repository | No |
| onlyIfChanged | boolean | Only run the playbook if the repository has been updated, defaults to false | No |
| options | List | Additional options to be included in the command | No |
| playbook | File | The playbook to run | No |
| purge | boolean | Purge checkout after playbook run, defaults to false | No |
| promoteDebugAsInfo | boolean | Output messages will be promoted from debug messages to info messages, defaults to false | No |
| sleep | Integer | Sleep for a random interval upto this number of seconds | No |
| url | String | URL of the playbook repository | No |
| vaultPasswordFile | File | Vault password file | No |
| workingDirectory | File | The directory in which to run, defaults to project.build.directory or the java tmp directory if it does not exist | Yes |
To use a parameter on the command line, prefix it with ansible.
Release date: 24-10-2014
Release date: 26-10-2014
- Issue#1 Command line execution fails outside of project directories
Release date: 02-12-2014
Release date: 08-12-2014
- Issue#4 Output is not logged until the process has completed
Release date: 04-01-2015
Release date: 31-03-2015
- Issue#8 Display output depending on a settings
Release date: 14-08-16
- Issue#10 Adding syntaxCheck option for ansible-playbook