recordsansible
/
ara-server
Code Issues Proposed changes
RETIRED, this project was merged into a single ara repository
50 Commits 1 Branch 2 Tags 1.6 MiB
Go to file
Zuul a7ae20af3d Merge "Small cleanups for django best practices." 2018-09-28 14:15:34 +00:00
.zuul.d Bootstrap documentation and publish it to readthedocs 2018-09-26 16:48:24 -04:00
ara Merge "Small cleanups for django best practices." 2018-09-28 14:15:34 +00:00
doc/source Bootstrap documentation and publish it to readthedocs 2018-09-26 16:48:24 -04:00
hacking Update ansible-integration tests 2018-09-12 10:33:02 -04:00
.editorconfig 💥 first commit 2018-03-29 12:36:14 -04:00
.gitignore Fix flake8 and bandit tests 2018-06-20 12:39:48 +00:00
.gitreview Added .gitreview 2018-03-27 11:35:47 +00:00
LICENSE 💥 first commit 2018-03-29 12:36:14 -04:00
README.rst Update and improve README to be more accurate 2018-09-26 16:40:35 -04:00
manage.py Refactor ara-server into namespaced python modules 2018-06-20 08:38:49 -04:00
requirements.txt Small cleanups for django best practices. 2018-09-28 08:51:36 +02:00
setup.cfg Only ara is a namespace package, subpackages are not. 2018-09-28 08:31:09 +02:00
setup.py Bootstrap the repository with the basic machinery (#1) 2018-03-29 12:36:22 -04:00
test-requirements.txt Bootstrap the repository with the basic machinery (#1) 2018-03-29 12:36:22 -04:00
tox.ini Only ara is a namespace package, subpackages are not. 2018-09-28 08:31:09 +02:00

README.rst

ara-server

image

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

ara-server is a component of ARA which provides an API to store and query Ansible execution results:

image

Disclaimer

ara-server is not yet stable and will be shipped as part of a coordinated ARA 1.0 release. It is not currently recommended for production use.

While most of the major work has landed, please keep in mind that we can still introduce backwards incompatible changes until we ship the first release.

You are free to use this project and in fact, you are more than welcome to contribute feedback, bug fixes or improvements !

If you are looking for a stable version of ARA, you can find the latest 0.x version on PyPi and the source is available here.

Documentation

Work in progress

TL;DR: Using tox is convenient for the time being:

# Retrieve the source
git clone https://github.com/openstack/ara-server
cd ara-server

# Install tox
pip install tox # (or the tox python library from your distro packages)

# Run an Ansible playbook integrated ara-server, ara-clients and ara-plugins
# This will exercise all three components and record real data from Ansible
tox -e ansible-integration

# Run test server -> http://127.0.0.1:8000/api/v1/
tox -e runserver

# Run actual tests or get coverage
tox -e pep8
tox -e py35
tox -e cover

# Build docs
tox -e docs

Authors and contributors

ARA was created by David Moreau Simard (@dmsimard) and contributors can be found 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/>.