Installing Ansible Runner¶

Ansible Runner is provided from several different locations depending on how you want to use it.

Using pip¶

Python 2.7+ and 3.6+ are supported and installable via pip:

$ pip install ansible-runner

To install from the latest Fedora sources:

$ dnf install python-ansible-runner

Check out the source code from github:

$ git clone git://github.com/ansible/ansible-runner

Or download from the releases page

Then install:

$ python setup.py install

OR:

$ pip install .

To produce an installable wheel file:

make dist

To produce a distribution tarball:

make sdist

Make sure the wheel distribution is built (see Build the distribution) and run:

make image

The RPM build uses a container image to bootstrap the environment in order to produce the RPM. Make sure you have docker installed and proceed with:

make rpm

Fix an issue where ssh sock path could be too long
Fix an issue passing extra vars as dictionaries via the interface
Fix an issue where stdout was delayed on buffering which also caused stdout not to be available if the task was canceled or failed
Fix role-path parameter not being honored when given on the command line Also fixed up unit tests to actually surface this error if it comes back
Fully onboard Zuul-CI for unit and integration testing

Added a feature that supports sending ansible status and events to external systems via a plugin interface
Added support for Runner module users to receive runtime status changes in the form of a callback that can be supplied to the run() methods (or passing it directly on Runner initialization)
Fix an issue where timeout settings were far too short
Add a new status and return code to indicate Runner timeout occurred.
Add support for running ad-hoc commands (direct module invocation, ala ansible vs ansible-playbook)
Fix an issue that caused missing data in events sent to the event handler(s)
Adding support for supplying role_path in module interface
Fix an issue where messages would still be emitted when –quiet was used
Fix a bug where ansible processes could be orphaned after canceling a job
Fix a bug where calling the Runner stats method would fail on python 3
Fix a bug where direct execution of roles couldn’t be daemonized
Fix a bug where relative paths couldn’t be used when calling start vs run

Fix a bug that could cause a hang if unicode environment variables are used
Allow select() to be used instead of poll() when invoking pexpect
Check for the presence of Ansible before executing
Fix an issue where a missing project directory would cause Runner to fail silently
Add support for automatic cleanup/rotation of artifact directories
Adding support for Runner module users to receive events in the form of a callback that can be supplied to the run() methods (or passing it directly on Runner initialization)
Adding support for Runner module users to provide a callback that will be invoked when the Runner Ansible process has finished. This can be supplied to the run() methods (or passing it directly on Runner initialization).

Adding support for pexpect 4.6 for performance and efficiency improvements
Adding support for launching roles directly
Adding support for changing the output mode to json instead of vanilla Ansible (-j)
Adding arguments to increase ansible verbosity (-v[vvv]) and quiet mode (-q)
Adding support for overriding the artifact directory location
Adding the ability to pass arbitrary arguments to the invocation of Ansible
Improving debug and verbose output
Various fixes for broken python 2/3 compatibility, including the event generator in the python module
Fixing a bug when providing an ssh key via the private directory interface
Fixing bugs that prevented Runner from working on MacOS
Fixing a bug that caused issues when providing extra vars via the private dir interface