recordsansible
/
ara
Code Issues Proposed changes
RETIRED, this project has moved to https://github.com/ansible-community/ara
481 Commits 2 Branches 72 Tags 21 MiB
YAML 100%
Go to file
David Moreau Simard 0b37aab023
zuul: Use no_log when setting up authentication 
Otherwise the secret gets picked up by ARA.

Change-Id: I980b856d1bfc2eaf77c3fcaba662c2222f8f3360
 		2020-01-29 19:26:55 -05:00
.github/ISSUE_TEMPLATE Add GitHub issue templates for bugs and enhancements 2019-06-07 23:03:07 -04:00
.zuul.d zuul: Use no_log when setting up authentication 2020-01-29 19:26:55 -05:00
ara Add new Ansible plugins: ara_playbook and ara_api 2020-01-29 08:46:28 -05:00
doc Add new Ansible plugins: ara_playbook and ara_api 2020-01-29 08:46:28 -05:00
playbooks Re-structure integration tests 2019-06-20 10:22:27 -04:00
roles Add EL8 support for ara_api and ara_frontend_nginx roles 2020-01-27 19:24:44 -05:00
tests zuul: Use no_log when setting up authentication 2020-01-29 19:26:55 -05:00
.black.toml Rename pyproject.toml to .black.toml to address pep517 2019-04-24 21:17:34 -04:00
.editorconfig 💥 first commit 2018-03-29 12:36:14 -04:00
.gitignore Also ignore .venv directories. 2019-05-13 21:35:09 +02:00
.gitreview Switch default branch from feature/1.0 to master 2019-06-04 20:33:00 -04:00
LICENSE 💥 first commit 2018-03-29 12:36:14 -04:00
README.rst Remove f-strings to remove requirement on py36 2019-11-19 10:21:00 -05:00
manage.py Make manage.py executable 2019-05-21 16:56:59 -04:00
requirements.txt Add a comment in requirements.txt about location of server deps 2019-06-02 21:19:29 -04:00
setup.cfg api: Pin django to <3.0 2019-12-03 13:50:55 -05:00
setup.py Bootstrap the repository with the basic machinery (#1) 2018-03-29 12:36:22 -04:00
test-requirements.txt docs: isolate docs requirements and add API server dependencies 2019-11-28 10:11:45 -05:00
tox.ini docs: isolate docs requirements and add API server dependencies 2019-11-28 10:11:45 -05:00

README.rst

ARA Records Ansible

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

image

ARA saves playbook results to a local or remote database by using an Ansible callback plugin and provides an API to integrate this data in tools and interfaces.

This project provides ARA's Ansible plugins, the REST API server as well as simple built-in web interfaces to browse the recorded data.

A stateless javascript client interface is provided by a different project, ara-web.

Quickstart

Here's how you can get started from scratch with sane defaults with python>=3.5:

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

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

# Run your playbook
ansible-playbook playbook.yml

If nothing went wrong, your playbook data should have been saved in a local database at ~/.ara/server/ansible.sqlite.

You can take a look at the recorded data by running ara-manage runserver and pointing your browser at http://127.0.0.1:8000/.

That's it !

Live demos

You can find live demos deployed by the built-in ara_api and ara_web Ansible roles at https://api.demo.recordsansible.org and https://web.demo.recordsansible.org.

Documentation

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

Community and getting help

Contributors

See contributors on GitHub.

Copyright

Copyright (c) 2019 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/>.