Files
QuestionProject/ai_knowledge_base_v2/extracted/10-AI知识库系统部署运维手册_V10.md

399 lines
6.8 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# 10-AI知识库系统部署运维手册_V1.0.docx
10
## AI知识库系统部署运维手册
Deployment & Operations Guide
━━━━━━━━━━━━━━━━━━━━━━━━━━━━
系统部署|环境配置|上线运维|监控备份|故障恢复
## 文档目录
## 第一章 文档说明
### 1.1 编写目的
本文档用于指导系统部署、环境配置、上线、运维、监控、备份及故障恢复。
适用对象:
运维工程师
后端开发工程师
DevOps 工程师
项目实施人员
## 第二章 系统部署架构
### 2.1 总体架构
## 第三章 服务器规划
### 3.1 建议配置(生产环境)
### 3.2 环境要求
LinuxUbuntu LTS 或 CentOS Stream
Docker如采用容器化
MySQL 8.x
Redis 7.x
Nginx 最新稳定版
Git
## 第四章 环境变量配置
建议使用 .env 或配置中心统一管理。
## 第五章 数据库初始化
部署步骤:
1. 创建数据库。
2. 执行建表 SQL。
3. 初始化基础数据。
4. 创建超级管理员。
5. 验证连接。
初始化内容包括:
管理员角色
超级管理员账号
默认 Prompt
默认系统配置
默认模型配置
## 第六章 Redis 使用说明
Redis 用于:
登录验证码缓存
Token 黑名单(如采用)
高频配置缓存(可选)
建议:
开启持久化
设置合理内存上限
定期监控命中率
## 第七章 Nginx 配置建议
建议开启:
HTTPS
HTTP/2如适用
Gzip 压缩
SSE 长连接支持
静态资源缓存
反向代理:
## 第八章 AI 服务配置
启动前检查:
AI API Key 正确
飞书配置正确
Prompt 已初始化
默认模型已启用
启动后验证:
AI 可正常调用
飞书可正常检索
SSE 流式输出正常
## 第九章 上线流程
建议流程:
上线验证重点:
登录
AI 聊天
飞书检索
后台管理
权限控制
## 第十章 日志管理
建议分类:
建议:
日志按天滚动
保留周期可配置
重要日志集中采集(如 ELK、Loki 等)
## 第十一章 数据备份
### 11.1 数据库
建议:
每日增量备份
每周完整备份
异地备份(如有条件)
### 11.2 配置文件
备份:
环境变量
Nginx 配置
系统配置
## 第十二章 系统监控
建议监控:
告警建议:
服务不可用
AI 超时率异常
数据库连接异常
Redis 不可用
HTTPS 证书即将过期
## 第十三章 故障处理
### 13.1 飞书不可用
处理:
1. 检查飞书接口状态
2. 检查 App 凭证
3. 查看 AI 请求日志
4. 重试验证
### 13.2 AI 模型不可用
处理:
1. 检查 API Key
2. 检查模型配置
3. 查看请求日志
4. 必要时切换备用模型(如后续版本支持)
### 13.3 数据库异常
处理:
1. 检查数据库状态
2. 查看慢 SQL
3. 检查磁盘空间
4. 恢复备份(必要时)
## 第十四章 回滚方案
发生重大故障时:
1. 停止新版本服务
2. 恢复上一版本程序
3. 恢复数据库(如涉及数据结构变更)
4. 验证核心功能
5. 恢复对外服务
## 第十五章 运维检查清单
### 15.1 每日检查
☑ 服务运行状态
☑ AI 请求成功率
☑ 飞书接口状态
☑ 数据库运行状态
☑ Redis 状态
☑ 日志是否正常
### 15.2 每周检查
☑ 数据备份验证
☑ 磁盘空间检查
☑ SSL 证书检查
☑ 系统安全更新评估
## 《部署运维手册》V1.0 完成
本手册覆盖了:
系统部署架构
环境配置
数据库初始化
Redis 与 Nginx 配置建议
AI 服务部署
上线流程
日志管理
数据备份
系统监控
故障处理
回滚方案
运维巡检清单
## Table 1
| 项目名称 | AI 企业知识库问答系统 |
| --- | --- |
| 文档版本 | V1.0 |
| 适用版本 | V1.0 |
## Table 2
| 01 | 第一章 文档说明 |
| --- | --- |
| 02 | 第二章 系统部署架构 |
| 03 | 第三章 服务器规划 |
| 04 | 第四章 环境变量配置 |
| 05 | 第五章 数据库初始化 |
| 06 | 第六章 Redis 使用说明 |
| 07 | 第七章 Nginx 配置建议 |
| 08 | 第八章 AI 服务配置 |
| 09 | 第九章 上线流程 |
| 10 | 第十章 日志管理 |
| 11 | 第十一章 数据备份 |
| 12 | 第十二章 系统监控 |
| 13 | 第十三章 故障处理 |
| 14 | 第十四章 回滚方案 |
| 15 | 第十五章 运维检查清单 |
## Table 3
| Internet │ HTTPS / 443 │ Nginx 反向代理 │ ┌─────────────┴─────────────┐ │ │ 用户端H5/Web 管理后台Admin │ │ └─────────────┬─────────────┘ │ Backend API │ ┌─────────────┼─────────────┐ │ │ │ AI Service Redis MySQL │ ▼ 飞书知识库 API + AI 模型 API |
| --- |
## Table 4
| 服务 | CPU | 内存 | 磁盘 |
| --- | --- | --- | --- |
| Nginx | 2 核 | 2 GB | 20 GB |
| Backend | 4 核 | 8 GB | 50 GB |
| AI Service | 4 核 | 8 GB | 50 GB |
| MySQL | 8 核 | 16 GB | 200 GB SSD |
| Redis | 2 核 | 4 GB | 20 GB |
## Table 5
| 配置项 | 说明 |
| --- | --- |
| DB_HOST | 数据库地址 |
| DB_PORT | 数据库端口 |
| DB_NAME | 数据库名称 |
| DB_USER | 数据库账号 |
| DB_PASSWORD | 数据库密码 |
| REDIS_HOST | Redis 地址 |
| REDIS_PORT | Redis 端口 |
| JWT_SECRET | JWT 密钥 |
| FEISHU_APP_ID | 飞书应用 ID |
| FEISHU_APP_SECRET | 飞书密钥 |
| AI_API_URL | AI 接口地址 |
| AI_API_KEY | AI 接口密钥 |
## Table 6
| 安全建议:所有密钥均通过环境变量或密钥管理系统保存,不写入源码仓库。 |
| --- |
## Table 7
| 访问路径 | 代理目标 |
| --- | --- |
| /api/* | Backend |
| /admin/* | 管理后台 |
| / | 用户端 |
## Table 8
| 代码发布 │ 数据库升级 │ 配置环境变量 │ 启动 Redis │ 启动 MySQL │ 启动 Backend │ 启动 AI Service │ 启动 Nginx │ 功能验证 │ 正式开放访问 |
| --- |
## Table 9
| 日志类型 | 内容 |
| --- | --- |
| 应用日志 | 系统运行日志 |
| AI 日志 | AI 请求与响应 |
| 操作日志 | 后台管理员操作 |
| 登录日志 | 登录记录 |
| 错误日志 | 异常与堆栈信息 |
## Table 10
| 指标 | 建议 |
| --- | --- |
| CPU 使用率 | <80% |
| 内存使用率 | <80% |
| MySQL 连接数 | 持续监控 |
| Redis 内存 | 持续监控 |
| AI 请求耗时 | 持续监控 |
| 飞书接口异常率 | 持续监控 |
## Table 11
| 发布要求:所有发布建议保留可回滚版本。 |
| --- |