Skip to content

Latest commit

 

History

History
172 lines (121 loc) · 6.37 KB

README.rst

File metadata and controls

172 lines (121 loc) · 6.37 KB
Raw

ARA Records Ansible

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

ARA Records Ansible playbook runs and makes the recorded data available and intuitive for users and systems.

ARA doesn't run your playbooks for you: it integrates with Ansible as a callback plugin wherever it is.

Whether you are running Ansible from your personal laptop or a server, all you need to do is to install ARA, configure Ansible to use ARA and you're good to go.

doc/source/_static/reports.png

Quickstart

# Install ARA
pip install ara

# Load environment variables that inform Ansible to use ARA regardless
# of its location or python version
source <(python -m ara.setup.env)

# Run your Ansible playbook or commands
# ansible-playbook myplaybook.yml

# Start the ARA standalone webserver
ara-manage runserver
# Browse http://127.0.0.1:9191

Refer to the documentation for more information.

ARA components

ARA has four main components:

  1. An Ansible callback plugin to record playbook runs into a local or remote database
  2. The ara_record and ara_read pair of Ansible modules to record and read persistent data with ARA
  3. A CLI client to query the database
  4. 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 and Slack. The two chats are bridged with slack-irc which allows everyone to talk to each other.

IRC

Slack

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 !

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.4.5.0   py27      
Ansible 2.5.5       py27  
Ansible 2.6.0 py35   py27   py35
Ansible "devel" py35       py35

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) 2018 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/>.