Skip to content

Commit

Permalink
docs: update FAQs mentions of ara-web, ara-collection
Browse files Browse the repository at this point in the history
ara-web has been archived in February 2023, update the docs to remove
it and add ara-collection which was missing.

Take the opportunity to refresh the question about different components
of ara running on different servers.
  • Loading branch information
dmsimard committed Jun 22, 2024
1 parent 880d124 commit 415b9c3
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 12 deletions.
2 changes: 1 addition & 1 deletion doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@

# General information about the project.
project = "ara"
copyright = "2022, ARA Records Ansible authors"
copyright = "2024, ARA Records Ansible authors"
author = "ARA Records Ansible authors"

# The short X.Y version.
Expand Down
28 changes: 17 additions & 11 deletions doc/source/faq.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _faq:

FAQ
===

Expand All @@ -7,8 +9,8 @@ Where is the source code ?
ARA is currently composed of three different free and open source projects:

- https://github.com/ansible-community/ara for the REST API server and Ansible plugins
- https://github.com/ansible-community/ara-web for the standalone web interface
- https://github.com/ansible-community/ara-infra for project-specific infrastructure needs (such as the `ara.recordsansible.org <https://ara.recordsansible.org>`_ website)
- https://github.com/ansible-community/ara-collection for the Ansible collection of ara

What's an Ansible callback ?
----------------------------
Expand Down Expand Up @@ -75,16 +77,20 @@ Can I set up the different components of ARA on different servers ?

Yes.

The defaults are set to have the callback use the offline API client which
expects the server dependencies installed and the data is saved to a local
sqlite database.
By default ara operates "offline" on localhost, recording Ansible playbook results
to a local sqlite database without requiring users to start a server.

According to preference or use case, the data can be saved to local (or remote)
MySQL or PostgreSQL databases instead.

The ara server (based on django & django-rest-framework) provides the reporting
interface as well as the API used by the ara Ansible plugins.

The server's state is stored in the database and it can be self hosted anywhere.
Running multiple servers allows for load balancing, scalability and high availability.

However, the callback can also be configured to send data to a specified API
server address and the API server can be configured to use a remote database
server such as PostgreSQL or MySQL.
To make use of a persistent server, configure the ara Ansible plugins with:

The web client interface provided by ara-web_ is stateless and requires an API
server address to connect to.
It can be installed anywhere that has access to the API server.
- ``export ARA_API_CLIENT=http``
- ``export ARA_API_SERVER=http://ara.example.org``

.. _ara-web: https://github.com/ansible-community/ara-web

0 comments on commit 415b9c3

Please sign in to comment.