Welcome to the ARA documentation!

Table of Contents

• Introduction
• Getting started
• Ansible: configuration to use ARA
• Ansible: plugins and use cases
  • ara_default callback: recording playbooks from Ansible
    • Recording ad-hoc commands
    • Playbook names and labels
    • Default labels
    • CLI argument labels
  • ara_label: managing labels on playbooks
  • ara_api: free-form API queries
  • ara_playbook: get the running playbook or one in specific
  • ara_record: arbitrary key/values in playbook reports
    • Adding records to playbooks after their completion
• API: Server configuration
  • Overview
  • Configuration variables
    • ARA_ALLOWED_HOSTS
    • ARA_BASE_DIR
    • ARA_BASE_PATH
    • ARA_CORS_ORIGIN_WHITELIST
    • ARA_CORS_ORIGIN_REGEX_WHITELIST
    • ARA_CSRF_TRUSTED_ORIGINS
    • ARA_DATABASE_CONN_MAX_AGE
    • ARA_DATABASE_ENGINE
    • ARA_DATABASE_NAME
    • ARA_DATABASE_USER
    • ARA_DATABASE_PASSWORD
    • ARA_DATABASE_HOST
    • ARA_DATABASE_PORT
    • ARA_DATABASE_OPTIONS
    • ARA_DEBUG
    • ARA_DISTRIBUTED_SQLITE
    • ARA_DISTRIBUTED_SQLITE_PREFIX
    • ARA_DISTRIBUTED_SQLITE_ROOT
    • ARA_ENV
    • ARA_EXTERNAL_AUTH
    • ARA_LOGGING
    • ARA_LOG_LEVEL
    • ARA_SETTINGS
    • ARA_PAGE_SIZE
    • ARA_READ_LOGIN_REQUIRED
    • ARA_SECRET_KEY
    • ARA_TIME_ZONE
    • ARA_WRITE_LOGIN_REQUIRED
• API: Authentication and security
  • Setting a custom secret key
  • Authentication and user management
    • #1: Authentication via a server/proxy
    • #2: Authentication via django
  • Setting up authentication for the Ansible plugins
  • Using authentication with the API clients
  • Managing hosts allowed to serve the API
  • Managing CORS (cross-origin resource sharing)
• API: Endpoint documentation
  • Built-in API browser interface
  • Relationship between objects
• API: Usage with built-in clients
  • ARA Offline API client
  • ARA HTTP API client
  • Example API usage
• API: Distributed sqlite backend
  • Use case
  • Configuration
• API: Server container images
  • Building an image with buildah
  • Running an image with podman
  • Sending data to the API server
  • Common operations
    • Modifying ARA’s API server settings
    • Running outside of localhost
    • Connecting to mysql, mariadb or postgresql backends
    • Running SQL migrations
• CLI: ara API client
  • ara
  • ara expire
  • ara playbook list
  • ara playbook show
  • ara playbook delete
  • ara playbook metrics
  • ara playbook prune
  • ara play list
  • ara play show
  • ara play delete
  • ara host list
  • ara host show
  • ara host delete
  • ara host metrics
  • ara record list
  • ara record show
  • ara record delete
  • ara result list
  • ara result show
  • ara result delete
  • ara task list
  • ara task show
  • ara task delete
  • ara task metrics
• CLI: ara-manage (django API server)
  • ara-manage
  • ara-manage prune
  • ara-manage changepassword
  • ara-manage createsuperuser
  • ara-manage makemigrations
  • ara-manage migrate
  • ara-manage runserver
  • ara-manage generate
• Contributing to ARA
  • Code contributions
    • Pull requests welcome
    • Testing changes locally
• Frequently asked questions
  • Where is the source code ?
  • What’s an Ansible callback ?
  • What versions of Ansible are supported ?
  • Why ARA instead of <X> ?
  • Can I set up the different components of ARA on different servers ?
• Troubleshooting
  • Increasing verbosity and obtaining debug logging
  • Playbooks are not recorded
  • Database exceptions
  • Bad Request (400) and ALLOWED_HOSTS
  • Improving playbook recording performance
• Changelog and release notes
  • 1.7.2 (2024-08-29)
  • 1.7.1 (2024-02-06)
  • 1.7.0 (2023-09-10)
  • 1.6.1 (2022-12-12)
  • 1.6.0 (2022-12-01)
  • 1.5.8 (2022-03-24)
  • 1.5.7 (2021-07-31)
  • 1.5.6 (2021-04-14)
  • 1.5.5 (2021-01-29)
  • 1.5.4 (2020-12-18)
  • 1.5.3 (2020-10-23)
  • 1.5.2 (2020-10-16)
  • 1.5.1 (2020-09-23)
  • 1.5.0.1 (2020-09-23)
  • 1.5.0 (2020-09-23)
  • 1.4.3 (2020-08-11)
  • 1.4.2 (2020-07-02)
  • 1.4.1 (2020-05-26)
  • 1.4.0 (2020-04-16)
  • 0.16.7 (2020-04-14)
  • 1.3.2 (2019-12-12)
  • 1.3.1 (2019-12-06)
  • 1.3.0 (2019-12-03)
  • 0.16.6 (2019-11-18)
  • 1.2.0 (2019-10-25)
  • 1.1.0 (2019-07-02)
  • 0.16.5 (2019-06-04)
  • 1.0.1 (2019-06-05)
  • 1.0.0 (2019-06-03)
  • 0.16.4 (2019-05-22)
  • 0.16.3 (2019-01-21)
  • 0.16.2 (2019-01-02)
  • 0.16.1 (2018-09-04)
  • 0.16.0 (2018-08-27)
  • 0.15.0 (2018-05-01)
  • 0.14.6 (2018-02-05)
  • 0.14.5 (2017-10-26)
  • 0.14.4 (2017-09-20)
  • 0.14.3 (2017-09-17)
  • 0.14.2 (2017-08-29)
  • 0.14.1 (2017-08-27)
  • 0.14.0 (2017-07-31)
  • 0.13.3 (2017-06-30)
  • 0.13.2 (2017-06-22)
  • 0.13.1 (2017-05-21)
  • 0.13.0 (2017-05-04)
  • 0.12.5 (2017-04-19)
  • 0.12.4 (2017-04-01)
  • 0.12.3 (2017-03-09)
  • 0.12.2 (2017-03-07)
  • 0.12.1 (2017-03-03)
  • 0.12.0 (2017-03-01)
  • 0.11.0 (2017-02-13)
  • 0.10.5 (2017-01-16)
  • 0.10.4 (2017-01-15)
  • 0.10.3 (2016-12-12)
  • 0.10.2 (2016-12-10)
  • 0.10.1 (2016-12-05)
  • 0.10.0 (2016-12-01)
  • 0.9.3 (2016-11-14)
  • 0.9.2 (2016-10-22)
  • 0.9.1 (2016-09-15)
  • 0.9.0 (2016-09-13)
  • 0.8.1 (2016-06-03)
  • 0.8.0 (2016-06-02)
  • 0.7.1 (2016-05-30)
  • 0.7.0 (2016-05-27)
  • 0.6.0 (2016-05-21)
  • 0.5.2 (2016-05-18)
  • 0.5.1 (2016-05-17)
  • 0.5.0 (2016-05-14)
  • 0.4.0 (2016-05-10)
  • 0.3.1 (2016-05-09)
  • 0.3 (2016-05-09)
  • 0.2 (2016-05-09)
  • 0.1 (2016-05-08)