Package: ara
ARA Records AnsibleARA Records Ansible and makes it easier to understand and troubleshoot.It is another recursive acronym with a focus on simplicity.About araara provides Ansible reporting by recordingansibleandansible-playbookcommands regardless of how and where they run:from most Linux distributions and even on Mac OS (as long aspython >= 3.8is available)from tools that run Ansible like ansible-(pull|test|runner|navigator), AWX & Automation Controller (Tower), Molecule and Semaphorefrom a terminal, a script or by handfrom a laptop, desktop, server, virtual machine, container or execution environmentfrom CI/CD platforms such as Jenkins, Rundeck and Zuulfrom git forges like GitHub, GitLab, Gitea & ForgejoThe recorded results are available via an included CLI, a REST API as well as a self-hosted, local-first web reporting interface.https://github.com/ansible-community/ara/assets/1291204/4fbdf5f7-509c-46ea-beb0-726b43e1b985How it worksARA Records Ansible results to SQLite, MySQL and PostgreSQL databases with a standardcallback plugin.This plugin gathers data as Ansible runs and sends it to a Django REST API server:RequirementsAny recent Linux distribution or Mac OS with python >=3.8 availableThe ara package (containing the Ansible plugins) must be installed for the same python interpreter as Ansible itselfGetting startedFor production use, consider learning aboutbest practices,enabling authenticationandignoring what doesn't need to be recorded.Recording playbooks without an API serverara records to a local sqlite database by default and does not require a persistent server:# Install ansible (or ansible-core) with ara (including API server dependencies)python3-mpipinstall--useransible"ara[server]"# Configure Ansible to enable araexportANSIBLE_CALLBACK_PLUGINS="$(python3-mara.setup.callback_plugins)"# Run an Ansible playbook as usualansible-playbookplaybook.yml# Check out the CLIaraplaybooklist
arahostlist# or the UI at http://127.0.0.1:8000ara-managerunserverRecording playbooks with an API serverThe server includes a REST API as well a web reporting interface.Consider running one to aggregate playbook runs from different tools, jobs or servers into a single dashboard that can be shared with friends.Get started with theara_api roleor with thecontainer imagespublished by the project onDockerHubandquay.io:# Create a directory for a volume to store settings and a sqlite databasemkdir-p~/.ara/server# Start an API server with docker from the image on DockerHub:dockerrun--nameapi-server--detach--tty\--volume~/.ara/server:/opt/ara-p8000:8000\docker.io/recordsansible/ara-api:latest# or with podman from the image on quay.io:podmanrun--nameapi-server--detach--tty\--volume~/.ara/server:/opt/ara-p8000:8000\quay.io/recordsansible/ara-api:latestOnce the server is running, ara must be installed and configured to send data to it:# Install ansible (or ansible-core) with ara (excluding API server dependencies)python3-mpipinstall--useransibleara# Configure Ansible to enable araexportANSIBLE_CALLBACK_PLUGINS="$(python3-mara.setup.callback_plugins)"# Set up the ara callback to know where the API server is locatedexportARA_API_CLIENT="http"exportARA_API_SERVER="http://127.0.0.1:8000"# Run an Ansible playbook as usualansible-playbookplaybook.yml# Check out the CLIaraplaybooklist
arahostlist# Or browse http://127.0.0.1:8000 (running from the container)Live demoA live demo is deployed with the ara Ansible collection fromAnsible Galaxy.It is available athttps://demo.recordsansible.org.Documentation and changelogDocumentation for installing, configuring, running and using ara is available onara.readthedocs.io.Common issues may be resolved by reading thetroubleshooting guide.Changelog and release notes are available within the repository'sgit tagsas well as thedocumentation.Community and getting helpBugs, issues and enhancements:https://github.com/ansible-community/ara/issuesIRC: #ara onLibera.chatMatrix: Bridged from IRC via#ara:libera.chatSlack: Bridged from IRC viahttps://arecordsansible.slack.comWebsite and blog:https://ara.recordsansible.orgTwitter:https://twitter.com/recordsansibleMastodon:https://fosstodon.org/@araContributingContributions to the project are welcome and appreciated !Get started with thecontributor's documentation.AuthorsCode contributions to the project can be viewed from the git log or onGitHub.The ara parrot logo was designed and contributed byJason E. Rist.CopyrightCopyright (c) 2023 The ARA Records Ansible authors

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/>.