opsx
9dcb39e971
用户反馈：部署时报错只说「未找到 kubectl，请先安装」「kubectl 无法连接集群，
请检查 kubeconfig」，对新人等于没说 —— 不知道是没装工具、网络不通、凭据过期
还是 RBAC 没权限，也不知道下一步查什么。
原实现只有两行：
command -v kubectl || die "未找到 kubectl，请先安装"
kubectl version --request-timeout=5s || die "kubectl 无法连接集群，请检查 kubeconfig"
改为三级预检 + 一级软检查：
【0.1 kubectl 是否存在】
按 CentOS/TencentOS、Ubuntu/Debian、macOS 分别给安装命令；
额外给「机器没有外网」的替代路径（控制台下载 / 内网跳板机 / 只 scp 二进制）。
【0.2 kubeconfig 文件是否存在】← 新增，堵一个误判
KUBECONFIG 指向不存在的文件时，kubectl 会忽略它并退回默认规则，
最终报出 "Authentication required" / "connection refused" 这类误导性错误，
让人白查凭据和网络。现在单独判一次，直接给出查找路径 + 各云控制台下载入口。
支持 KUBECONFIG 用 : 分隔多路径，任一存在即通过。
【0.3 能否连上 API Server】按错误类型分类，各给专属修法
· context 不存在 → get-contexts / use-context / 重新下载
· 401 认证失败 → 云厂商 token 有效期几小时，重新下载；自建查客户端证书
· 403 RBAC 拒绝 → auth whoami / auth can-i --list，列出部署所需的具体资源
· x509 证书问题 → 确认证书过期；可信内网可临时 insecure-skip-tls-verify
· 网络不通 → curl -k <API>/version、VPN/专线、安全组放行 6443、换跳板机
· 其他 → 原样打印 kubectl 错误 + 通用排查清单
【0.4 部署权限软检查】auth can-i 非 yes 时只告警不阻断
（首次部署时目标命名空间可能还不存在，硬拦会误伤正常流程）
失败时统一打印环境信息（kubeconfig 路径 / context / API Server / 当前用户），
一眼看出连的是哪个集群。连接超时可用 KUBECTL_TIMEOUT=15s 放宽（默认 8s）。
README 同步新增「前置条件」章节：预检项对照表 + 错误分类表 + 失败输出示例。
=== 验证 ===
从真实 install.sh 抽出预检段，用假 kubectl 精确模拟 8 种场景（两个脚本各跑一遍）：
A 没有 kubectl → 退出 1，打印各系统安装命令 ✅
B API Server 超时 → 退出 1，提示 VPN/专线/安全组 ✅
C 没有 context → 退出 1，提示 get-contexts/use-context ✅
D 401 凭据过期 → 退出 1，提示重新下载 kubeconfig ✅
E 403 权限不足 → 退出 1，列出所需资源权限 ✅
F x509 证书过期 → 退出 1，提示证书/insecure 排障 ✅
G 正常环境（真实集群） → 通过预检，退出 0 ✅
H kubeconfig 文件不存在 → 退出 1，提示下载位置（不误报成 401）✅
结果：阻断 7/7、正常通过 1/1；bash -n 语法检查通过
⚠️ 踩坑记录：kubeconfig 多路径判断最初写成
while IFS= read -r _p; do ...; done < <(printf "%s" "$PATHS" | tr ":" "\n")
printf 输出没有结尾换行 → read 带着数据返回非 0（EOF）→ 循环体一次都不执行，
导致所有场景都误报「找不到 kubeconfig」。改用 IFS=":" + for 拆分。
OpsxSQL — SQL 审核与数据变更审批平台
安全、高效的企业级数据库自助查询 + 数据变更审批平台
项目简介
OpsxSQL 是一个面向 DBA 和开发人员的数据库管理平台，核心定位：
- 自助查询 — 支持 MySQL / PostgreSQL / Redis / MongoDB 多类型数据库的在线查询
- 数据变更审批流 — SQL 变更工单提交 → 审核 → 执行的完整审批流程
- SQL 审核 — 内置 26+ 条审核规则，覆盖语法、性能、安全、命名规范等维度
- 实例管理 — 统一管理多种数据库实例，支持分组和标签
技术栈
| 层级 | 技术 |
|---|---|
| 后端 | Go 1.26 + Gin + GORM + SQLite |
| 前端 | React 19 + TypeScript + Vite + Tailwind CSS + shadcn/ui |
| 认证 | JWT + LDAP 集成 |
| 数据库 | SQLite（零依赖，开箱即用） |
功能模块
🗄️ 实例管理
- MySQL / PostgreSQL / Redis / MongoDB 实例注册与连接测试
- 实例分组管理
- 库表结构浏览（字段、索引详情）
📝 自助查询
- 在线 SQL 编辑器（CodeMirror）
- 语法高亮 + 自动补全
- 查询历史记录（上限 500 条/用户）
- 慢查询日志分析
✅ 工单审批
- SQL 变更工单创建（支持 DDL / DML）
- 多级审批流程（developer → dba → admin）
- 工单状态追踪与通知
- 执行结果确认
🔍 SQL 审核
- 26 条内置审核规则（MySQL 11 / PostgreSQL 7 / Redis 4 / MongoDB 4）
- 规则类型：syntax / performance / safety / security / naming / DDL / DML / DQL / DCL
- 规则启用/禁用 + 自定义配置
👥 用户与权限
- 四级角色：admin / dba / developer / auditor
- LDAP 集成登录
- 基于角色的数据隔离
🔔 通知渠道
- 飞书 Webhook 通知
- 钉钉 Webhook 通知
- 工单状态变更自动推送
📊 其他
- Dashboard 运营数据总览
- 审计日志
- 公告管理
- 系统设置
项目结构
sql-platform/
├── backend/ # Go 后端
│ ├── cmd/server/ # 入口 + seed
│ │ ├── main.go # 启动入口
│ │ └── seed.go # 默认数据初始化
│ ├── internal/
│ │ ├── handler/ # 请求处理器
│ │ ├── middleware/ # 中间件（认证/权限/日志）
│ │ ├── model/ # 数据模型
│ │ └── service/ # 业务逻辑
│ ├── config/ # 配置管理
│ └── router/ # 路由注册
├── frontend/ # React 前端
│ └── src/
│ ├── api/ # API 请求封装
│ ├── components/ # 通用组件
│ │ └── ui/ # shadcn/ui 组件
│ ├── pages/ # 页面组件（27 个）
│ └── lib/ # 工具函数
├── tests/ # 集成测试
├── run.sh # 启动/停止脚本
├── docker-compose.yml # Docker Compose 部署(单镜像)
├── Dockerfile # 单镜像多阶段构建(前端+后端+gh-ost)
└── kubernetes/ # K8s 部署(install.sh 一键 + 清单)
快速开始
前置要求
- Go 1.26+
- Node.js 18+
- npm 或 yarn
方式一:Docker Compose(推荐,单镜像前后端同源)
git clone https://gitee.com/opsx-tools/opsxsql.git
cd opsxsql
# 生成密钥(必填;SECRET_KEY 部署后不可更换,否则已加密的实例/LDAP 密码无法解密)
export SECRET_KEY=$(openssl rand -hex 32)
# 可选;不设则生产模式自动生成随机 JWT 密钥并持久化到数据卷
export JWT_SECRET=$(openssl rand -hex 32)
docker compose up -d --build
访问 http://localhost:9000(单镜像,Gin 同时托管前端静态资源与 API)。
自定义端口:OPSXSQL_PORT=18000 docker compose up -d。
安全基线:非 root 运行、no-new-privileges、cap_drop ALL、/health 健康检查、资源限额、日志轮转。
方式二:Kubernetes 一键部署
# 默认部署(镜像 opsxsql:latest)
bash kubernetes/install.sh
# 指定镜像 + 入口
IMAGE=registry.example.com/opsxsql:v1.0.0 bash kubernetes/install.sh --nodeport
IMAGE=registry.example.com/opsxsql:v1.1.0 bash kubernetes/install.sh --ingress opsxsql.example.com
install.sh 幂等:自动建命名空间/生成并复用密钥/应用 PVC+Deployment+Service,等待就绪后打印访问方式。
注意:SQLite 单写者,Deployment 固定 单副本 + Recreate(脚本已内置);详见 kubernetes/README.md。
方式三:本地开发
./run.sh start # 后端 9000 + 前端 5173
后端 http://localhost:9000,前端 dev server http://localhost:5173(vite 代理 /api)。
默认账号
首次启动自动初始化以下账号（密码均为 admin123）：
| 用户名 | 角色 | 说明 |
|---|---|---|
| admin | admin | 超级管理员 |
| dba | dba | 数据库管理员 |
| auditor | auditor | 审计员（只读） |
| developer | developer | 开发者 |
测试
# 后端集成测试
cd tests
pip install pytest pytest-asyncio httpx
pytest -v
# 前端类型检查
cd frontend
npx tsc --noEmit
首次部署获取默认账号密码
首次启动会生成 16 位随机密码（不再固定 admin123），以下默认账号共用该密码：
| 账号 | 角色 | 说明 |
|---|---|---|
admin |
超级管理员 | 全权限 |
dba |
DBA管理员 | 数据库实例与变更 |
auditor |
审计员 | 审核工单 |
developer |
开发者 | 提交 SQL 工单 |
密码同时：
- 打印到启动日志（仅首次，日志轮转后就没了）
- 写入数据目录
initial-admin-password.txt（权限0600）
获取方式（推荐第 1 种）
# Docker Compose
docker compose exec <服务名> cat /app/data/initial-admin-password.txt
docker compose logs <服务名> | grep -A8 "已创建默认账号"
docker cp <容器名>:/app/data/initial-admin-password.txt ./
# Kubernetes
kubectl -n sql exec deploy/opsxsql -- cat /app/data/initial-admin-password.txt
kubectl -n sql logs deploy/opsxsql | grep -A8 "已创建默认账号"
kubectl -n sql cp <pod>:/app/data/initial-admin-password.txt ./
自定义密码（跳过随机生成）
# Docker Compose：部署前设置
export ADMIN_INIT_PASSWORD='your-strong-password'
docker compose up -d
# Kubernetes：在 deployment env 中加 ADMIN_INIT_PASSWORD（或用 Secret 注入）
说明
| 项 | 说明 |
|---|---|
| 幂等 | 已存在同名账号时不重建、不改密码；只有缺失的账号才创建 |
| 生成失败 | 随机密码生成失败时直接退出，不降级到公开默认口令 |
| 轮转 | 本平台暂无自助改密接口；改密请用管理员 POST /api/v1/users/:id/reset-password |
| 清理 | 确认所有账号改密后可删除 initial-admin-password.txt |
版本历史
| 版本 | 说明 |
|---|---|
| v0.4.0 | 弹框架构重构 + 审核规则 API + LDAP 配置 + 全量 seed |
| v0.3.2 | 通知渠道对接 + TicketCreatePage 重写 + 默认用户初始化 |
| v0.3.1 | Go 后端迁移 + 工单审批流程 + 实例管理 |
| v0.2.0 | 前端 UI 重构 + shadcn/ui 组件化 |
| v0.1.0 | 项目初始化 + 基础 CRUD |
代码统计
- 后端 Go：29 文件，8,000+ 行
- 前端 TypeScript：131 文件，27,000+ 行
- 集成测试：21 文件，1,100+ 行
- 总计 36,000+ 行
许可证
MIT License