recordsansible
/
ara
Code Issues Proposed changes
RETIRED, this project has moved to https://github.com/ansible-community/ara
75 Commits 2 Branches 72 Tags 21 MiB
YAML 100%
Go to file
David Moreau Simard 1f205e2ad9
Merge the tox-pep8 and tox-format jobs and use tox-linters 
black and isort fit into the category of linters.
Let's run everything from the same job so we can avoid wasting time
and resources from the CI infrastructure.

Previously, tox would exit immediately if there was an error with
black, preventing isort from running. You could then run into a
situation where you also had an issue picked up by isort.

Now bash will run all linters and return the appropriate
return code at the end.

Change-Id: I81abe61be65bd9f4f828cfc5f0b7a1d9f1eb1f22
 		2018-10-16 17:02:32 -04:00
.zuul.d Merge the tox-pep8 and tox-format jobs and use tox-linters 2018-10-16 17:02:32 -04:00
ara Merge "Add play filtering by playbook id" 2018-10-16 19:58:31 +00:00
doc/source Bootstrap documentation and publish it to readthedocs 2018-09-26 16:48:24 -04:00
hacking Change parameters to arguments in hacking/validate 2018-10-16 09:40:47 -04:00
tests Merge the tox-pep8 and tox-format jobs and use tox-linters 2018-10-16 17:02:32 -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 Merge the tox-pep8 and tox-format jobs and use tox-linters 2018-10-16 17:02:32 -04:00
manage.py Refactor ara-server into namespaced python modules 2018-06-20 08:38:49 -04:00
pyproject.toml Added CI for black/isort. 2018-10-02 09:50:15 -05:00
requirements.txt Add search by name on playbook endpoint 2018-10-16 09:48:33 -04:00
setup.cfg Don't run isort on django database migrations 2018-10-09 14:01:52 -04:00
setup.py Bootstrap the repository with the basic machinery (#1) 2018-03-29 12:36:22 -04:00
test-requirements.txt Added CI for black/isort. 2018-10-02 09:50:15 -05:00
tox.ini Merge the tox-pep8 and tox-format jobs and use tox-linters 2018-10-16 17:02:32 -04: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 from pip or from your distro packages
pip install tox

# 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 linters
tox -e py3
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/>.