Files

Wang Defa 71d487c59a docs: 从 README 中移除 llmdoc 相关内容

## 修改原因

llmdoc/ 目录已在 .gitignore 中被忽略，不应在 README 中引用。

## 变更内容

### 移除的章节

1. **项目结构**：移除 llmdoc/ 目录及其子目录说明
2. **📖 文档**：移除整个文档章节（包含 7 个 llmdoc 链接）
3. **编码规范**：移除指向 llmdoc/reference/coding-conventions.md 的链接

### 保留的内容

- ✅ 公共库文档链接（common/README.md）
- ✅ 远程加载文档链接（examples/REMOTE_LOADER_README.md）
- ✅ 所有其他功能和使用说明

## 影响

- 文档更加简洁，只包含版本控制中的内容
- 用户可通过 common/ 和 examples/ 目录中的文档获取详细信息
- 与 .gitignore 配置保持一致

2025-12-26 15:04:57 +08:00

8.9 KiB

Raw Blame History

云计算和系统管理工具集

一个跨云平台和 Linux 系统管理的自动化脚本工具集

📋 项目简介

该工具集为系统管理员、云工程师和 DevOps 人员提供一站式的自动化管理解决方案，简化云基础设施管理、系统配置和部署流程。

✨ 核心特性

🌐 跨云平台支持：GCP、Oracle Cloud Infrastructure (OCI)
🔧 系统管理自动化：RAID、磁盘分区、环境配置
📦 模块化设计：可重用的公共库和独立脚本
🚀 远程加载支持：脚本可独立运行，无需本地依赖
📝 统一规范：标准化的命名、日志和错误处理
🎨 友好输出：彩色终端输出和详细日志

🗂️ 项目结构

tools/
├── gcp/                    # Google Cloud Platform 工具
│   ├── create_ai_projects.sh      # 批量创建 AI 项目
│   └── delete_all_projects.sh     # 批量删除项目
├── oci/                    # Oracle Cloud Infrastructure 工具
│   └── create_instance.sh         # 批量部署虚拟机
├── linux/                  # Linux 系统管理工具
│   ├── create_raid0_array.sh      # 创建 RAID 0 阵列
│   ├── repartition_disks.sh       # 重新分区磁盘
│   └── install_oh_my_zsh.sh       # 安装 Oh My Zsh
├── common/                 # 公共函数库
│   ├── logging.sh                 # 日志系统
│   ├── error_handler.sh           # 错误处理
│   ├── remote_loader.sh           # 远程加载器
│   ├── demo_usage.sh              # 功能演示
│   └── README.md                  # 库文档
└── examples/               # 使用示例
    ├── remote_example.sh          # 纯远程模式示例
    ├── hybrid_loader_template.sh  # 混合模式模板
    └── REMOTE_LOADER_README.md    # 远程加载文档

🚀 快速开始

前置要求

Bash 4.0+
curl 或 wget（用于远程加载）
对应云平台的 CLI 工具（gcloud、oci-cli 等）

基本使用

1. 本地模式（默认）

克隆仓库后直接运行：

git clone https://gitea.bcde.io/wangdefa/tools.git
cd tools

# 运行 Linux 工具
sudo ./linux/create_raid0_array.sh

# 运行 GCP 工具
./gcp/create_ai_projects.sh -n 5 --prefix my-project

# 运行 OCI 工具
./oci/create_instance.sh -n 3 --shape VM.Standard.A1.Flex

2. 远程模式（独立运行）

无需克隆仓库，直接下载并运行：

# 下载并运行 RAID 创建脚本
curl -fsSL https://gitea.bcde.io/wangdefa/tools/raw/branch/main/linux/create_raid0_array.sh | bash

# 或使用 wget
wget -qO- https://gitea.bcde.io/wangdefa/tools/raw/branch/main/linux/create_raid0_array.sh | bash

3. 强制远程模式

在本地环境中强制使用远程库（获取最新版本）：

FORCE_REMOTE=1 ./linux/create_raid0_array.sh

📦 功能模块

GCP 管理工具

create_ai_projects.sh - 批量创建 AI 项目

批量创建 Google Cloud AI Platform 项目并配置相关服务。

./gcp/create_ai_projects.sh -n 10 --prefix ml-project --region us-central1

主要功能：

批量创建项目
自动启用 AI Platform API
配置项目计费
设置项目权限

delete_all_projects.sh - 批量删除项目

批量删除 Google Cloud 项目（带保护机制）。

./gcp/delete_all_projects.sh --prefix ml-project --confirm

安全特性：

二次确认机制
排除生产项目
详细删除日志

OCI 管理工具

create_instance.sh - 批量部署虚拟机

在 Oracle Cloud 上批量创建和配置虚拟机实例。

./oci/create_instance.sh -n 5 \
    --shape VM.Standard.A1.Flex \
    --shape_config 2+12 \
    --image_name "Canonical-Ubuntu-20.04-aarch64-2025.05.20-0"

功能特性：

自动创建 VCN 和子网
IPv4/IPv6 双栈支持
自定义实例规格
自动配置 SSH 访问
密码自动生成和标签记录

Linux 系统管理工具

create_raid0_array.sh - 创建 RAID 0 阵列

自动创建并挂载 RAID 0 存储阵列。

sudo ./linux/create_raid0_array.sh

功能：

自动检测可用磁盘
创建 RAID 0 阵列
格式化为 ext4
配置自动挂载

repartition_disks.sh - 重新分区磁盘

删除所有非系统盘的分区并创建新的 GPT 分区表。

sudo ./linux/repartition_disks.sh

安全特性：

自动识别系统盘并排除
逐个磁盘处理
详细操作日志

install_oh_my_zsh.sh - 安装 Oh My Zsh

一键安装和配置 Oh My Zsh 开发环境。

./linux/install_oh_my_zsh.sh

配置项：

自动安装 Zsh
配置 Oh My Zsh
安装常用插件
切换默认 Shell

🌐 远程库加载

所有脚本支持智能远程库加载机制，可在无本地依赖的情况下运行。

加载策略

FORCE_REMOTE=1 → 强制使用远程库
本地库存在 → 优先使用本地（默认）
本地不存在 → 自动回退远程
远程失败 → 友好错误提示

环境变量

变量	说明	默认值
`REMOTE_LIB_URL`	远程仓库 URL	`https://gitea.bcde.io/wangdefa/tools/raw/branch/main`
`FORCE_REMOTE`	强制使用远程库	`0`

使用示例

# 使用本地库（默认）
./linux/create_raid0_array.sh

# 强制使用远程库
FORCE_REMOTE=1 ./linux/create_raid0_array.sh

# 使用自定义仓库 URL
REMOTE_LIB_URL=https://example.com/repo ./script.sh

# 完全独立运行（无需克隆）
curl -fsSL https://gitea.bcde.io/wangdefa/tools/raw/branch/main/linux/create_raid0_array.sh | bash

详细文档：examples/REMOTE_LOADER_README.md

📚 公共库

logging.sh - 日志系统

提供统一的日志输出功能，支持多级别和彩色输出。

source common/logging.sh

log_debug "调试信息"
log_info "普通信息"
log_warning "警告信息"
log_error "错误信息（不退出）"
log_success "成功信息"

功能：

5 个日志级别（DEBUG/INFO/WARNING/ERROR/SUCCESS）
彩色终端输出
时间戳支持
日志文件输出

error_handler.sh - 错误处理

提供错误检查和命令执行辅助函数。

source common/error_handler.sh

check_command "jq"                    # 检查命令是否存在
check_file "/path/to/file"            # 检查文件是否存在
check_not_empty "$var" "var_name"     # 检查变量非空
check_return $? "操作失败"             # 检查返回码

run_command "描述" command args       # 执行命令并检查结果
retry_command 3 2 "失败" command      # 重试执行命令

详细文档：common/README.md

🔧 开发

编码规范

本项目遵循严格的 Bash 编码规范：

命名规范：snake_case（函数、变量、文件）
文件命名：动词_名词.sh（如 create_raid0_array.sh）
函数注释：使用标准化的文档注释格式
错误处理：使用 set -euo pipefail 严格模式
代码风格：4 空格缩进，ShellCheck 检查

添加新脚本

参考 examples/hybrid_loader_template.sh 创建脚本
添加远程库加载支持
使用公共库函数
遵循命名和注释规范
执行 shellcheck 检查
更新文档

测试

# 语法检查
bash -n script.sh

# ShellCheck 检查
shellcheck script.sh

# 功能测试
./common/demo_usage.sh

🤝 贡献

欢迎贡献代码、报告问题或提出建议！

Fork 本仓库
创建特性分支 (git checkout -b feature/amazing-feature)
提交更改 (git commit -m 'feat: add amazing feature')
推送到分支 (git push origin feature/amazing-feature)
创建 Pull Request

📝 更新日志

v2.1.0 (2025-01-XX)

✨ 新增远程库加载支持
✨ 新增混合加载模式（本地优先 + 远程回退）
✨ 新增环境变量配置（FORCE_REMOTE、REMOTE_LIB_URL）
📝 完善文档系统
🔧 统一文件命名规范

v2.0.0 (2025-01-XX)

✨ 重构所有脚本使用公共库
✨ 新增统一日志系统
✨ 新增错误处理机制
📝 添加完整的函数注释
🐛 修复 Bash 兼容性问题

📄 许可证

本项目采用 MIT 许可证 - 详见 LICENSE 文件

👥 作者

Cloud Tools Project

🔗 相关链接

仓库地址: https://gitea.bcde.io/wangdefa/tools
问题反馈: https://gitea.bcde.io/wangdefa/tools/issues
在线文档: https://gitea.bcde.io/wangdefa/tools/wiki

⭐ 如果这个项目对你有帮助，请给我们一个星标！

8.9 KiB Raw Blame History Unescape Escape