mgmt/scripts
Houzhong Xu e5aa00d6f9
feat: 重构项目脚本结构和文档
docs: 添加API和部署文档
refactor: 重新组织脚本目录结构
fix: 修复Nomad配置中的region设置
chore: 移除过期节点相关配置
test: 更新MCP服务器测试脚本
build: 更新Makefile以适配新脚本路径
2025-10-01 02:08:58 +00:00
..
ci-cd feat: 重构项目脚本结构和文档 2025-10-01 02:08:58 +00:00
deployment feat: 重构项目脚本结构和文档 2025-10-01 02:08:58 +00:00
mcp feat: 重构项目脚本结构和文档 2025-10-01 02:08:58 +00:00
setup feat: 重构项目脚本结构和文档 2025-10-01 02:08:58 +00:00
testing feat: 重构项目脚本结构和文档 2025-10-01 02:08:58 +00:00
utilities feat: 重构项目脚本结构和文档 2025-10-01 02:08:58 +00:00
README.md feat: 重构项目脚本结构和文档 2025-10-01 02:08:58 +00:00
SCRIPT_INDEX.md feat: 重构项目脚本结构和文档 2025-10-01 02:08:58 +00:00

README.md

脚本目录结构说明

本目录包含项目中所有的脚本文件,按功能分类组织。

目录结构

scripts/
├── README.md                    # 本说明文件
├── setup/                       # 环境设置和初始化脚本
│   ├── init/                   # 初始化脚本
│   ├── config/                 # 配置生成脚本
│   └── environment/            # 环境设置脚本
├── deployment/                  # 部署相关脚本
│   ├── vault/                  # Vault部署脚本
│   ├── consul/                 # Consul部署脚本
│   ├── nomad/                  # Nomad部署脚本
│   └── infrastructure/         # 基础设施部署脚本
├── testing/                     # 测试脚本
│   ├── unit/                   # 单元测试
│   ├── integration/            # 集成测试
│   ├── mcp/                    # MCP服务器测试
│   └── infrastructure/         # 基础设施测试
├── utilities/                   # 工具脚本
│   ├── backup/                 # 备份相关
│   ├── monitoring/             # 监控相关
│   ├── maintenance/            # 维护相关
│   └── helpers/                # 辅助工具
├── mcp/                        # MCP服务器相关脚本
│   ├── servers/                # MCP服务器实现
│   ├── configs/                # MCP配置脚本
│   └── tools/                  # MCP工具脚本
└── ci-cd/                      # CI/CD相关脚本
    ├── build/                  # 构建脚本
    ├── deploy/                 # 部署脚本
    └── quality/                # 代码质量检查脚本

脚本命名规范

  • 使用小写字母和连字符分隔
  • 功能明确的前缀:
    • init- : 初始化脚本
    • deploy- : 部署脚本
    • test- : 测试脚本
    • backup- : 备份脚本
    • monitor- : 监控脚本
    • setup- : 设置脚本

使用说明

  1. 所有脚本都应该有执行权限
  2. 脚本应该包含适当的错误处理
  3. 重要操作前应该有确认提示
  4. 脚本应该支持 --help 参数显示使用说明

快速访问

常用脚本的快速访问方式:

# 测试相关
make test                    # 运行所有测试
./scripts/testing/mcp/test-all-mcp-servers.sh

# 部署相关  
./scripts/deployment/vault/deploy-vault-dev.sh
./scripts/deployment/consul/deploy-consul-cluster.sh

# 工具相关
./scripts/utilities/backup/backup-all.sh
./scripts/utilities/monitoring/health-check.sh