Update home page for 1.0
Derive the content from the ara README and remove outdated things. Change-Id: I31b5c18acfdebeb0f3b7b8daa6340210cbd7c1a0
This commit is contained in:
David Moreau Simard
parent
648191bb47
commit
f8329ebad0
|
|
@ -4,74 +4,78 @@ kind: home
|
|||
|
||||
# What's ARA ?
|
||||
|
||||
ARA Records Ansible playbook runs and makes the recorded data available and intuitive for users and systems.
|
||||
|
||||
It makes your Ansible playbooks easier to understand and troubleshoot.
|
||||
ARA Records Ansible playbooks and makes them easier to understand and troubleshoot.
|
||||
|
||||
|
||||
<br>
|
||||
<br>
|
||||
|
||||
### ARA is free and open source
|
||||
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.
|
||||
|
||||
ARA is an [OpenStack](https://www.openstack.org) community project and all of it's [components](https://github.com/openstack?q=ara)
|
||||
are free and open source under the GPLv3 license.
|
||||
- For the API as well as the Ansible components, see [ara](https://github.com/ansible-community/ara)
|
||||
- For the web client interface, see [ara-web](https://github.com/ansible-community/ara-web)
|
||||
|
||||
You can participate in [code reviews](https://review.openstack.org/#/q/project:%255Eopenstack/ara.*+OR+project:openstack/ansible-role-ara)
|
||||
and learn how you can contribute your first patch in the [contributors documentation](https://ara.readthedocs.io/en/latest/contributing.html).
|
||||
<br>
|
||||
<br>
|
||||
|
||||
### ARA is simple and easy to use
|
||||
## ARA is simple and easy to use
|
||||
|
||||
Simplicity is a core feature in ARA.
|
||||
It does one thing and it does it well: reporting on your Ansible playbooks.
|
||||
|
||||
[Install ARA](http://ara.readthedocs.io/en/stable/installation.html), tell [Ansible](https://ara.readthedocs.io/en/latest/configuration.html)
|
||||
to use it and your next playbook will be recorded. That's it !
|
||||
Here's how you can get started from scratch with sane defaults:
|
||||
|
||||
Read more about the project's core values in the [manifesto](https://ara.readthedocs.io/en/stable/manifesto.html).
|
||||
<br>
|
||||
<br>
|
||||
```bash
|
||||
# Create a python3 virtual environment and activate it so we don't conflict
|
||||
# with system or distribution packages
|
||||
python3 -m venv ~/.ara/virtualenv
|
||||
source ~/.ara/virtualenv/bin/activate
|
||||
|
||||
### ARA is tested, stable and production ready
|
||||
# Install Ansible, ARA and it's API server dependencies
|
||||
pip install ansible ara[server]
|
||||
|
||||
Each new commit to ARA is gated against a series of [unit and integration tests](https://github.com/openstack/ara#contributing-testing-issues-and-bugs)
|
||||
against different Linux distributions and versions of Ansible in order to prevent regressions.
|
||||
# Tell Ansible to use the ARA callback plugin
|
||||
export ANSIBLE_CALLBACK_PLUGINS="$(python -m ara.setup.callback_plugins)"
|
||||
|
||||
# Run your playbook as usual
|
||||
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 browse this data through the API by executing ``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](https://ara.readthedocs.io/en/feature-1.0/ansible-role-ara-api.html)
|
||||
and [ara_web](https://ara.readthedocs.io/en/feature-1.0/ansible-role-ara-web.html)
|
||||
Ansible roles at https://api.demo.recordsansible.org and https://web.demo.recordsansible.org.
|
||||
|
||||
## ARA is free and open source
|
||||
|
||||
ARA is free and open source under the GPLv3 license.
|
||||
|
||||
The code review and CI infrastructure is hosted by [OpenDev](https://opendev.org).
|
||||
|
||||
You can participate in [code reviews](https://review.opendev.org/#/q/project:%255Erecordsansible/.*)
|
||||
and learn how you can contribute your first patch in the [contributors documentation](https://ara.readthedocs.io/en/feature-1.0/contributing.html).
|
||||
|
||||
## ARA is tested, stable and production ready
|
||||
|
||||
Each new commit to ARA is gated against a series of unit and integration tests
|
||||
against different Linux distributions and versions of Ansible in order to
|
||||
prevent regressions.
|
||||
|
||||
ARA is used to record more than a [million playbooks a month](http://superuser.openstack.org/articles/scaling-ara-ansible/) from the OpenStack community alone.
|
||||
|
||||
It works.
|
||||
<br>
|
||||
<br>
|
||||
|
||||
### ARA is offline and decentralized by default
|
||||
## ARA is offline and decentralized by default
|
||||
|
||||
Running Ansible from your laptop ? No problem.
|
||||
|
||||
You can browse your ARA reports locally from a sqlite database without ever leaving the comfort of localhost.
|
||||
|
||||
Need to scale with real [web and application servers](https://ara.readthedocs.io/en/stable/webserver.html) or use a
|
||||
database server like [MySQL or PostgreSQL](https://ara.readthedocs.io/en/stable/configuration.html#ara-database) ?
|
||||
|
||||
You can do that too.
|
||||
<br>
|
||||
<br>
|
||||
|
||||
# Getting started
|
||||
|
||||
```
|
||||
# Install ARA from PyPi
|
||||
$ pip install ara
|
||||
|
||||
# Set up Ansible to use ARA
|
||||
$ export ANSIBLE_CALLBACK_PLUGINS=$(python -m ara.setup.callback_plugins)
|
||||
|
||||
# Run your Ansible playbook as usual
|
||||
$ ansible-playbook myplaybook.yml
|
||||
|
||||
# Start the ARA standalone webserver
|
||||
$ ara-manage runserver
|
||||
|
||||
# Browse http://127.0.0.1:9191
|
||||
```
|
||||
Need to aggregate data from multiple locations ?
|
||||
You can run an API server and hook it up to a database engine like
|
||||
[PostgreSQL or MySQL](https://ara.readthedocs.io/en/feature-1.0/api-configuration.html#ara-database-engine).
|
||||
|
|
|
|||
Loading…
Reference in New Issue