recordsansible/ara-api repository overview

Container images to run an ARA API server | https://codeberg.org/ansible-community/ara⁠

⁠Getting started

# create a directory for settings and the sqlite database
mkdir -p ~/.ara/server

# with docker:
docker run --name ara-server --detach --tty \
  --volume ~/.ara/server:/opt/ara -p 8000:8000 \
  quay.io/recordsansible/ara-api:latest

# or podman:
podman run --name ara-server --detach --tty \
  --volume ~/.ara/server:/opt/ara -p 8000:8000 \
  quay.io/recordsansible/ara-api:latest

Once the server is running, Ansible playbook results can be sent to it by installing and configuring the ARA callback plugin where you run Ansible:

# Install Ansible and ARA (without API server dependencies) for the current user
python3 -m pip install --user ansible ara

# Configure Ansible to use the ARA callback plugin
export ANSIBLE_CALLBACK_PLUGINS="$(python3 -m ara.setup.callback_plugins)"

# Set up the ARA callback to know where the API server is located
export ARA_API_CLIENT="http"
export ARA_API_SERVER="http://127.0.0.1:8000"

# Run an Ansible playbook
ansible-playbook playbook.yaml

Data will be available on the API server in real time as the playbook progresses and completes.

⁠About tags

• latest: tagged from fedora44-pypi-latest
• fedora44-source-latest: built with fedora-source.sh⁠
• fedora44-pypi-latest: built with fedora-pypi.sh⁠
• fedora44-distribution-latest: built with fedora-distribution.sh⁠
• alma10-pypi-latest: built with alma-pypi.sh⁠
• alma10-source-latest: built with alma-source.sh⁠

⁠Deprecated tags

• source-latest: use fedora44-source-latest instead
• pypi-latest: use fedora44-pypi-latest instead
• distribution-latest: use fedora44-distribution-latest instead
• fedora[32,33,35,36,38,39,40,41]*: use fedora44 images instead
• centos[8,9]: use alma10-pypi-latest instead

⁠How to build and run

Read more about how these images are built and how you can run them in the documentation: https://ara.readthedocs.io/en/latest/container-images.html⁠