all-project/docs/部署文档

部署文档目录

目录说明

此目录用于存放项目的部署相关文档，包括环境配置、部署脚本、运维手册等。

🚀 快速导航

生产环境双机部署方案（推荐）

• 生产环境双机部署方案.md - 完整的双机高可用部署方案
• 生产环境双机部署方案/ - 部署脚本和配置文件
  • 包含：初始化脚本、MySQL主从配置、Redis主从配置、健康检查脚本、Nginx负载均衡配置等

其他部署文档

• web前端生产环境部署指南.md - Web前端部署指南
• mobile-deployment-guide.md - 移动端部署指南
• 杭州第一技师部署文档/ - 多实例部署说明

1. 环境配置文档

开发环境

• 开发环境搭建指南.md：本地开发环境搭建详细步骤
• 开发环境配置清单.md：开发环境所需软件和版本
• 开发环境故障排查.md：常见开发环境问题解决

测试环境

• 测试环境部署指南.md：测试环境部署步骤
• 测试环境配置文件.md：测试环境配置参数
• 测试数据初始化.md：测试数据准备和初始化

生产环境

• 生产环境部署指南.md：生产环境部署详细步骤
• 生产环境配置优化.md：生产环境配置优化方案
• 生产环境安全配置.md：生产环境安全配置要求

2. 容器化部署

Docker 部署

• Docker 镜像构建.md：Docker 镜像构建指南
• Docker Compose 部署.md：使用 Docker Compose 部署
• Docker 网络配置.md：Docker 网络和存储配置
• Docker 镜像优化.md：Docker 镜像优化策略

Kubernetes 部署

• K8s 集群搭建.md：Kubernetes 集群搭建
• K8s 应用部署.md：应用在 K8s 中的部署
• K8s 配置管理.md：ConfigMap 和 Secret 管理
• K8s 监控配置.md：K8s 集群监控配置

部署脚本示例：

# docker-compose.yml 示例
version: "3.8"
services:
    app:
        build: .
        ports:
            - "8080:8080"
        environment:
            - SPRING_PROFILES_ACTIVE=prod
        depends_on:
            - mysql
            - redis

    mysql:
        image: mysql:8.0
        environment:
            MYSQL_ROOT_PASSWORD: password
            MYSQL_DATABASE: ruoyi
        volumes:
            - mysql_data:/var/lib/mysql

    redis:
        image: redis:7.0
        command: redis-server --requirepass password

volumes:
    mysql_data:

3. 自动化部署

CI/CD 配置

• Jenkins 部署流水线.md：Jenkins 自动化部署配置
• GitLab CI 部署.md：GitLab CI/CD 配置
• GitHub Actions 部署.md：GitHub Actions 自动化部署

部署脚本

• 自动化部署脚本.md：shell 脚本自动化部署
• 滚动更新脚本.md：应用滚动更新脚本
• 回滚脚本.md：快速回滚脚本
• 健康检查脚本.md：部署后健康检查

流水线示例：

# .gitlab-ci.yml 示例
stages:
    - build
    - test
    - deploy

build:
    stage: build
    script:
        - mvn clean package -DskipTests
    artifacts:
        paths:
            - target/*.jar

test:
    stage: test
    script:
        - mvn test

deploy:
    stage: deploy
    script:
        - docker build -t app:$CI_COMMIT_SHA .
        - docker push app:$CI_COMMIT_SHA
        - kubectl set image deployment/app app=app:$CI_COMMIT_SHA
    only:
        - main

4. 数据库部署

数据库安装配置

• MySQL 安装配置.md：MySQL 数据库安装和配置
• Redis 安装配置.md：Redis 缓存安装和配置
• 数据库集群配置.md：数据库集群配置

数据库迁移

• 数据库初始化.md：数据库初始化脚本
• 数据迁移指南.md：数据库迁移步骤
• 数据备份恢复.md：数据备份和恢复策略

数据库优化

• MySQL 性能优化.md：MySQL 性能调优
• Redis 优化配置.md：Redis 性能优化
• 数据库监控.md：数据库监控和告警

5. 负载均衡和反向代理

Nginx 配置

• Nginx 安装配置.md：Nginx 安装和基础配置
• 负载均衡配置.md：Nginx 负载均衡配置
• SSL 证书配置.md：HTTPS 证书配置
• 静态资源优化.md：静态资源缓存和压缩

高可用配置

• Keepalived 配置.md：高可用负载均衡配置
• HAProxy 配置.md：HAProxy 负载均衡配置
• 故障转移配置.md：自动故障转移配置

6. 监控和告警

监控系统

• Prometheus 监控.md：Prometheus 监控配置
• Grafana 仪表板.md：Grafana 监控仪表板
• ELK 日志系统.md：ELK 日志收集和分析
• APM 监控.md：应用性能监控

告警配置

• 告警规则配置.md：监控告警规则配置
• 邮件告警配置.md：邮件告警配置
• 钉钉告警配置.md：钉钉群告警配置
• 告警处理流程.md：告警处理流程和规范

7. 安全配置

安全加固

• 系统安全加固.md：操作系统安全加固
• 应用安全配置.md：应用层安全配置
• 网络安全配置.md：网络安全和防火墙配置
• 数据安全配置.md：数据加密和访问控制

证书管理

• SSL 证书管理.md：SSL 证书申请和管理
• 证书自动更新.md：证书自动更新配置
• 证书监控告警.md：证书过期监控告警

8. 备份和恢复

备份策略

• 数据备份策略.md：数据库备份策略
• 文件备份策略.md：应用文件备份策略
• 配置备份策略.md：配置文件备份策略
• 备份验证流程.md：备份有效性验证

灾难恢复

• 灾难恢复计划.md：灾难恢复预案
• 数据恢复步骤.md：数据恢复详细步骤
• 应用恢复步骤.md：应用服务恢复步骤
• 恢复测试计划.md：定期恢复测试计划

9. 性能调优

应用性能调优

• JVM 参数调优.md：Java 虚拟机参数调优
• 连接池优化.md：数据库连接池优化
• 缓存优化.md：Redis 缓存优化策略
• GC 调优.md：垃圾回收器调优

系统性能调优

• 操作系统调优.md：Linux 系统性能调优
• 网络调优.md：网络参数调优
• 存储调优.md：磁盘 I/O 性能调优

10. 运维手册

日常运维

• 日常巡检清单.md：系统日常巡检项目
• 性能监控指标.md：关键性能指标监控
• 日志分析手册.md：系统日志分析方法
• 故障排查手册.md：常见故障排查步骤

应急处理

• 应急响应流程.md：系统故障应急响应流程
• 故障处理预案.md：各类故障处理预案
• 服务降级方案.md：系统负载过高时的降级方案
• 数据恢复预案.md：数据丢失或损坏恢复预案

变更管理

• 变更申请流程.md：系统变更申请流程
• 变更风险评估.md：变更风险评估标准
• 变更回滚计划.md：变更失败回滚计划
• 变更后验证.md：变更后系统验证清单

11. 环境清单

软件版本清单

操作系统: CentOS 7+ / Ubuntu 18.04+
Java: OpenJDK 17/21
Maven: 3.6+
Node.js: 16+
MySQL: 8.0+
Redis: 6.0+
Nginx: 1.18+
Docker: 20.10+

硬件配置建议

开发环境:
  CPU: 4核+
  内存: 8GB+
  存储: 100GB+

测试环境:
  CPU: 8核+
  内存: 16GB+
  存储: 500GB+

生产环境:
  CPU: 16核+
  内存: 32GB+
  存储: 1TB+
  网络: 1Gbps+

端口规划

应用服务: 8080
数据库: 3306
Redis: 6379
Nginx: 80, 443
监控: 9090, 3000

12. 部署检查清单

部署前检查

• 服务器资源充足
• 网络连通性正常
• 域名解析配置
• SSL 证书准备
• 数据库初始化
• 配置文件检查
• 备份计划确认

部署后验证

• 应用启动正常
• 健康检查通过
• 核心功能验证
• 性能指标正常
• 日志输出正常
• 监控告警正常
• 备份任务正常

注意事项

1. 所有密码和密钥必须加密存储
2. 生产环境配置需要经过安全审核
3. 部署过程需要详细记录和备份
4. 关键操作需要双人确认
5. 部署后需要进行全面的功能验证
6. 必须有完整的回滚方案