ARA records Ansible Playbook runs and provides intuitive interfaces to browse them
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Zuul 9144020d7d Merge "cli: add missing controller arg to playbook metrics" 3 days ago
.github/ISSUE_TEMPLATE Simplify github issue templates 5 months ago
.zuul.d misc: Use demo.recordsansible.org instead of api.demo 1 week ago
ara Merge "cli: add missing controller arg to playbook metrics" 3 days ago
contrib/container-images docs: fix typo in link to fedora package 4 weeks ago
doc misc: Use demo.recordsansible.org instead of api.demo 1 week ago
playbooks Re-structure integration tests 1 year ago
roles Updated docs, updated vars files for ara_web and ara_frontend_nginx to support Debian 10 8 months ago
tests Add support for recording controller fqdn 1 month ago
.black.toml Rename pyproject.toml to .black.toml to address pep517 1 year ago
.editorconfig 💥 first commit 2 years ago
.gitignore Feature to ignore Ansible files based on patterns. 1 year ago
.gitreview Switch default branch from feature/1.0 to master 1 year ago
LICENSE 💥 first commit 2 years ago
README.rst misc: Use demo.recordsansible.org instead of api.demo 1 week ago
manage.py Add missing license headers 1 year ago
requirements.txt CLI: Port "ara playbook list" command from ara 0.x 6 months ago
setup.cfg cli: Add 'ara playbook metrics' 1 month ago
setup.py Bootstrap the repository with the basic machinery (#1) 2 years ago
test-requirements.txt tests: unpin factory-boy and fix moved import 4 months ago
tox.ini tests: add a tox target to run benchmarks 2 months ago

README.rst

ARA Records Ansible

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

image

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.

image

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.

image

Reporting interface

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

image

ara CLI

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

image

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

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:

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:

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

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

A live demo for demonstration and test purposes is available at https://demo.recordsansible.org

This demo is deployed with the help of the ara 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.

Copyright

Copyright (c) 2020 Red Hat, Inc.

ARA Records Ansible is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

ARA Records Ansible is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with ARA Records Ansible.  If not, see <http://www.gnu.org/licenses/>.