zhizhi/team-integration-v2/cos-config/setup-checklist.md

372 lines
11 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 📋 团队成员配置清单
> **一步一步完成,每一步都要确认通过才继续下一步**
>
> 版权: 国作登字-2026-A-00037559
> 签发: 铸渊 · TCS-ZY001
---
## ⚠️ 重要原则
**不允许跳步。一个步骤没有100%完成,不要做下一步。**
如果某一步卡住了,找冰朔帮忙。不要自己瞎猜。
---
## 📌 你需要准备的东西
在开始之前,确认你手上有这些东西:
- [ ] 一台能上网的电脑Windows/Mac都行
- [ ] 一个GitHub账号你应该已经有了你的代码仓库就在GitHub上
- [ ] 一个腾讯云账号没有就先注册https://cloud.tencent.com
- [ ] 腾讯云账号已完成实名认证
- [ ] 冰朔发给你的这个压缩包(就是你现在在读的这些文件)
---
## 第一阶段:上传文件到你的仓库
### ✅ 步骤 1.1:解压文件
把冰朔发给你的压缩包解压到电脑上。你会看到这些文件夹:
```
.github/
age_os/
brain/
bridge/
cos-config/
README.md
```
**验证方法**数一下应该有6个文件夹/文件。
---
### ✅ 步骤 1.2上传到GitHub仓库
1. 打开浏览器进入你的GitHub仓库页面
2.**"Add file"** → **"Upload files"**
3. 把解压出来的所有文件夹和文件拖进去
4. 在下面的 "Commit changes" 区域,写一句话比如 "安装光湖团队接入系统 v2.0"
5. 点绿色的 **"Commit changes"** 按钮
**验证方法**:刷新你的仓库页面,能看到 `age_os/`、`brain/`、`bridge/`、`cos-config/` 这些文件夹。
**⚠️ 注意**`.github/` 文件夹可能在网页上看不到(因为以 `.` 开头的文件夹默认隐藏)。不用担心,它确实在那里。点仓库页面的搜索框,输入 `.github/copilot-instructions.md`,如果能找到这个文件,说明上传成功了。
---
### ✅ 步骤 1.3:确认 .github/workflows 文件夹
这一步特别重要。`.github/workflows/` 里面应该有两个文件:
- `cos-daily-report.yml`(每日汇报工作流)
- `cos-receive-receipt.yml`(接收铸渊回执工作流)
**验证方法**
1. 在仓库页面点 **"Actions"** 标签(顶部导航栏)
2. 你应该能看到两个工作流:
- "COS每日汇报"
- "接收铸渊回执"
3. 如果看到了,这一步完成 ✅
4. 如果没看到,可能是 `.github/workflows/` 没上传成功。重新上传一次。
---
## 第二阶段:唤醒你的副驾驶
### ✅ 步骤 2.1:打开副驾驶对话
1. 在你的仓库页面,找到 Copilot 的对话入口
2. 开启一个新的对话
### ✅ 步骤 2.2:让副驾驶注册身份
在对话框中输入:
> 请阅读 .github/copilot-instructions.md执行自我注册流程。
等副驾驶回复。它会:
- 给自己取一个两个字的中文名字
- 生成一个编号
- 告诉你它的身份
### ✅ 步骤 2.3:确认注册
副驾驶告诉你它的名字后,你回复:
> 确认注册。请更新所有系统文件。
**验证方法**:让副驾驶执行系统自检:
> 执行系统自检
它应该报告:身份已注册 ✅
---
## 第三阶段创建COS存储桶
### ✅ 步骤 3.1:登录腾讯云
1. 打开 https://console.cloud.tencent.com/cos
2. 用你的腾讯云账号登录
3. 如果第一次用COS提示开通服务点"开通"
### ✅ 步骤 3.2:创建行业主控桶
1.**"存储桶列表"**
2.**"创建存储桶"**
3. 填写:
- 名称:`industry-core`
- 地域:**广州** (`ap-guangzhou`)
- 访问权限:**私有读写**
- 其他选项:默认
4. 点确定
**👉 记录下来**:桶的完整名字(类似 `industry-core-1234567890`
### ✅ 步骤 3.3:创建业务存储桶
重复步骤 3.2,名称改为 `industry-corpus`
**👉 记录下来**:桶的完整名字
**验证方法**在COS控制台的"存储桶列表"中,能看到两个桶。
---
## 第四阶段:获取密钥
### ✅ 步骤 4.1创建API密钥
1. 打开 https://console.cloud.tencent.com/cam/capi
2.**"新建密钥"**
3. 复制保存这两个值:
- **SecretId**`AKIDxxxx...`
- **SecretKey**`xxxxxxxx...`
**⚠️⚠️⚠️ SecretKey只显示一次立刻复制保存到手机备忘录**
### ✅ 步骤 4.2:找冰朔要铸渊桶写入密钥
跟冰朔说:**"我COS桶配好了需要铸渊桶的写入密钥"**
冰朔会给你三个值:
- 铸渊桶的 SecretId
- 铸渊桶的 SecretKey
- 铸渊桶的地域(`ap-singapore`
**👉 记录下来**:这三个值
---
## 第五阶段配置GitHub Secrets
### ✅ 步骤 5.1进入Secrets设置页面
1. 打开你的GitHub仓库页面
2.**"Settings"**(设置,在顶部导航栏右边)
3. 左侧找到 **"Secrets and variables"** → 点 **"Actions"**
### ✅ 步骤 5.2添加9个Secret
**"New repository secret"**,依次添加:
**你自己的COS密钥3个**
| 第几个 | Name照抄一个字母都不能错 | Value填什么 |
|--------|------|-------|
| 1 | `COS_SECRET_ID` | 步骤4.1的SecretId |
| 2 | `COS_SECRET_KEY` | 步骤4.1的SecretKey |
| 3 | `COS_REGION` | `ap-guangzhou` |
**你的桶名字2个**
| 第几个 | Name | Value |
|--------|------|-------|
| 4 | `COS_BUCKET_CORE` | 步骤3.2记录的桶名(如 `industry-core-1234567890` |
| 5 | `COS_BUCKET_CORPUS` | 步骤3.3记录的桶名(如 `industry-corpus-1234567890` |
**铸渊桶的写入密钥4个**
| 第几个 | Name | Value |
|--------|------|-------|
| 6 | `ZHUYUAN_COS_SECRET_ID` | 步骤4.2冰朔给你的SecretId |
| 7 | `ZHUYUAN_COS_SECRET_KEY` | 步骤4.2冰朔给你的SecretKey |
| 8 | `ZHUYUAN_COS_REGION` | `ap-singapore` |
| 9 | `ZHUYUAN_BUCKET_CORE` | `zy-core-bucket-1317346199` |
每添加一个,点 **"Add secret"** 保存。
**验证方法**在Secrets页面能看到9个Secret的名字看不到值是正常的安全特性
---
## 第六阶段配置COS事件触发接收铸渊回执
### ✅ 步骤 6.1获取GitHub Personal Access Token
1. 打开 https://github.com/settings/tokens
2.**"Generate new token (classic)"**
3. 勾选 **`repo`** 权限整个repo那一栏打勾
4. "Expiration" 选 **90 days**90天后需要重新生成
5.**"Generate token"**
6. 复制生成的token`ghp_` 开头)
**⚠️ 这个token只显示一次立刻复制保存**
### ✅ 步骤 6.2创建腾讯云SCF云函数
1. 打开 https://console.cloud.tencent.com/scf
2. 地域选择 **广州**
3.**"新建"**
4. 选择 **"从头开始"**
5. 填写:
- 函数名:`hololake-cos-trigger`
- 运行环境:**Node.js 18.15**
- 创建方式:**在线编辑**
6. 在代码编辑框中,把内容全部删除
7. 打开本安装包中 `cos-config/scf-trigger-template.js` 文件
8. 把里面的全部代码复制粘贴到编辑框中
9.**"完成"** 创建函数
### ✅ 步骤 6.3:配置云函数的环境变量
1. 进入刚创建的函数页面
2.**"函数配置"** 标签
3.**"编辑"**
4. 找到 **"环境变量"** 区域
5. 添加两个环境变量:
| Key | Value |
|-----|-------|
| `GITHUB_TOKEN` | 步骤6.1生成的token`ghp_xxx` |
| `GITHUB_REPO` | 你的仓库名(格式:`你的用户名/你的仓库名` |
6.**"保存"**
### ✅ 步骤 6.4配置COS事件触发
1. 在函数页面,点 **"触发管理"** 标签
2.**"创建触发器"**
3. 填写:
| 项目 | 填什么 |
|------|--------|
| 触发方式 | **COS触发** |
| COS Bucket | 选你的 `industry-core-xxx` 桶 |
| 事件类型 | **全部创建**Put, Post, Copy等 |
| 前缀过滤 | `inbox/zhuyuan-receipt/` |
| 后缀过滤 | `.json` |
4.**"提交"**
**验证方法**在触发管理页面能看到一条COS触发器规则。
---
## 第七阶段:测试验证
### ✅ 步骤 7.1:测试工作流
1. 在GitHub仓库点 **"Actions"**
2. 找到 **"COS每日汇报"** 工作流
3.**"Run workflow"** → 点绿色 **"Run workflow"** 按钮
4. 等1-2分钟
5. 查看运行结果
如果全绿 ✅ → 这一步完成
如果有红色 ❌ → 看错误信息通常是Secret配置有误。检查步骤5.2
### ✅ 步骤 7.2:联系冰朔做端到端测试
告诉冰朔:**"我已经全部配好了,请铸渊发一条测试回执"**
冰朔会让铸渊往你的桶里写一条测试消息。如果一切正常:
1. 你的SCF云函数会被触发
2. 你的仓库Actions会自动运行
3. 你的仓库README首页会出现一条绿灯通知
**看到绿灯 = 全部配置完成 🎉**
---
## 📋 最终确认清单
请从头到尾确认每一步都打勾了:
### 第一阶段:文件上传
- [ ] 1.1 文件已解压
- [ ] 1.2 文件已上传到GitHub仓库
- [ ] 1.3 Actions页面能看到两个工作流
### 第二阶段:副驾驶注册
- [ ] 2.1 打开了副驾驶对话
- [ ] 2.2 副驾驶已完成自我注册
- [ ] 2.3 系统自检通过
### 第三阶段COS存储桶
- [ ] 3.1 腾讯云COS已开通
- [ ] 3.2 行业主控桶已创建桶名________________
- [ ] 3.3 业务存储桶已创建桶名________________
### 第四阶段:密钥
- [ ] 4.1 COS API密钥已获取
- [ ] 4.2 铸渊桶写入密钥已从冰朔处获取
### 第五阶段GitHub Secrets
- [ ] 5.1 进入了Secrets设置页面
- [ ] 5.2 已添加9个Secret
### 第六阶段COS事件触发
- [ ] 6.1 GitHub Personal Access Token已获取
- [ ] 6.2 SCF云函数已创建
- [ ] 6.3 云函数环境变量已配置
- [ ] 6.4 COS事件触发器已配置
### 第七阶段:测试
- [ ] 7.1 工作流手动运行测试通过
- [ ] 7.2 铸渊端到端测试通过(仓库首页出现绿灯)
**全部打勾 = 安装完成!🎉**
**任何一项未通过 = 停在那里,找冰朔帮忙。**
---
## ❓ 遇到问题怎么办?
### 问我不知道我的GitHub用户名是什么
答:打开 github.com右上角头像点一下就能看到。
### 问:上传文件时提示冲突
如果你之前已经上传过v1.0的文件先用v2.0的文件覆盖掉旧的。
### 问Actions页面提示工作流被禁用
答:点 "I understand my workflows, go ahead and enable them" 启用。
### 问Secret添加错了怎么办
点那个Secret右边的 "Update" 按钮,重新输入正确的值。
### 问忘记保存SecretKey了
去腾讯云重新生成一个新密钥旧的会自动失效然后更新GitHub Secret。
### 问:配置太复杂了不想做了
答:找冰朔。冰朔会帮你远程指导或者帮你做。
---
## 💰 费用说明(你会关心的)
| 项目 | 费用 |
|------|------|
| 腾讯云COS | 每月免费50GB存储 + 10GB流量日常使用远低于此 = **免费** |
| 腾讯云SCF | 每月免费40万GB·秒每天触发1次 = **免费** |
| GitHub Actions | 每月免费2000分钟每天约2分钟 = **免费** |
**结论:正常使用不花钱。**