create-dp-koa 1.0.0

package/template/docs/ENTERPRISE_DEPLOYMENT_GUIDE.md

@@ -0,0 +1,547 @@
+# 🏢 企业级应用部署指南
+
+## 📋 目录
+
+- [概述](#概述)
+- [环境要求](#环境要求)
+- [Docker部署](#docker部署)
+- [Kubernetes部署](#kubernetes部署)
+- [监控配置](#监控配置)
+- [安全配置](#安全配置)
+- [性能优化](#性能优化)
+- [故障排除](#故障排除)
+
+## 🎯 概述
+
+本指南提供了dp-koa-framework企业级应用的完整部署方案，包括容器化部署、负载均衡、监控告警、安全防护等企业级特性。
+
+## 🔧 环境要求
+
+### 最低要求
+- **Node.js**: 18.x 或更高版本
+- **内存**: 2GB RAM
+- **CPU**: 2核心
+- **存储**: 10GB 可用空间
+
+### 推荐配置
+- **Node.js**: 18.x LTS
+- **内存**: 8GB RAM
+- **CPU**: 4核心
+- **存储**: 50GB SSD
+- **PM2**: 进程管理器
+
+### 依赖服务
+- **MySQL**: 8.0 或更高版本
+- **Redis**: 7.0 或更高版本
+- **Nginx**: 1.20 或更高版本
+
+## 🐳 Docker部署
+
+### 1. 构建镜像
+
+```bash
+# 构建应用镜像
+docker build -t dp-koa-framework:latest .
+
+# 查看镜像
+docker images dp-koa-framework
+```
+
+### 2. 单容器运行
+
+```bash
+# 运行应用容器
+docker run -d \
+  --name dp-koa-app \
+  -p 3000:3000 \
+  -e NODE_ENV=production \
+  -e ENABLE_CLUSTER=true \
+  -e DB_HOST=your-mysql-host \
+  -e DB_PASSWORD=your-password \
+  dp-koa-framework:latest
+```
+
+### 3. Docker Compose部署
+
+```bash
+# 启动完整服务栈
+docker-compose up -d
+
+# 查看服务状态
+docker-compose ps
+
+# 查看日志
+docker-compose logs -f app
+
+# 停止服务
+docker-compose down
+```
+
+### 4. PM2进程管理
+
+```bash
+# 安装PM2
+npm install -g pm2
+
+# 启动应用
+pm2 start dist/bundle.js --name "dp-koa-framework"
+
+# 查看进程状态
+pm2 status
+
+# 查看日志
+pm2 logs dp-koa-framework
+
+# 重启应用
+pm2 restart dp-koa-framework
+
+# 停止应用
+pm2 stop dp-koa-framework
+```
+
+### 5. 服务验证
+
+```bash
+# 健康检查
+curl http://localhost:3000/health
+
+# 指标监控
+curl http://localhost:3000/metrics
+```
+
+## ☸️ Kubernetes部署
+
+### 1. 创建命名空间
+
+```yaml
+apiVersion: v1
+kind: Namespace
+metadata:
+  name: dp-koa-framework
+```
+
+### 2. 配置ConfigMap
+
+```yaml
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: app-config
+  namespace: dp-koa-framework
+data:
+  NODE_ENV: "production"
+  ENABLE_CLUSTER: "true"
+  WORKER_COUNT: "4"
+  LOG_LEVEL: "info"
+  DB_HOST: "mysql-service"
+  REDIS_HOST: "redis-service"
+```
+
+### 3. 部署应用
+
+```yaml
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: dp-koa-app
+  namespace: dp-koa-framework
+spec:
+  replicas: 3
+  selector:
+    matchLabels:
+      app: dp-koa-app
+  template:
+    metadata:
+      labels:
+        app: dp-koa-app
+    spec:
+      containers:
+      - name: app
+        image: dp-koa-framework:latest
+        ports:
+        - containerPort: 3000
+        envFrom:
+        - configMapRef:
+            name: app-config
+        resources:
+          requests:
+            memory: "512Mi"
+            cpu: "250m"
+          limits:
+            memory: "1Gi"
+            cpu: "500m"
+        livenessProbe:
+          httpGet:
+            path: /live
+            port: 3000
+          initialDelaySeconds: 30
+          periodSeconds: 10
+        readinessProbe:
+          httpGet:
+            path: /ready
+            port: 3000
+          initialDelaySeconds: 5
+          periodSeconds: 5
+```
+
+### 4. 服务暴露
+
+```yaml
+apiVersion: v1
+kind: Service
+metadata:
+  name: dp-koa-service
+  namespace: dp-koa-framework
+spec:
+  selector:
+    app: dp-koa-app
+  ports:
+  - port: 80
+    targetPort: 3000
+  type: LoadBalancer
+```
+
+### 5. 水平Pod自动扩缩容
+
+```yaml
+apiVersion: autoscaling/v2
+kind: HorizontalPodAutoscaler
+metadata:
+  name: dp-koa-hpa
+  namespace: dp-koa-framework
+spec:
+  scaleTargetRef:
+    apiVersion: apps/v1
+    kind: Deployment
+    name: dp-koa-app
+  minReplicas: 3
+  maxReplicas: 10
+  metrics:
+  - type: Resource
+    resource:
+      name: cpu
+      target:
+        type: Utilization
+        averageUtilization: 70
+  - type: Resource
+    resource:
+      name: memory
+      target:
+        type: Utilization
+        averageUtilization: 80
+```
+
+## 📊 监控配置
+
+### 1. Prometheus配置
+
+```yaml
+# prometheus.yml
+global:
+  scrape_interval: 15s
+
+scrape_configs:
+  - job_name: 'dp-koa-framework'
+    static_configs:
+      - targets: ['app:3000']
+    metrics_path: '/metrics'
+    scrape_interval: 5s
+```
+
+### 2. Grafana仪表板
+
+```json
+{
+  "dashboard": {
+    "title": "DP-Koa Framework监控",
+    "panels": [
+      {
+        "title": "HTTP请求率",
+        "type": "graph",
+        "targets": [
+          {
+            "expr": "rate(http_requests_total[5m])",
+            "legendFormat": "{{method}} {{route}}"
+          }
+        ]
+      },
+      {
+        "title": "内存使用",
+        "type": "graph",
+        "targets": [
+          {
+            "expr": "memory_usage_bytes{type=\"heap_used\"}",
+            "legendFormat": "堆内存使用"
+          }
+        ]
+      },
+      {
+        "title": "PM2进程状态",
+        "type": "stat",
+        "targets": [
+          {
+            "expr": "up{job=\"dp-koa-framework\"}",
+            "legendFormat": "服务状态"
+          }
+        ]
+      }
+    ]
+  }
+}
+```
+
+### 3. 告警规则
+
+```yaml
+# alert-rules.yml
+groups:
+- name: dp-koa-framework
+  rules:
+  - alert: HighErrorRate
+    expr: rate(errors_total[5m]) > 0.1
+    for: 2m
+    labels:
+      severity: warning
+    annotations:
+      summary: "错误率过高"
+      description: "应用错误率超过阈值"
+
+  - alert: HighMemoryUsage
+    expr: memory_usage_bytes{type="heap_used"} > 500000000
+    for: 5m
+    labels:
+      severity: critical
+    annotations:
+      summary: "内存使用过高"
+      description: "应用内存使用超过500MB"
+
+  - alert: ServiceDown
+    expr: up{job="dp-koa-framework"} == 0
+    for: 1m
+    labels:
+      severity: critical
+    annotations:
+      summary: "服务不可用"
+      description: "应用服务完全不可用"
+```
+
+## 🔒 安全配置
+
+### 1. 网络安全
+
+```yaml
+# NetworkPolicy
+apiVersion: networking.k8s.io/v1
+kind: NetworkPolicy
+metadata:
+  name: dp-koa-network-policy
+  namespace: dp-koa-framework
+spec:
+  podSelector:
+    matchLabels:
+      app: dp-koa-app
+  policyTypes:
+  - Ingress
+  - Egress
+  ingress:
+  - from:
+    - namespaceSelector:
+        matchLabels:
+          name: ingress-nginx
+    ports:
+    - protocol: TCP
+      port: 3000
+  egress:
+  - to:
+    - namespaceSelector:
+        matchLabels:
+          name: mysql
+    ports:
+    - protocol: TCP
+      port: 3306
+  - to:
+    - namespaceSelector:
+        matchLabels:
+          name: redis
+    ports:
+    - protocol: TCP
+      port: 6379
+```
+
+### 2. 安全上下文
+
+```yaml
+securityContext:
+  runAsNonRoot: true
+  runAsUser: 1001
+  runAsGroup: 1001
+  fsGroup: 1001
+  capabilities:
+    drop:
+    - ALL
+```
+
+### 3. 密钥管理
+
+```yaml
+apiVersion: v1
+kind: Secret
+metadata:
+  name: app-secrets
+  namespace: dp-koa-framework
+type: Opaque
+data:
+  DB_PASSWORD: <base64-encoded-password>
+  JWT_SECRET: <base64-encoded-secret>
+  REDIS_PASSWORD: <base64-encoded-redis-password>
+```
+
+## ⚡ 性能优化
+
+### 1. 资源限制
+
+```yaml
+resources:
+  requests:
+    memory: "512Mi"
+    cpu: "250m"
+  limits:
+    memory: "1Gi"
+    cpu: "500m"
+```
+
+### 2. 缓存优化
+
+```yaml
+# Redis配置优化
+redis:
+  image: redis:7-alpine
+  command: >
+    redis-server
+    --maxmemory 256mb
+    --maxmemory-policy allkeys-lru
+    --save 900 1
+    --save 300 10
+    --save 60 10000
+```
+
+### 3. 数据库优化
+
+```yaml
+# MySQL配置优化
+mysql:
+  image: mysql:8.0
+  command: >
+    mysqld
+    --innodb-buffer-pool-size=256M
+    --innodb-log-file-size=64M
+    --max-connections=200
+    --query-cache-size=32M
+```
+
+## 🚨 故障排除
+
+### 1. 常见问题
+
+#### 应用启动失败
+```bash
+# 检查日志
+kubectl logs -f deployment/dp-koa-app
+
+# 检查配置
+kubectl describe configmap app-config
+
+# 检查资源
+kubectl top pods -l app=dp-koa-app
+```
+
+#### 数据库连接问题
+```bash
+# 检查数据库状态
+kubectl exec -it mysql-pod -- mysql -u root -p -e "SHOW PROCESSLIST;"
+
+# 检查网络连接
+kubectl exec -it app-pod -- nc -zv mysql-service 3306
+```
+
+#### 内存泄漏
+```bash
+# 检查内存使用
+kubectl exec -it app-pod -- ps aux
+
+# 生成堆转储
+kubectl exec -it app-pod -- node --inspect=0.0.0.0:9229
+```
+
+### 2. 监控指标
+
+#### 关键指标
+- **QPS**: 每秒请求数
+- **响应时间**: 平均响应时间
+- **错误率**: 错误请求比例
+- **内存使用**: 堆内存使用量
+- **CPU使用**: CPU使用率
+- **数据库连接**: 活跃连接数
+
+#### 告警阈值
+- **错误率**: > 1%
+- **响应时间**: > 2秒
+- **内存使用**: > 80%
+- **CPU使用**: > 80%
+- **数据库连接**: > 80%
+
+### 3. 应急响应
+
+#### 服务降级
+```bash
+# 减少副本数
+kubectl scale deployment dp-koa-app --replicas=1
+
+# 启用维护模式
+kubectl patch deployment dp-koa-app -p '{"spec":{"template":{"spec":{"containers":[{"name":"app","env":[{"name":"MAINTENANCE_MODE","value":"true"}]}]}}}}'
+```
+
+#### 回滚部署
+```bash
+# 查看部署历史
+kubectl rollout history deployment/dp-koa-app
+
+# 回滚到上一版本
+kubectl rollout undo deployment/dp-koa-app
+
+# 回滚到指定版本
+kubectl rollout undo deployment/dp-koa-app --to-revision=2
+```
+
+## 📈 扩展性
+
+### 1. 水平扩展
+- 增加Pod副本数
+- 配置HPA自动扩缩容
+- 使用多可用区部署
+- PM2集群模式
+
+### 2. 垂直扩展
+- 增加CPU和内存限制
+- 优化应用代码性能
+- 使用更强大的硬件
+
+### 3. 功能扩展
+- 添加新的监控指标
+- 集成更多外部服务
+- 实现微服务架构
+
+## 📚 最佳实践
+
+1. **资源管理**: 合理设置资源请求和限制
+2. **监控告警**: 建立完善的监控和告警体系
+3. **安全防护**: 实施多层安全防护策略
+4. **备份恢复**: 定期备份数据和配置
+5. **文档维护**: 保持部署文档的更新
+6. **测试验证**: 在生产部署前进行充分测试
+7. **版本管理**: 使用版本标签管理镜像
+8. **日志管理**: 集中化日志收集和分析
+
+通过遵循本指南，您可以成功部署和维护一个企业级的dp-koa-framework应用，确保其高可用性、高性能和高安全性。
+
+