ARA Records Ansible
Project description
ARA Records Ansible
ARA Records Ansible playbook runs and makes the recorded data available and intuitive for users and systems.
The project provides several distinct components in order to make this happen:
An API server for sending and querying data relative to playbook execution results
An API client library for communicating with the API
An Ansible callback plugin to record events as they happen throughout the execution
An Ansible action module to associate arbitrary key/values to your playbook reports
Quickstart
Here’s how you can get started from scratch with default settings:
# Create a virtual environment python3 -m venv ~/.ara/venv # Install Ansible and the required ARA projects ~/.ara/venv/bin/pip install ansible ~/.ara/venv/bin/pip install git+https://github.com/openstack/ara@feature/1.0 # Tell Ansible to use the ARA callback plugin # "python -m ara.plugins" provides the path to the ARA plugins directory export ANSIBLE_CALLBACK_PLUGINS="$(~/.ara/venv/bin/python -m ara.plugins)/callback" # Run your playbook as your normally would ~/.ara/venv/bin/ansible-playbook playbook.yml
The data will be saved in real time throughout the execution of the Ansible playbook.
What happens behind the scenes is that the ARA Ansible callback plugin used the built-in API client to send the data to the API which then saved it to a database located by default at ~/.ara/server/ansible.sqlite.
You’re now ready to start poking at the API with the built-in API clients !
If you’d like to have the ARA web reporting interface, take a look at ara-web.
Documentation
Documentation for installing, configuring, running and using ara is available on readthedocs.io.
Community and getting help
You can chat with the ARA community on Slack and IRC. The two are transparently bridged with teamchat which broadcasts messages from one platform to the other.
In addition, you can also find ARA on Twitter: @ARecordsAnsible
IRC
Server: irc.freenode.net
Channel: #ara
Slack
Join with the Slack invitation
Development
TL;DR: Using tox is convenient for the time being:
# Retrieve the source git clone https://github.com/openstack/ara cd ara git checkout feature/1.0 # Install tox from pip or from your distro packages pip install tox # 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
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/>.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for ara-1.0.0.0a3-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | adda8c0bd83071c680cbc78ceb7889547090e0555f9597139b939cebfef8077a |
|
| MD5 | 3dd86b76702e71c3714fb870eb6eaccf |
|
| BLAKE2b-256 | 0a9d573acc0224bf51add37d5430f9ed43f27226eecd5570162a3c62ddea3b97 |
