1ae2b9bcec
This adds new routes for the API and changes the returned responses to be a list/detail model. For example, when querying the playbooks endpoint, we would get a list of playbooks and the entirety of their details in one call. This was very heavy because even one playbook can contain thousands of hosts, tasks and results -- then you could have a large list of playbooks each with those thousands of elements. API calls that are meant to return list of items now contain the minimum information and references to the items they contain. For example: /api/v1/playbooks -> Returns a list of playbook IDs and hrefs /api/v1/playbooks/1 -> Returns details for playbook #1 /api/v1/playbooks/1/files -> Returns a list of file IDs and hrefs for playbook #1 This makes the API responses much lighter, faster and easier to generate. Change-Id: I5580c268df53c4be2f6f7f21fcf103655719376b
ARA: Ansible Run Analysis
ARA is an open source project that was created by Ansible users for Ansible users.
Its purpose is to provide a way to simply and easily understand what happens throughout playbook runs at any scale.
ARA records Ansible playbook runs and makes the recorded data available and intuitive for users and systems.
TL;DR
ARA records Ansible Playbook runs seamlessly to make them easier to visualize, understand and troubleshoot. It integrates with Ansible wherever you run it.
ARA provides four things:
- An Ansible callback plugin to record playbook runs into a local or remote database
- The ara_record and ara_read pair of Ansible modules to record and read persistent data with ARA
- A CLI client to query the database
- A dynamic, database-driven web interface that can also be generated and served from static files
What does the web interface look like ?
A video preview and explanation of the web interface is available on YouTube, featuring playbook runs from the OpenStack-Ansible project.
Otherwise, screenshots highlighting some of ARA's features are available in the frequently asked questions
Community and getting help
The ARA community hangs out on IRC on the freenode network.
Come chat with developers and users on the #ara channel !
Contributing, testing, issues and bugs
Contributions to ARA are definitely welcome and much appreciated !
ARA does not use GitHub for issues or pull requests.
ARA uses the OpenStack infrastructure for code hosting and review as well as project and bug/issue tracking.
The contributor documentation will get you started quickly if you need help contributing !
- Submitted code reviews are available on Gerrit: https://review.openstack.org/#/q/project:openstack/ara
- Bugs, issues and feature tracking are available on StoryBoard: https://storyboard.openstack.org/#!/project/843
Each commit to ARA is reviewed and also rigorously tested to prevent regressions. Here's our current testing coverage:
| - | Fedora | CentOS | OpenSUSE | Debian | Ubuntu |
|---|---|---|---|---|---|
| Ansible 2.2.3.0 |
|
||||
| Ansible 2.3.2.0 |
|
||||
| Ansible "latest" |
|
|
|
||
| Ansible "devel" |
|
|
You might also be interested in reading the project manifesto in order to have a good understanding of the project's core values and philosophy.
Documentation
Frequently asked questions and documentation on how to install, configure, use to ARA is available on readthedocs.io.
Contributors
See contributors on GitHub.
Copyright
Copyright (c) 2017 Red Hat, Inc.
ARA 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 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. If not, see <http://www.gnu.org/licenses/>.