Archery SQL 审核平台运维部署手册

1. 项目简介

Archery 是基于 Python Django 开发的 SQL 审核查询平台，旨在提升 DBA 的工作效率，规范 SQL 操作流程。

• 核心功能：工作流审核、SQL 语法检测、SQL 执行（支持异步）、慢查询日志分析、数据库管理。
• 底层组件：依赖 GoInception/Inception 作为 SQL 分析与执行引擎。

2. 环境准备

2.1 硬件资源推荐

• CPU: 2 Core+
• 内存: 4GB+ (Archery + MySQL + Redis + GoInception 组合较为吃内存)
• 磁盘: 50GB+

2.2 软件依赖

• OS: CentOS 7.9 / Ubuntu 20.04+
• Docker Engine: 19.03+
• Docker Compose: v2.0+

# 检查环境
docker --version
docker compose version

3. 部署架构说明

本次部署采用 All-in-One 的容器化编排方式，包含以下服务：

1. Archery: Web 应用核心。
2. MySQL: 存储 Archery 自身的元数据（用户、配置、工单记录）。
3. Redis: 缓存及 Celery 消息队列中间件。
4. GoInception: SQL 解析与执行引擎（推荐替代旧版 Inception）。

4. 部署步骤

4.1 拉取文件

下载 Releases文件，解压后进入docker-compose文件夹 如果网络受限可访问码云地址: gitee

#解压，切到对应目录
#./archery/src/docker-compose
vim docker-compose.yml

4.2 核心参数配置 (settings.py)

运维重点关注配置。

找到./archery/src/docker-compose/archery/settings.py，然后修改：

A. 数据库连接 (连接 Docker 内的 MySQL)

    DATABASE_URL=(str, "mysql://root:@127.0.0.1:3306/archery"),
 DATABASES = {
    "default": {
        **env.db(),
        **{
            "DEFAULT_CHARSET": "utf8mb4",
            "CONN_MAX_AGE": 50,
            "OPTIONS": {
                "init_command": "SET sql_mode='STRICT_TRANS_TABLES'",
                "charset": "utf8mb4",
            },
            "TEST": {
                "NAME": "test_archery",
                "CHARSET": "utf8mb4",
            },
        },
    }
}

B. 缓存与队列 (连接 Docker 内的 Redis)

    CACHE_URL=(str, "redis://127.0.0.1:6379/0"),
# 缓存配置
CACHES = {
    "default": env.cache(),
}

C. 邮件配置 (用于审批通知)

EMAIL_HOST = 'smtp.exmail.qq.com'  # 示例
EMAIL_PORT = 465
EMAIL_HOST_USER = 'dba@yourcompany.com'
EMAIL_HOST_PASSWORD = 'password'
EMAIL_USE_SSL = True
DEFAULT_FROM_EMAIL = 'SQL审计平台 <dba@yourcompany.com>'

D. 安全配置

# 生产环境必须修改
SECRET_KEY = '生产环境请生成随机复杂字符串'
DEBUG=(bool, False),
ALLOWED_HOSTS=(list, ["*"]),

4.3 启动与初始化

1. 启动服务

   1. docker compose up -d
      

2. 初始化数据库表结构

   1. docker exec -ti archery /bin/bash
      cd /opt/archery
      source /opt/venv4archery/bin/activate
      python3 manage.py makemigrations sql  
      python3 manage.py migrate 
      # 数据初始化
      python3 manage.py dbshell<sql/fixtures/auth_group.sql
      python3 manage.py dbshell<src/init_sql/mysql_slow_query_review.sql
      

3. 创建 管理员 账号

   1. # 创建管理用户
      python3 manage.py createsuperuser
      # 按提示输入用户名(如 admin)、邮箱、密码
      

5. 功能验证与配置 (Web端)

访问 ;服务器IP>:9123，使用管理员账号登录。

5.1 系统配置 (关键)

进入 【系统管理】 -> 【 配置项 管理】 -> 【goInception配置】 。

添加 GoInception 实例 (用于审核执行):

• Host: goinception (Docker内部DNS)
• Port: 4000
• User/Password: (默认无密码，留空或随意填)

添加 业务数据库 实例 (用于被审核):

• 实例类型: MySQL
• Host: 192.168.x.x (业务库IP，注意 Docker 容器到宿主机网络的连通性)
• Port: 3306
• 用途: 选中“SQL上线”和“SQL查询”

注意配置实例资源组，资源组用于控制该组的成员的权限，而组是用于控制用户的权限。

5.2 SQL 上线工作流测试

先配置组的审核流程，再测试

进入 【系统管理】 -> 【 配置项 管理】 -> 【工单审核流配置】 。将目标组配置审批权限组。

1. 提交工单:

   1. 点击 【 SQL 审核】 -> 【SQL上线】 。
   2. 选择业务数据库实例、数据库名。
   3. 输入 SQL：CREATE TABLE test_archery (id int primary key);
   4. 点击 【 SQL 检测】 。
   5. 若检测通过，点击 【提交】 。

2. 审核与执行:

   1. 以管理员身份进入 【 SQL 审核】 -> 【工单审核】 。
   2. 找到工单，点击 【审核通过】 。
   3. (若开启了自动执行，则自动完成；否则需点击 【执行】 )。
   4. 查看执行日志，确认状态为 Execute Successfully。

3. 验证结果:

   1. 在业务数据库中确认表是否创建成功。

5.3 邮件通知测试

• 提交工单后，观察配置的邮箱是否收到“待审核”通知。
• 如果未收到，检查容器日志：docker logs archery，搜索 SMTP 错误。

6. 运维维护指南

6.1 日志查看

当出现报错（如 500 错误、SQL 执行卡住）时，排查顺序：

1. Archery 日志 (Web报错、Celery任务失败):

   1. docker logs --tail 100 -f archery
      

2. GoInception 日志 (语法解析错误、连接业务库失败):

   1. docker logs --tail 100 -f goinception
      

6.2 常见问题 FAQ

• Q: SQL 检测报错 Can't connect to MySQL server on 'xxx'

  • A: 这是 GoInception 容器无法连接业务数据库。请检查 GoInception 容器与业务库的网络连通性，以及业务库是否开启了白名单。

• Q: 点击执行后，工单一直处于“执行中”

  • A: 检查 Redis 连接是否正常，以及 Celery Worker 是否在运行。查看 Archery 日志是否有 Celery 连接报错。

• Q: 页面显示静态资源丢失 ( CSS / JS 404)

  • A: 通常是 settings.py 中 STATIC_ROOT 或 Nginx 配置问题。Docker 部署一般不需要手动处理，重启容器尝试。

6.3 数据备份

需要定期备份 Archery 的元数据（存储了所有工单历史和配置）。

# 备份命令
docker exec archery_mysql mysqldump -uroot -pYourStrongPassword123 archery > /backup/archery_backup_$(date +%F).sql

6.4 版本升级

1. 备份数据库（重要）。

2. 修改 docker-compose.yml 中的镜像版本号。

3. 拉取新镜像：docker compose pull。

4. 重启服务：docker compose up -d。

5. 执行数据库变更（Archery 版本更新常伴随表结构变更）：

   1. docker exec -ti archery python3 manage.py migrate
      

7. 安全建议

1. 端口 保护: 9123 端口建议仅对内网开放，或通过 Nginx 反代配置 SSL 证书及 IP 白名单。
2. Inception 隔离: 确保 GoInception 只有 Archery 可以访问，避免被恶意利用作为代理攻击业务库。
3. 弱口令扫描: 强制要求 Archery 用户修改默认密码，并集成 LDAP/AD 统一认证。