hferreira/ansible-ara

ARA项目Docker镜像文档

概述

ARA（Ansible Run Analysis）项目Docker镜像，基于官方ARA项目构建，旨在提供便捷的ARA服务部署方案。ARA是一款用于记录、存储和可视化Ansible playbook执行数据的工具，通过该镜像可快速搭建完整的ARA服务环境，无需手动配置依赖，降低Ansible自动化流程的监控与审计门槛。

核心功能和特性

• Ansible执行记录：自动捕获并存储Ansible playbook执行过程中的任务结果、变量、日志等详细数据。
• Web界面可视化：提供直观的Web控制台，支持按时间、状态、主机等维度查询执行记录，展示执行统计图表与详细报告。
• 数据持久化：支持通过卷挂载实现执行数据的持久化存储，避免容器重启导致数据丢失。
• 多数据库兼容：兼容SQLite（默认）、PostgreSQL、MySQL等多种数据库后端，满足不同规模环境的数据存储需求。
• REST API支持：内置RESTful API，可通过API接口查询执行数据，支持与第三方系统集成。
• 配置灵活：通过环境变量自定义ARA服务参数，如数据库连接、Web服务端口、跨域设置等。

使用场景和适用范围

• Ansible自动化环境监控：适用于使用Ansible进行自动化部署、配置管理的环境，实时追踪playbook执行状态与历史记录。
• 团队协作审计：供团队共享Ansible执行结果，支持任务执行审计与问题排查，提升协作效率。
• CI/CD流程集成：在CI/CD流水线中集成ARA服务，记录Ansible任务执行结果，辅助构建自动化质量监控体系。
• 教学与演示：用于Ansible学习环境，直观展示playbook执行逻辑与结果，辅助理解Ansible工作流程。

使用方法和配置说明

基础使用（快速启动）

通过docker run命令快速启动ARA服务（默认使用SQLite数据库，数据临时存储于容器内）：

bash
docker run -d --name ara-server -p 8000:8000 docker.xuanyuan.run/araproject/ara

数据持久化配置

为避免容器删除导致数据丢失，需挂载卷持久化存储数据库文件（以SQLite为例）：

bash
docker run -d --name ara-server \
  -p 8000:8000 \
  -v /path/on/host/ara-data:/opt/ara/.ara \
  docker.xuanyuan.run/araproject/ara

说明：/opt/ara/.ara为容器内ARA数据存储路径，包含SQLite数据库文件与配置。

环境变量配置

通过-e参数设置环境变量，自定义ARA服务行为，常用变量如下：

示例：使用PostgreSQL数据库启动ARA服务

bash
docker run -d --name ara-server \
  -p 8000:8000 \
  -e ARA_DATABASE_URL="postgresql://ara_user:ara_pass@postgres-host:5432/ara_db" \
  -e ARA_ALLOWED_HOSTS="ara.example.com,localhost" \
  -e ARA_SECRET_KEY="your-secure-secret-key" \
  docker.xuanyuan.run/araproject/ara

Docker Compose配置示例

对于多容器环境（如搭配数据库），可使用docker-compose.yml简化部署：

yaml
version: '3'
services:
  ara:
    image: docker.xuanyuan.run/araproject/ara
    ports:
      - "8000:8000"
    environment:
      - ARA_DATABASE_URL=postgresql://ara:ara@db:5432/ara
      - ARA_ALLOWED_HOSTS=*
      - ARA_SECRET_KEY=your-secure-key-here
    depends_on:
      - db
    restart: always

  db:
    image: docker.xuanyuan.run/postgres:14
    environment:
      - POSTGRES_USER=ara
      - POSTGRES_PASSWORD=ara
      - POSTGRES_DB=ara
    volumes:
      - postgres_data:/var/lib/postgresql/data
    restart: always

volumes:
  postgres_data:

启动命令：docker-compose up -d

访问与使用

• Web界面：服务启动后，通过http://<容器IP或主机域名>:8000访问ARA Web控制台，查看执行记录与统计信息。
• API接口：通过http://<服务地址>:8000/api/v1/访问REST API，支持查询执行记录、主机、任务等数据（需参考ARA官方API文档）。
• Ansible集成：需在Ansible控制节点配置ansible.cfg，启用ARA回调插件，示例配置：

  ini
  [defaults]
  callback_plugins = /path/to/ara/callback/plugins  # 容器内路径为/usr/local/lib/python3.*/site-packages/ara/plugins/callback
  

注意事项

• 生产环境中，建议使用外部数据库（如PostgreSQL）替代默认SQLite，提升数据可靠性与性能。
• 敏感配置（如数据库密码、ARA_SECRET_KEY）应通过环境变量或配置文件安全传递，避免硬编码。
• 定期备份持久化数据卷，防止数据丢失。
• 镜像标签：可通过指定标签使用特定版本（如araproject/ara:1.6.1），默认latest为最新稳定版。