|Zuul 9144020d7d||3 days ago|
|.github/ISSUE_TEMPLATE||5 months ago|
|.zuul.d||1 week ago|
|ara||3 days ago|
|contrib/container-images||4 weeks ago|
|doc||1 week ago|
|playbooks||1 year ago|
|roles||8 months ago|
|tests||1 month ago|
|.black.toml||1 year ago|
|.editorconfig||2 years ago|
|.gitignore||1 year ago|
|.gitreview||1 year ago|
|LICENSE||2 years ago|
|README.rst||1 week ago|
|manage.py||1 year ago|
|requirements.txt||6 months ago|
|setup.cfg||1 month ago|
|setup.py||2 years ago|
|test-requirements.txt||4 months ago|
|tox.ini||2 months ago|
ARA Records Ansible playbooks and makes them easier to understand and troubleshoot.
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.
Included by the API server with django-rest-framework, the API browser allows users to navigate the different API endpoints and query recorded data.
A simple reporting interface built-in to the API server without any extra dependencies.
A built-in CLI client for querying and managing playbooks and their recorded data.
The full list of commands, their arguments as well as examples can be found in the CLI documentation.
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.
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
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.
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 for installing, configuring, running and using ARA is available on readthedocs.io.
Contributions to the project are welcome and appreciated !
Get started with the contributor's documentation.
Contributors to the project can be viewed on GitHub.
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/>.