Skip to main content
Join the official 2020 Python Developers SurveyStart the survey!

ARA Records Ansible

Project description

ARA Records Ansible

ARA Records Ansible playbooks and makes them easier to understand and troubleshoot.

doc/source/_static/ara-with-icon.png

How it works

ARA Records Ansible playbook execution results to local or remote databases by using an Ansible callback plugin.

This callback plugin leverages built-in python API clients to send data to a REST API server where data and metrics are made available for querying, browsing, monitoring or for integration in other tools and interfaces.

doc/source/_static/graphs/recording-workflow.png

What it looks like

API browser

Included by the API server with django-rest-framework, the API browser allows users to navigate the different API endpoints and query recorded data.

doc/source/_static/ui-api-browser.png

Reporting interface

A simple reporting interface built-in to the API server without any extra dependencies.

doc/source/_static/ui-playbook-details.png

ara CLI

A built-in CLI client for querying and managing playbooks and their recorded data.

doc/source/_static/cli-playbook-list.png

The full list of commands, their arguments as well as examples can be found in the CLI documentation.

ara-web

A project that is a work in progress and would appreciate contributions, ara-web is a stateless javascript interface to the API built with react and patternfly.

doc/source/_static/ui-ara-web.png

Getting started

Requirements

  • Any recent Linux distribution or Mac OS with python >=3.5 available
  • The ara Ansible plugins must be installed for the same python interpreter as Ansible itself

For RHEL 7 and CentOS 7 it is recommended to run the API server in a container due to missing or outdated dependencies. See this issue for more information.

Recording playbooks without an API server

The default API client, offline, requires API server dependencies to be installed but does not need the API server to be running in order to query or send data.

With defaults and using a local sqlite database:

# Install Ansible and ARA (with API server dependencies) for the current user
python3 -m pip install --user ansible "ara[server]"

# Configure Ansible to use the ARA callback plugin
export ANSIBLE_CALLBACK_PLUGINS="$(python3 -m ara.setup.callback_plugins)"

# Run an Ansible playbook
ansible-playbook playbook.yaml

# Use the CLI to see recorded playbooks
ara playbook list

# Start the built-in development server to browse recorded results
ara-manage runserver

Recording playbooks with an API server

When running Ansible from multiple servers or locations, data can be aggregated by running the API server as a service and configuring the ARA Ansible callback plugin to use the http API client with the API server endpoint.

The API server is a relatively simple django web application written in python that can run with WSGI application servers such as gunicorn, uwsgi or mod_wsgi.

Alternatively, the API server can also run from a container image such as the one available on DockerHub:

# Create a directory for a volume to store settings and a sqlite database
mkdir -p ~/.ara/server

# Start an API server with podman from the image on DockerHub:
podman run --name api-server --detach --tty \
  --volume ~/.ara/server:/opt/ara:z -p 8000:8000 \
  docker.io/recordsansible/ara-api:latest

# or with docker:
docker run --name api-server --detach --tty \
  --volume ~/.ara/server:/opt/ara:z -p 8000:8000 \
  docker.io/recordsansible/ara-api:latest

Once the server is running, Ansible playbook results can be sent to it by configuring the ARA callback plugin:

# Install Ansible and ARA (without API server dependencies) for the current user
python3 -m pip install --user ansible ara

# Configure Ansible to use the ARA callback plugin
export ANSIBLE_CALLBACK_PLUGINS="$(python3 -m ara.setup.callback_plugins)"

# Set up the ARA callback to know where the API server is located
export ARA_API_CLIENT="http"
export ARA_API_SERVER="http://127.0.0.1:8000"

# Run an Ansible playbook
ansible-playbook playbook.yaml

# Use the CLI to see recorded playbooks
ara playbook list

Data will be available on the API server in real time as the playbook progresses and completes.

Read more about how container images are built and how to run them in the documentation.

Live demo

Deployments of the ARA API server and ara-web are available for demonstration and test purposes:

These live demos are deployed using the ara_api and ara_web Ansible roles from the ara Ansible collection: https://github.com/ansible-community/ara-collection

Documentation

Documentation for installing, configuring, running and using ARA is available on readthedocs.io.

Community and getting help

Contributing

Contributions to the project are welcome and appreciated !

Get started with the contributor’s documentation.

Authors

Contributors to the project can be viewed on GitHub.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for ara, version 1.5.3
Filename, size File type Python version Upload date Hashes
Filename, size ara-1.5.3-py2.py3-none-any.whl (408.0 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size ara-1.5.3.tar.gz (1.2 MB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page