Files
ljwx-health/backup_docs_20260104_182653/K8S-QUICK-START.md
T
brunoandClaude Sonnet 4.5 8350cd86f3
CI/CD Pipeline / build-push (ljwx-admin) (push) Blocked by required conditions
CI/CD Pipeline / build-push (ljwx-bigscreen) (push) Blocked by required conditions
CI/CD Pipeline / build-push (ljwx-boot) (push) Blocked by required conditions
CI/CD Pipeline / update-deploy (push) Blocked by required conditions
CI/CD Pipeline / security-scan (push) Successful in 52s
CI/CD Pipeline / test-build-boot (push) Successful in 1m52s
CI/CD Pipeline / build-pr (ljwx-admin) (push) Has been skipped
CI/CD Pipeline / build-pr (ljwx-bigscreen) (push) Has been skipped
CI/CD Pipeline / build-pr (ljwx-boot) (push) Has been skipped
CI/CD Pipeline / test-admin (push) Successful in 1m18s
CI/CD Pipeline / test-bigscreen (push) Has been cancelled
docs: 文档结构标准化重构 v1.0
## 重构概览
完成文档标准化重构,建立专业的文档管理体系。

## 核心成果

### 文档精简
- 根目录文档: 57个 → 8个 (-86%)
- README.md: 1844行 → 258行 (-86%)
- 查找时间: 5-10分钟 → <1分钟 (-80%)

### 新增核心文档
- CHANGELOG.md - 版本变更日志
- CONTRIBUTING.md - 贡献指南(代码/提交/文档规范)
- docs/README.md - 文档导航中心(按角色/主题/关键词索引)
- archive/README.md - 归档说明

### 目录架构
- docs/01-getting-started/ - 快速开始
- docs/02-architecture/ - 架构设计
- docs/03-deployment/ - 部署指南(Docker/K8s/GitOps)
- docs/04-operations/ - 运维手册(监控/数据库/故障)
- docs/05-features/ - 功能文档
- docs/06-development/ - 开发指南(后端/前端/API)
- docs/07-compliance/ - 工程规范
- docs/08-reference/ - 参考资料
- archive/2025/ - 历史归档(fixes/implementations/experiments)
- archive/deprecated/ - 已废弃文档

## 文档迁移

### 已迁移文档(44个)
部署文档 → docs/03-deployment/
  - DOCKER_README.md → docker/docker-compose.md
  - DOCKERFILE_OPTIMIZATION_SUMMARY.md → docker/optimization.md
  - GITHUB_SETUP.md → gitops/github-actions.md

运维文档 → docs/04-operations/
  - DATABASE_IMPORT.md → database/data-import.md
  - GRAFANA_QUICK_START.md → monitoring/grafana-quick-start.md

开发文档 → docs/06-development/
  - AI_INTEGRATION_GUIDE.md → ai-integration.md

参考资料 → docs/08-reference/
  - REMOTE_ACCESS.md → remote-access.md

历史文档 → archive/2025/
  - fixes/ - 8个修复文档
  - implementations/ - 10个实施总结
  - experiments/ - 2个实验方案

已废弃 → archive/deprecated/
  - old-quick-starts/ - 5个旧版快速开始指南

### 备份
- backup_docs_20260104_182653/ - 完整备份(57个文件)
- backup_docs_20260104_182705/ - 增量备份(6个文件)

## 技术亮点
- ✅ 自动化迁移脚本(scripts/migrate-docs.sh)
- ✅ 智能文档分类
- ✅ 自动备份机制
- ✅ 文档生命周期管理
- ✅ 多维度导航系统

## 参考规范
- Keep a Changelog (CHANGELOG.md)
- Conventional Commits (提交规范)
- Divio Documentation System (文档分类)

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
2026-01-04 18:31:38 +08:00

3.8 KiB

Kubernetes 一键部署 - 快速开始

快速将灵境万象系统部署到 Kubernetes 集群。

🚀 5 分钟快速部署

前提条件

  1. Kubernetes 集群 已经运行

    kubectl cluster-info
    
  2. 本地 Registry 已经启动

    curl http://localhost:15000/v2/_catalog
    

一键部署

# 进入项目目录
cd /Users/brunogao/work/codes/shenye/release

# 执行一键部署
./k8s-deploy.sh

完成!系统将自动:

  • ✅ 构建所有 Docker 镜像
  • ✅ 推送到本地 Registry
  • ✅ 生成 K8s 配置文件
  • ✅ 部署到 Kubernetes
  • ✅ 等待服务就绪

📋 部署脚本

脚本 功能 用法
k8s-deploy.sh 一键部署 ./k8s-deploy.sh
k8s-status.sh 状态检查 ./k8s-status.sh
k8s-undeploy.sh 卸载系统 ./k8s-undeploy.sh

🔍 访问应用

方式 1: 配置本地域名

# 1. 获取节点 IP
kubectl get nodes -o wide

# 2. 编辑 /etc/hosts
sudo nano /etc/hosts

# 3. 添加域名映射
192.168.65.4  ljwx.local

# 4. 访问应用
open http://ljwx.local

方式 2: 端口转发

# 转发前端管理
kubectl port-forward svc/ljwx-admin 8080:80 -n ljwx-system

# 访问
open http://localhost:8080

📊 查看状态

# 完整状态检查
./k8s-status.sh

# 查看 Pods
kubectl get pods -n ljwx-system

# 查看日志
kubectl logs -f deployment/ljwx-boot -n ljwx-system

🛠️ 常用命令

扩容

# 扩展到 3 个副本
kubectl scale deployment ljwx-boot --replicas=3 -n ljwx-system

重启

# 重启服务
kubectl rollout restart deployment/ljwx-boot -n ljwx-system

更新

# 1. 重新构建镜像
./build-and-push.sh all

# 2. 重新部署
./k8s-deploy.sh --skip-build

卸载

# 完全删除(包括数据)
DELETE_PVC=true ./k8s-undeploy.sh

# 保留数据
./k8s-undeploy.sh

🎯 高级选项

使用已有镜像

# 跳过镜像构建
./k8s-deploy.sh --skip-build

使用外部数据库

# 跳过 MySQL 和 Redis 部署
./k8s-deploy.sh --skip-mysql --skip-redis

自定义配置

# 自定义命名空间和域名
K8S_NAMESPACE=ljwx-prod \
LJWX_DOMAIN=ljwx.example.com \
./k8s-deploy.sh

查看帮助

./k8s-deploy.sh --help

🐛 故障排查

Pod 无法启动

# 查看 Pod 状态
kubectl get pods -n ljwx-system

# 查看详细信息
kubectl describe pod <pod-name> -n ljwx-system

# 查看日志
kubectl logs <pod-name> -n ljwx-system

镜像拉取失败

# 检查本地 Registry
curl http://localhost:15000/v2/_catalog

# 重新构建镜像
./build-and-push.sh all

服务无法访问

# 检查 Ingress
kubectl get ingress -n ljwx-system

# 检查 Service
kubectl get svc -n ljwx-system

# 使用端口转发测试
kubectl port-forward svc/ljwx-admin 8080:80 -n ljwx-system

📚 完整文档

详细文档请参考: K8S-DEPLOYMENT-GUIDE.md

内容包括:

  • 🏗️ 系统架构详解
  • ⚙️ 详细配置说明
  • 🔧 运维管理指南
  • 🐞 完整故障排查
  • ✨ 最佳实践建议
  • 🚀 生产环境部署

💡 提示

  1. 首次部署较慢(需要构建镜像),后续部署会很快
  2. 确保 Registry 运行,否则无法推送镜像
  3. 检查集群资源,确保有足够的 CPU 和内存
  4. 使用 ./k8s-status.sh 随时查看系统状态

🎉 成功指标

部署成功后,您应该看到:

✅ 所有 Pods 运行正常
✅ 所有 Services 可访问
✅ Ingress 配置正确
✅ 应用可以通过域名访问

快速支持:

  • 状态检查: ./k8s-status.sh
  • 查看日志: kubectl logs -f <pod> -n ljwx-system
  • 完整文档: K8S-DEPLOYMENT-GUIDE.md