Update README and community information
Change-Id: I90f97b096e137ada0a14e0732df8c71566ff336d
This commit is contained in:
David Moreau-Simard
parent
0e9bf3ed34
commit
6396372bac
69
README.rst
69
README.rst
|
|
@ -2,23 +2,44 @@ ARA: Ansible Run Analysis
|
|||
=========================
|
||||
.. image:: doc/source/_static/ara-with-icon.png
|
||||
|
||||
ARA is an open source project that was created by Ansible users for Ansible
|
||||
users.
|
||||
|
||||
Its purpose is to provide a way to simply and easily understand what happens
|
||||
throughout playbook runs at any scale.
|
||||
|
||||
ARA records Ansible playbook runs and makes the recorded data available and
|
||||
intuitive for users and systems.
|
||||
|
||||
TL;DR
|
||||
=====
|
||||
ARA doesn't run your playbooks for you: it integrates with Ansible as a
|
||||
callback plugin wherever it is.
|
||||
|
||||
ARA_ records Ansible_ Playbook runs seamlessly to make them easier to
|
||||
visualize, understand and troubleshoot. It integrates with Ansible wherever you
|
||||
run it.
|
||||
Whether you are running Ansible from your personal laptop or a server, all
|
||||
you need to do is to `install ARA`_, `configure Ansible to use ARA`_ and
|
||||
you're good to go.
|
||||
|
||||
ARA provides four things:
|
||||
.. image:: doc/source_static/reports.png
|
||||
|
||||
.. _install ARA: https://ara.readthedocs.io/en/latest/installation.html
|
||||
.. _configure Ansible to use ARA: http://ara.readthedocs.io/en/latest/configuration.html
|
||||
|
||||
Quickstart
|
||||
==========
|
||||
|
||||
::
|
||||
|
||||
# Install ARA
|
||||
pip install ara
|
||||
# Make Ansible use the ARA callback plugin regardless of python version
|
||||
export ANSIBLE_CALLBACK_PLUGINS="$(python -c 'import os,ara; print(os.path.dirname(ara.__file__))')/plugins/callbacks"
|
||||
# Run your playbook
|
||||
# ansible-playbook myplaybook.yml
|
||||
# Start the ARA standalone webserver
|
||||
ara-manage runserver
|
||||
# Browse http://127.0.0.1:9191
|
||||
|
||||
Refer to the documentation_ for more information.
|
||||
|
||||
.. _documentation: https://ara.readthedocs.io/en/latest/
|
||||
|
||||
ARA components
|
||||
==============
|
||||
|
||||
ARA has four main components:
|
||||
|
||||
1. An `Ansible callback plugin`_ to record playbook runs into a local or remote database
|
||||
2. The ara_record_ and ara_read_ pair of Ansible modules to record and read persistent data with ARA
|
||||
|
|
@ -45,14 +66,32 @@ Otherwise, screenshots highlighting some of ARA's features are available in
|
|||
|
||||
.. _YouTube: https://www.youtube.com/watch?v=k3i8VPCanGo
|
||||
.. _OpenStack-Ansible: https://github.com/openstack/openstack-ansible
|
||||
.. _the frequently asked questions: http://ara.readthedocs.io/en/latest/faq.html#interface-preview
|
||||
.. _the frequently asked questions: https://ara.readthedocs.io/en/latest/faq.html#interface-preview
|
||||
|
||||
Community and getting help
|
||||
==========================
|
||||
|
||||
The ARA community hangs out on IRC on the freenode network.
|
||||
The ARA community hangs out on IRC, Slack and Discord.
|
||||
|
||||
Come chat with developers and users on the **#ara** channel !
|
||||
All three chats are seamlessly linked to each other so you can use your
|
||||
preferred client to come chat with us !
|
||||
|
||||
**IRC**
|
||||
|
||||
- Server: `irc.freenode.net`_
|
||||
- Channel: #ara
|
||||
|
||||
**Slack**
|
||||
|
||||
- https://ara-community.slack.com
|
||||
- Join with the `Slack invitation <https://join.slack.com/t/ara-community/shared_invite/MjMxNzI4ODAxMDQxLTE1MDM4MDEzMTEtNzU1NTUwMTcyOQ>`_
|
||||
|
||||
**Discord**
|
||||
|
||||
- https://discordapp.com
|
||||
- Join with the `Discord invitation <https://discord.gg/z2SGdc9>`_
|
||||
|
||||
.. _irc.freenode.net: https://webchat.freenode.net/
|
||||
|
||||
Contributing, issues and bugs
|
||||
=============================
|
||||
|
|
|
|||
|
|
@ -11,13 +11,13 @@
|
|||
<h2><a href="https://github.com/openstack/ara" target="_blank">ARA</a> records <a href="https://www.ansible.com/" target="_blank">Ansible</a> playbook runs seamlessly to make them easier to visualize, understand and troubleshoot.</h2>
|
||||
<h3>
|
||||
ARA doesn't run your playbooks for you: it integrates with Ansible as a callback plugin wherever it is.<br>
|
||||
Whether you are running Ansible from your personal laptop, workstation or a server,
|
||||
Whether you are running Ansible from your personal laptop or a server,
|
||||
all you need to do is to <a href="https://ara.readthedocs.io/en/latest/installation.html" target="_blank">install ARA</a>,
|
||||
<a href="https://ara.readthedocs.io/en/latest/configuration.html">configure Ansible to use ARA</a> and you're good to go.
|
||||
<a href="https://ara.readthedocs.io/en/latest/configuration.html" target="_blank">configure Ansible to use ARA</a> and you're good to go.
|
||||
</h3>
|
||||
<h3>
|
||||
The ARA project puts a lot of emphasis on being simple to install and use without requiring you change your existing Ansible workflows.<br>
|
||||
You can read about the project's core values and principles in the <a href="https://ara.readthedocs.io/en/latest/manifesto.html">project manifesto</a>.
|
||||
You can read about the project's core values and principles in the <a href="https://ara.readthedocs.io/en/latest/manifesto.html" target="_blank">project manifesto</a>.
|
||||
</h3>
|
||||
<br>
|
||||
{% if not empty_database -%}
|
||||
|
|
@ -58,11 +58,11 @@
|
|||
<h2>Get started by looking at your <a href="{{ url_for('reports.report_list') }}">playbook reports</a>.</h2>
|
||||
{% else -%}
|
||||
<h2><strong>The ARA database is empty or the web application is not configured properly to find your playbook data.</strong></h2>
|
||||
<h2>Get started by <a href="https://ara.readthedocs.io/en/latest/configuration.html">configuring Ansible to use ARA</a>.</h2>
|
||||
<h2>Get started by <a href="https://ara.readthedocs.io/en/latest/configuration.html" target="_blank">configuring Ansible to use ARA</a>.</h2>
|
||||
<h2>Your data will be available in the interface after an <code>ansible-playbook</code> is run after configuring Ansible to use ARA.</h2>
|
||||
<br>
|
||||
<br>
|
||||
<h3>Need help ? Look at the <a href="https://ara.readthedocs.io/en/latest/">documentation</a> or come chat with users and developers on IRC in #ara on the freenode network.</h3>
|
||||
<h3>Need help ? Look at the <a href="https://ara.readthedocs.io/en/latest/" target="_blank">documentation</a> or come chat with the <a href="https://github.com/openstack/ara#community-and-getting-help" target="_blank">community</a> !</h3>
|
||||
{% endif -%}
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
Loading…
Reference in New Issue