@geek-fun/serverlessinsight
v0.6.5
Published
Full life cycle cross providers serverless application management for your fast-growing business.
Downloads
1,001
Keywords
Readme
ServerlessInsight
为快速增长的业务提供全生命周期跨云服务商的 Serverless 应用管理
ServerlessInsight 是一个强大的 Serverless 框架，用于跨多个云服务商管理 Serverless 应用。它提供了统一的接口来部署、管理和调试 Serverless 函数和资源，使用基础设施即代码（IaC）原则。
无论您是在 AWS、阿里云、华为云还是其他服务商上构建应用，ServerlessInsight 都能简化您的开发工作流程：
- 多云支持 - 使用单一工具与多个云服务商协作
- 基础设施即代码 - 使用 YAML 定义您的 Serverless 基础设施
- 本地开发 - 在部署前本地测试您的函数
- 类型安全模板 - 在部署前验证您的配置
✨ 特性
- 🌍 多云服务商支持 - 部署到阿里云、华为云等多个平台
- 📦 统一配置 - 所有服务商使用单一 YAML 格式
- 🚀 快速部署 - 使用单个命令部署 Serverless 应用
- 🔍 模板验证 - 在部署前验证您的 IaC 模板
- 🏠 本地测试 - 在本地运行和调试 Serverless 函数
- 🔄 模板生成 - 生成特定云服务商的 IaC 模板
- 🌐 API 网关集成 - 为您的函数配置 HTTP 端点
- 🌐 自定义域名绑定 - 支持 OSS 和 API 网关的自动域名绑定与 DNS 验证
- 💾 资源管理 - 管理存储、数据库和其他云资源
- 🔐 安全优先 - 内置验证和安全最佳实践
- 📊 全面的日志记录 - 调试和监控您的应用
☁️ 支持的云服务商
ServerlessInsight 支持以下云服务商：
| 云服务商 | 函数 | API 网关 | 存储 | 数据库 | 状态 | | ---------------- | ---------------- | ----------- | ----------- | ---------------- | ------ | | 阿里云 | ✅ FC3 | ✅ API 网关 | ✅ OSS | ✅ RDS, OTS, ESS | 稳定 | | 腾讯云 | ✅ SCF | 🚧 即将推出 | ✅ COS | ✅ TDSQL-C | 稳定 | | 华为云 | ✅ FunctionGraph | 🚧 即将推出 | 🚧 即将推出 | 🚧 即将推出 | 测试版 | | AWS | 🔜 计划中 | 🔜 计划中 | 🔜 计划中 | 🔜 计划中 | 计划中 | | Azure | 🔜 计划中 | 🔜 计划中 | 🔜 计划中 | 🔜 计划中 | 计划中 | | Google Cloud | 🔜 计划中 | 🔜 计划中 | 🔜 计划中 | 🔜 计划中 | 计划中 |
🚀 快速开始
前置要求
- Node.js 16.x 或更高版本
- 云服务商凭证（阿里云 AccessKey、华为云凭证等）
安装
使用 npm 全局安装 ServerlessInsight：
npm install -g @geek-fun/serverlessinsight验证安装：
si --version📚 使用方法
# 验证您的 Serverless 配置
si validate -f serverless.yml
# 生成部署计划（查看将要发生的变更）
si plan -f serverless.yml
# 部署您的 Serverless 应用
si deploy -f serverless.yml -s dev
# 本地运行您的应用进行调试
si local -f serverless.yml -s local
# 显示已部署资源信息
si show -f serverless.yml
# 销毁已部署的堆栈
si destroy -f serverless.yml💡 示例
ServerlessInsight 使用简单的 YAML 格式来定义您的 Serverless 基础设施：
version: 0.0.1
provider:
name: aliyun
region: cn-hongkong
service: my-api-service
functions:
hello_function:
name: hello-world-fn
code:
runtime: nodejs18
handler: index.handler
path: ./src
memory: 512
timeout: 10
environment:
NODE_ENV: production
events:
api_gateway:
type: API_GATEWAY
name: my-api-gateway
triggers:
- method: GET
path: /api/hello
backend: ${functions.hello_function}更多示例请查看 samples 目录：
- API 网关示例 - 部署带 HTTP 端点的函数
- 存储示例 - 配置 OSS 存储桶
- 自定义域名示例 - 配置 OSS 静态网站托管与自定义域名绑定
- 数据库示例 - 设置 RDS 数据库
- 表格存储示例 - 配置 OTS 表格存储
- Elasticsearch 示例 - 部署 Elasticsearch Serverless
- GPU 函数示例 - 部署支持 GPU 的函数
- 华为云示例 - 部署到华为云 FunctionGraph
🔧 本地开发
# 克隆和设置
git clone https://github.com/geek-fun/serverlessinsight.git
cd serverlessinsight
npm install
# 构建并链接用于开发
npm run build
npm link
# 运行本地开发服务器
si local -f serverless.yml -s local
# 运行测试
npm test
# 检查代码规范
npm run lint:check🌐 自定义域名绑定
ServerlessInsight 为 OSS 存储桶和 API 网关提供自动化的自定义域名绑定，内置 DNS 验证功能。
OSS 自定义域名绑定
当您为 OSS 存储桶（静态网站托管）配置自定义域名时，ServerlessInsight 会自动：
- 绑定域名到您的 OSS 存储桶
- 创建 DNS CNAME 记录，指向正确的 OSS Endpoint
- 处理域名所有权验证，通过 DNS TXT 记录完成云服务商要求的验证
- 管理重试逻辑，通过 DNS 传播轮询确保绑定可靠
buckets:
my_website:
name: my-website-bucket
security:
acl: PUBLIC_READ
website:
code: ./dist
domain: www.example.com # 自定义域名绑定
index: index.html
error_page: 404.html域名所有权验证流程
当绑定需要所有权验证的自定义域名时：
┌─────────────────────────────────────────────────────────────────┐
│ OSS 自定义域名绑定流程 │
└─────────────────────────────────────────────────────────────────┘
│
▼
┌───────────────────────┐
│ PutCname (首次尝试) │
└───────────────────────┘
│
┌───────────────────┴───────────────────┐
│ │
▼ ▼
┌───────────────┐ ┌─────────────────┐
│ 绑定成功 │ │ 需要域名所有权 │
└───────────────┘ │ 验证 │
└─────────────────┘
│
▼
┌─────────────────────────┐
│ CreateCnameToken API │
│ (获取 TXT 记录值) │
└─────────────────────────┘
│
▼
┌─────────────────────────┐
│ 检查现有 TXT 记录 │
│ (避免重复创建) │
└─────────────────────────┘
│
▼
┌─────────────────────────┐
│ 添加 DNS TXT 记录 │
│ (_dnsauth.domain) │
└─────────────────────────┘
│
▼
┌─────────────────────────┐
│ 轮询 DNS 传播状态 │
│ (最多 10 次 × 1 分钟) │
└─────────────────────────┘
│
▼
┌─────────────────────────┐
│ 重试 PutCname │
│ (最多 5 次 × 30 秒) │
└─────────────────────────┘支持的域名类型
对于 OSS 静态网站托管，ServerlessInsight 支持：
| 域名类型 | CNAME 目标 | 使用场景 |
| -------------- | -------------------------------- | --------------------------- |
| 根域名 (@) | bucket.region.taihangcda.cn | 绕过根域名的 DNS CNAME 限制 |
| 子域名 (www) | bucket.oss-region.aliyuncs.com | 标准 OSS Endpoint |
详细配置请参考 OSS 自定义域名绑定指南。
📘 文档
完整文档请访问 serverlessinsight.geekfun.club
其他资源：
🗄️ 状态管理
ServerlessInsight 使用基于状态的部署模型，在本地状态文件 (.serverlessinsight/state.json) 中跟踪所有已部署的资源。这使得：
- 增量部署 - 只有更改的资源才会被更新
- 漂移检测 - 识别本地状态与云资源之间的差异
- 安全销毁 - 知道要清理哪些资源
部分失败恢复
当部署多个资源时，如果其中一个失败，ServerlessInsight 确保：
- 成功部署的资源始终保存到状态 - 即使后续资源失败，您的状态文件也将包含所有成功创建/更新/删除的资源
- 清晰的错误报告 - 您将看到哪些资源成功，哪些资源失败
- 轻松重试 - 只需再次运行
deploy即可从中断的地方继续
部分失败输出示例：
⚠️ 部署部分失败: 2 个资源成功，但 functions.api_handler 失败。
已成功部署的资源状态已保存。再次运行 deploy 以重试失败的资源。
后续步骤: 1) 查看上面的错误, 2) 修复配置问题, 3) 再次运行 deploy 继续。状态文件位置
状态文件存储在项目目录的 .serverlessinsight/state.json 中。此文件：
- 应提交到版本控制以便团队协作
- 包含资源元数据和标识符
- 在每次成功操作后自动更新
状态恢复
如果遇到状态漂移（云资源存在但不在状态文件中）：
- 手动导入 - 目前，资源必须手动添加到状态文件
- 重新开始 - 删除状态文件和云中的资源，然后重新部署
💡 提示：在进行手动修改之前，请始终备份您的状态文件。
🤝 贡献
我们欢迎社区的贡献！以下是您可以帮助的方式：
- Fork 仓库
- 创建功能分支 (
git checkout -b feature/amazing-feature) - 提交您的更改 (
git commit -m 'Add amazing feature') - 推送到分支 (
git push origin feature/amazing-feature) - 打开 Pull Request
👥 社区
加入我们的社区以获取帮助、分享想法和贡献：
- GitHub Issues - 报告错误或请求功能
- 官方网站 - serverlessinsight.geekfun.club
📄 许可证
本项目采用 Apache License 2.0 许可证 - 详见 LICENSE 文件。
🙏 致谢
ServerlessInsight 使用以下优秀技术构建：
- Node.js - JavaScript 运行时
- TypeScript - 类型安全的 JavaScript
- Commander.js - CLI 框架
- 阿里云 ROS CDK - 云基础设施 SDK
由 geek-fun 团队用 ❤️ 制作