e776084312
- 新增开发指南文档，包含环境设置、构建流程和最佳实践 - 添加项目概览文档，提供项目全面介绍和架构说明 - 创建技术栈分析文档，详细说明使用的技术和依赖 - 添加源树分析文档，解释项目目录结构和关键文件 - 创建文档索引页面，统一管理所有项目文档 - 生成项目扫描报告，记录文档生成过程 - 更新工作流状态配置，指定文档化前提条件 - 添加.gitignore规则，忽略NFS相关文件
150 lines
3.3 KiB
Markdown
150 lines
3.3 KiB
Markdown
# 项目文档索引
|
||
|
||
## 项目概述
|
||
|
||
### 基本信息
|
||
- **项目名称**: Alibaba Cloud ECI Provider for Virtual Kubelet
|
||
- **项目类型**: CLI工具 (单体架构)
|
||
- **主要语言**: Go
|
||
- **架构模式**: Virtual Kubelet Provider
|
||
|
||
### 快速参考
|
||
- **技术栈**: Go + Virtual Kubelet + 阿里云ECI API
|
||
- **入口点**: `cmd/virtual-kubelet/main.go`
|
||
- **架构模式**: Provider适配器模式
|
||
|
||
## 生成的文档
|
||
|
||
### 核心文档
|
||
- [项目概览](./project-overview.md) - 项目全面介绍
|
||
- [技术栈分析](./technology-stack.md) - 详细技术栈说明
|
||
- [源树分析](./source-tree-analysis.md) - 项目结构说明
|
||
- [开发指南](./development-guide.md) - 开发环境设置
|
||
|
||
### 架构文档
|
||
- [架构文档](./architecture.md) _(To be generated)_
|
||
|
||
### 组件清单
|
||
- [组件清单](./component-inventory.md) _(To be generated)_
|
||
|
||
### API文档
|
||
- [API合约](./api-contracts.md) _(To be generated)_
|
||
|
||
### 数据模型
|
||
- [数据模型](./data-models.md) _(To be generated)_
|
||
|
||
## 现有文档
|
||
|
||
### 项目文档
|
||
- [README.md](../README.md) - 项目概述和使用说明
|
||
- [CLAUDE.md](../CLAUDE.md) - Claude Code项目指导
|
||
|
||
### 功能文档
|
||
- [ECI文档](./eci.md) - ECI抢占式实例详细文档
|
||
- [产品简介](./product-brief-vk-eci-2025-11-06.md) - 产品需求文档
|
||
|
||
## 快速开始
|
||
|
||
### 环境要求
|
||
- Go 1.13+
|
||
- Git
|
||
- Make
|
||
|
||
### 构建和运行
|
||
```bash
|
||
# 克隆项目
|
||
git clone https://github.com/virtual-kubelet/alibabacloud-eci.git
|
||
cd alibabacloud-eci
|
||
|
||
# 构建
|
||
make build
|
||
|
||
# 运行
|
||
./bin/virtual-kubelet --help
|
||
```
|
||
|
||
### 配置示例
|
||
```toml
|
||
Region = "cn-hangzhou"
|
||
OperatingSystem = "Linux"
|
||
CPU = "20"
|
||
Memory = "100Gi"
|
||
Pods = "20"
|
||
```
|
||
|
||
## 开发资源
|
||
|
||
### 代码结构
|
||
- `cmd/` - 命令行入口
|
||
- `eci/` - ECI客户端实现
|
||
- `eci.go` - 主要Provider实现
|
||
- `config.go` - 配置管理
|
||
|
||
### 构建工具
|
||
- `Makefile` - 自动化构建
|
||
- `Dockerfile` - 容器化构建
|
||
- `.circleci/` - CI/CD配置
|
||
|
||
### 测试
|
||
```bash
|
||
make test # 运行测试
|
||
make vet # 静态分析
|
||
make lint # 代码质量检查
|
||
```
|
||
|
||
## 部署指南
|
||
|
||
### Kubernetes部署
|
||
```yaml
|
||
apiVersion: apps/v1
|
||
kind: DaemonSet
|
||
metadata:
|
||
name: virtual-kubelet
|
||
automountServiceAccountToken: false
|
||
spec:
|
||
selector:
|
||
matchLabels:
|
||
app: virtual-kubelet
|
||
template:
|
||
metadata:
|
||
labels:
|
||
app: virtual-kubelet
|
||
spec:
|
||
containers:
|
||
- name: virtual-kubelet
|
||
image: virtualkubelet/virtual-kubelet:latest
|
||
args:
|
||
- --provider
|
||
- alibabacloud
|
||
- --provider-config
|
||
- /etc/virtual-kubelet/config.toml
|
||
```
|
||
|
||
### 环境变量配置
|
||
```bash
|
||
export ECI_REGION=cn-hangzhou
|
||
export ECI_SECURITY_GROUP=sg-xxx
|
||
export ECI_VSWITCH=vsw-xxx
|
||
export ECI_ACCESS_KEY=your-access-key
|
||
export ECI_SECRET_KEY=your-secret-key
|
||
```
|
||
|
||
## 相关链接
|
||
|
||
### 官方文档
|
||
- [Virtual Kubelet文档](https://github.com/virtual-kubelet/virtual-kubelet)
|
||
- [阿里云ECI文档](https://help.aliyun.com/product/87445.html)
|
||
- [Kubernetes文档](https://kubernetes.io/docs/)
|
||
|
||
### 社区资源
|
||
- [GitHub仓库](https://github.com/virtual-kubelet/alibabacloud-eci)
|
||
- [问题追踪](https://github.com/virtual-kubelet/alibabacloud-eci/issues)
|
||
- [贡献指南](../CONTRIBUTING.md)
|
||
|
||
---
|
||
|
||
*此索引文档是AI辅助开发的主要入口点，提供了项目的全面概览和所有相关文档的链接。*
|
||
|
||
**文档生成时间**: 2025-11-06
|
||
**扫描模式**: 深度扫描
|
||
**工作流版本**: 1.2.0 |