sumcumo / ansiblew

A simple ansible wrapper like gradle-wrapper (gradlew) or maven-wrapper (mvnw)

ansible-wrapper

A simple ansible wrapper inspired by gradle-wrapper and maven-wrapper.

After installing ansible-wrapper, you can then replace a call to ansible-playbook with a call to ./ansiblew. E.g. to execute a playbook called web.yaml, you just run ./ansiblew web.yaml.

Install

Place a copy of the ansiblew script and the ansiblew.json configuration file into a directory. You can simplify the installation by running:

curl -sf https://raw.githubusercontent.com/flachnetz/ansiblew/master/get.sh | sh

Configuration

Edit ansiblew.json to configure the ansible version you want to use. You can also specify a list of extra python packages to install. This might be useful, if your ansible playbook includes modules depending on third-party modules.

{
  "ansible_version": "2.2.0.0-1",
  "requirements": ["requests==2.12.4"]
}

Update

You can update the wrapper by passing update as the only parameter: ./ansiblew update

Environment variables

Verbose logging can be enabled by setting the environment variable ANSIBLEW_VERBOSE to true. If you need to execute another ansible process, you can pass its name as ANSIBLEW_COMMAND, which defaults to ansible-playbook.

For example, to execute an ad-hoc command with ansible directly, run

ANSIBLEW_COMMAND=ansible ./ansiblew -m shell -a 'df -h /'

To create an encrypted ansible-vault file, run

ANSIBLEW_COMMAND=ansible-vault ./ansiblew create secrets.vault

If you want to provide a different ansiblew config file you can do it by setting the environment variable ANSIBLEW_CONFIG_FILE.