@geek-fun/serverlessinsight 0.9.3 → 0.9.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.serverlessinsight/state-cdn-flow-app-cdn-flow-service.json.backup +1 -1
- package/.serverlessinsight/state-iam-test-app-iam-test-service.json.backup +2 -2
- package/.serverlessinsight/state-insight-poc-app-insight-poc-tencent.json.backup +2 -2
- package/.serverlessinsight/state-insight-poc-app-log-insight-poc-tencent-log.json.backup +3 -3
- package/.serverlessinsight/state-insight-poc-deploy-app-insight-poc-deploy.json.backup +4 -4
- package/.serverlessinsight/state-insight-poc-destroy-app-insight-poc-destroy.json.backup +1 -1
- package/.serverlessinsight/state-insight-poc-timer-app-insight-poc-timer.json.backup +2 -2
- package/.serverlessinsight/state-insight-volc-app-insight-volc.json.backup +2 -2
- package/.serverlessinsight/state-insight-volc-nested-app-insight-volc-nested.json.backup +3 -3
- package/.serverlessinsight/state-nested-drift-app-nested-drift-service.json.backup +2 -2
- package/.serverlessinsight/state-role-reconcile-test-app-role-reconcile-test-service.json.backup +3 -3
- package/CHANGELOG.md +28 -0
- package/README.md +246 -179
- package/README.zh-CN.md +244 -147
- package/dist/package.json +22 -19
- package/dist/src/commands/index.js +12 -59
- package/dist/src/commands/plan.js +25 -1
- package/dist/src/common/aliyunClient/apigwOperations.js +32 -9
- package/dist/src/lang/en.js +5 -4
- package/dist/src/lang/index.js +28 -14
- package/dist/src/lang/zh-CN.js +5 -4
- package/dist/src/stack/aliyunStack/apigwDomainPlan.js +82 -0
- package/dist/src/stack/aliyunStack/apigwExecutor.js +4 -1
- package/dist/src/stack/aliyunStack/apigwPlanner.js +115 -55
- package/dist/src/stack/aliyunStack/apigwResource.js +169 -124
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/package.json +22 -19
- package/release-notes.md +33 -59
- package/samples/README_TENCENT_COS.md +3 -3
- package/samples/README_TENCENT_SCF.md +3 -3
package/README.zh-CN.md
CHANGED
|
@@ -4,28 +4,30 @@
|
|
|
4
4
|
|
|
5
5
|
# ServerlessInsight
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
**面向阿里云、腾讯云与火山引擎的全生命周期 Serverless IaC 工具。**
|
|
8
8
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
**面向阿里云 · 腾讯云 · 华为云 · 火山引擎的 Serverless 命令行工具。**
|
|
9
|
+
用一份 YAML 定义函数、API 网关、存储与数据库——先预览计划,再放心部署,并持续运维。
|
|
12
10
|
|
|
13
11
|
[](https://github.com/geek-fun/serverlessinsight/releases)
|
|
14
12
|
[](https://www.npmjs.com/package/@geek-fun/serverlessinsight)
|
|
15
|
-
[](https://www.npmjs.com/package/@geek-fun/serverlessinsight)
|
|
14
|
+
[](LICENSE)
|
|
17
15
|
[](https://github.com/geek-fun/serverlessinsight/actions/workflows/node.yml)
|
|
16
|
+
[](https://github.com/geek-fun/serverlessinsight/stargazers)
|
|
17
|
+
[](https://github.com/geek-fun/serverlessinsight/issues)
|
|
18
|
+
|
|
19
|
+
<p>
|
|
20
|
+
<img src="https://img.shields.io/badge/Node.js-%3E%3D22.12-339933?logo=nodedotjs&logoColor=white" alt="Node.js >= 22.12" />
|
|
21
|
+
<img src="https://img.shields.io/badge/TypeScript-3178C6?logo=typescript&logoColor=white" alt="TypeScript" />
|
|
22
|
+
</p>
|
|
18
23
|
|
|
19
24
|
<p>
|
|
20
|
-
<img src="https://img.shields.io/badge/
|
|
21
|
-
<img src="https://img.shields.io/badge/
|
|
22
|
-
<img src="https://img.shields.io/badge/
|
|
23
|
-
<img src="https://img.shields.io/badge/Tencent%20Cloud-0A9AED&logo=tencentqq&logoColor=white"/>
|
|
24
|
-
<img src="https://img.shields.io/badge/Huawei%20Cloud-FF0000?logo=huawei&logoColor=white"/>
|
|
25
|
-
<img src="https://img.shields.io/badge/AWS-232F3E&logo=amazonwebservices&logoColor=white"/>
|
|
25
|
+
<img src="https://img.shields.io/badge/Alibaba%20Cloud-FF6A00?logo=alibabacloud&logoColor=white" alt="阿里云" />
|
|
26
|
+
<img src="https://img.shields.io/badge/Tencent%20Cloud-0A9AED?logo=tencentqq&logoColor=white" alt="腾讯云" />
|
|
27
|
+
<img src="https://img.shields.io/badge/Volcengine-1677FF?logoColor=white" alt="火山引擎" />
|
|
26
28
|
</p>
|
|
27
29
|
|
|
28
|
-
[npm](https://www.npmjs.com/package/@geek-fun/serverlessinsight) · [文档](https://serverlessinsight.
|
|
30
|
+
[npm](https://www.npmjs.com/package/@geek-fun/serverlessinsight) · [文档](https://serverlessinsight.com/docs.html) · [官网](https://serverlessinsight.com) · [示例](samples) · [更新日志](CHANGELOG.md) · [Issues](https://github.com/geek-fun/serverlessinsight/issues)
|
|
29
31
|
|
|
30
32
|
简体中文 · [English](README.md)
|
|
31
33
|
|
|
@@ -33,123 +35,174 @@
|
|
|
33
35
|
|
|
34
36
|
---
|
|
35
37
|
|
|
36
|
-
ServerlessInsight
|
|
38
|
+
ServerlessInsight(`si`)是一个开源的跨云 Serverless 框架。你不再需要分别应付各家云厂商的 CLI、控制台点击和一次性脚本——只需在单一 YAML 文件中描述整套 Serverless 技术栈(函数、HTTP 入口、对象存储、数据库与数据表),剩下的计划、部署与运维交给 `si`。
|
|
37
39
|
|
|
38
|
-
|
|
39
|
-
<img src="https://img.shields.io/badge/Alibaba%20Cloud-FF6A00?logo=alibabacloud&logoColor=white" />
|
|
40
|
-
<img src="https://img.shields.io/badge/Tencent%20Cloud-0A9AED?logo=tencentqq&logoColor=white" />
|
|
41
|
-
<img src="https://img.shields.io/badge/Huawei%20Cloud-FF0000?logo=huawei&logoColor=white" />
|
|
42
|
-
<img src="https://img.shields.io/badge/Volcengine-1677FF?logoColor=white" />
|
|
43
|
-
<img src="https://img.shields.io/badge/AWS-232F3E?logo=amazonwebservices&logoColor=white" />
|
|
44
|
-
<img src="https://img.shields.io/badge/Azure-0078D4?logo=microsoftazure&logoColor=white" />
|
|
45
|
-
<img src="https://img.shields.io/badge/GCP-4285F4?logo=googlecloud&logoColor=white" />
|
|
46
|
-
</p>
|
|
40
|
+
可以把它理解为面向 Serverless 的 Terraform:同一套声明式工作流,带状态追踪与漂移检测,专为函数、API 网关和 Serverless 数据服务而设计。无供应商锁定,Apache-2.0 许可。
|
|
47
41
|
|
|
48
|
-
|
|
42
|
+
**当前可部署:** 阿里云、腾讯云、火山引擎。华为云、AWS、Azure 与 Google Cloud 见[路线图](#路线图)。
|
|
43
|
+
|
|
44
|
+
## 目录
|
|
45
|
+
|
|
46
|
+
- [快速开始](#快速开始)
|
|
47
|
+
- [为什么选择 ServerlessInsight](#为什么选择-serverlessinsight)
|
|
48
|
+
- [功能特性](#功能特性)
|
|
49
|
+
- [支持的云服务商](#支持的云服务商)
|
|
50
|
+
- [文档](#文档)
|
|
51
|
+
- [路线图](#路线图)
|
|
52
|
+
- [架构](#架构)
|
|
53
|
+
- [开发](#开发)
|
|
54
|
+
- [社区](#社区)
|
|
55
|
+
- [贡献](#贡献)
|
|
56
|
+
- [赞助](#赞助)
|
|
57
|
+
- [许可证](#许可证)
|
|
58
|
+
|
|
59
|
+
## 快速开始
|
|
60
|
+
|
|
61
|
+
**需要 Node.js 22.12 或更高版本。**
|
|
49
62
|
|
|
50
63
|
```bash
|
|
51
64
|
npm install -g @geek-fun/serverlessinsight
|
|
52
65
|
si --version
|
|
53
66
|
```
|
|
54
67
|
|
|
55
|
-
|
|
68
|
+
创建 `serverlessinsight.yml`:
|
|
56
69
|
|
|
57
|
-
|
|
70
|
+
```yaml
|
|
71
|
+
version: 0.0.1
|
|
72
|
+
|
|
73
|
+
provider:
|
|
74
|
+
name: aliyun
|
|
75
|
+
region: cn-hongkong
|
|
76
|
+
|
|
77
|
+
app: hello-world
|
|
78
|
+
service: hello-world-api
|
|
79
|
+
|
|
80
|
+
functions:
|
|
81
|
+
hello_function:
|
|
82
|
+
name: hello-world-fn
|
|
83
|
+
code:
|
|
84
|
+
runtime: nodejs18
|
|
85
|
+
handler: index.handler
|
|
86
|
+
path: ./src
|
|
87
|
+
memory: 512
|
|
88
|
+
timeout: 10
|
|
58
89
|
|
|
59
|
-
|
|
90
|
+
events:
|
|
91
|
+
api_gateway:
|
|
92
|
+
type: API_GATEWAY
|
|
93
|
+
name: my-api-gateway
|
|
94
|
+
triggers:
|
|
95
|
+
- method: GET
|
|
96
|
+
path: /api/hello
|
|
97
|
+
backend: ${functions.hello_function}
|
|
98
|
+
```
|
|
60
99
|
|
|
61
|
-
|
|
62
|
-
- **云厂商专属模板生成** —— 根据配置生成原生 IaC 模板
|
|
63
|
-
- **跨云感知** —— 同一套抽象可在不同云之间通用
|
|
100
|
+
然后:
|
|
64
101
|
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
| **Azure** | 🔜 计划中 | 🔜 计划中 | 🔜 计划中 | 🔜 计划中 | 计划中 |
|
|
73
|
-
| **Google Cloud** | 🔜 计划中 | 🔜 计划中 | 🔜 计划中 | 🔜 计划中 | 计划中 |
|
|
102
|
+
```bash
|
|
103
|
+
si validate # 按 IaC Schema 校验配置
|
|
104
|
+
si diff # 展示将要发生的变更,不写入状态
|
|
105
|
+
si deploy --stage prod # 展示计划,确认后执行
|
|
106
|
+
si local # 在 http://localhost:4567 本地运行
|
|
107
|
+
si destroy --stage prod # 删除 si 创建的全部资源
|
|
108
|
+
```
|
|
74
109
|
|
|
75
|
-
|
|
110
|
+
`si` 会自动发现当前目录下的 `serverlessinsight.yml`;其他文件名请用 `-f <path>` 指定。要切换云厂商,只需把 `provider.name` 改为 `tencent` 或 `volcengine`——运行时、触发器与资源会按对应云厂商映射为原生服务。
|
|
76
111
|
|
|
77
|
-
|
|
112
|
+
## 为什么选择 ServerlessInsight
|
|
78
113
|
|
|
79
|
-
-
|
|
80
|
-
-
|
|
81
|
-
-
|
|
82
|
-
-
|
|
114
|
+
- **Serverless 原生,而非通用 IaC。** 函数、触发器、API 网关、域名、存储桶、数据库与数据表都是一等资源,并带有云厂商感知的默认值——无需手写 Terraform 模块或 SDK 封装脚本。
|
|
115
|
+
- **一份 YAML 打通多云。** 同一套原语与 stage/变量体系适用于所有已支持的云厂商,切换云厂商只需改动 `provider.name`,而不是重写配置。
|
|
116
|
+
- **变更之前先看计划。** `si diff` 只读取状态与线上资源、不写入任何内容;`si deploy` 执行的正是你确认过的那份计划,控制台里的手工改动会以漂移形式暴露。
|
|
117
|
+
- **为自动化而生。** 日志输出到 stderr,机器可读结果输出到 stdout,每个 JSON envelope 都带版本号,错误码跨语言环境保持稳定,退出码遵循 Terraform 惯例。
|
|
118
|
+
- **真正可用的本地开发。** 用同一份配置在本地运行处理函数、HTTP 路由、定时调度与存储桶端点——无需云账号或凭证。
|
|
119
|
+
- **开源、无锁定。** Apache-2.0 许可,状态可存放在本地文件或你自己的存储桶中,不引入任何专有运行时。
|
|
83
120
|
|
|
84
|
-
|
|
121
|
+
## 功能特性
|
|
85
122
|
|
|
86
|
-
|
|
87
|
-
# 校验你的配置
|
|
88
|
-
si validate -f serverless.yml
|
|
123
|
+
### 多云支持,统一配置
|
|
89
124
|
|
|
90
|
-
|
|
91
|
-
si plan -f serverless.yml
|
|
125
|
+
一次定义,即可部署到阿里云、腾讯云与火山引擎。运行时标识、cron 方言、网关资源与归属标签等厂商差异由框架负责解析,而不是由你的 YAML 承担。
|
|
92
126
|
|
|
93
|
-
|
|
94
|
-
|
|
127
|
+
- **统一配置** —— 所有云厂商共用同一 `serverlessinsight.yml` 格式
|
|
128
|
+
- **厂商专属映射** —— 运行时名称、触发器结构与资源类型会翻译为对应云平台的原生值
|
|
129
|
+
- **跨云感知** —— 同一套函数、存储桶、数据库与事件可在不同云之间通用
|
|
95
130
|
|
|
96
|
-
|
|
97
|
-
|
|
131
|
+
### 部署前预览
|
|
132
|
+
|
|
133
|
+
`si diff` 可预览阿里云、腾讯云与火山引擎上的全部变更。它会读取已配置的状态后端与线上云资源,但不应用变更、也不写入状态。
|
|
134
|
+
|
|
135
|
+
```bash
|
|
136
|
+
si diff --stage dev
|
|
137
|
+
si diff --stage dev --json
|
|
138
|
+
si diff --stage dev --region cn-beijing -p memory=1024
|
|
139
|
+
si diff --stage dev --no-refresh
|
|
98
140
|
```
|
|
99
141
|
|
|
100
|
-
|
|
142
|
+
使用 `-p, --parameter <key=value>` 可重复覆盖配置变量。`--no-refresh` 会跳过已追踪资源的线上漂移检查,新资源的归属探测仍会执行。需提前配置好凭证与所选状态后端;读取失败会以错误退出。迁移自旧版本的状态会产生告警并保持原样。
|
|
143
|
+
|
|
144
|
+
火山引擎的计划按依赖顺序包含函数、TOS 存储桶与 API Gateway 资源。
|
|
145
|
+
|
|
146
|
+
**退出码**:`si diff` 无变更时退出 `0`,有变更时退出 `2`(Terraform 惯例),出错时退出 `1`。`si validate` 校验通过退出 `0`,校验失败退出 `1`。
|
|
147
|
+
|
|
148
|
+
### 基础设施即代码
|
|
149
|
+
|
|
150
|
+
声明式 YAML 配置,内置校验、计划与状态管理,遵循成熟的 IaC 实践。
|
|
151
|
+
|
|
152
|
+
- **状态追踪** —— 基于 `.serverlessinsight/` 状态文件进行增量部署,支持本地、存储桶与 SaaS 后端
|
|
153
|
+
- **漂移检测** —— 在 `si` 之外被改动的资源会在下次部署前被标记出来
|
|
154
|
+
- **配置校验** —— 类型安全的模板校验在配置触达云端前捕获错误
|
|
155
|
+
- **部分失败恢复** —— 即使部分资源失败,已成功部署的资源仍会被保存;重试即可继续
|
|
156
|
+
- **状态锁** —— 阻止并发部署,必要时可用 `si force-unlock` 解锁
|
|
157
|
+
|
|
158
|
+
### 为 AI Agent 与脚本而设计
|
|
101
159
|
|
|
102
|
-
CLI 专为
|
|
103
|
-
**stdout**,因此将 stdout 管道给 `jq` 总能得到单个可解析的 JSON 文档。
|
|
160
|
+
CLI 专为 Agent 与 Shell 脚本驱动而设计:日志始终输出到 **stderr**,结果数据输出到 **stdout**,因此把 stdout 管道给 `jq` 总能得到单个可解析的 JSON 文档。
|
|
104
161
|
|
|
105
162
|
```bash
|
|
106
|
-
si
|
|
107
|
-
si validate --json
|
|
108
|
-
si show --json
|
|
109
|
-
si schema | jq '
|
|
163
|
+
si diff --json | jq '.summary'
|
|
164
|
+
si validate --json | jq '.valid'
|
|
165
|
+
si show --json | jq '.resourceCount'
|
|
166
|
+
si schema | jq '."$id"' # IaC 格式的自包含 draft-07 JSON Schema
|
|
110
167
|
```
|
|
111
168
|
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
- `si validate --json` → `{ validateVersion: 1, valid, errors: [{ path,
|
|
119
|
-
|
|
120
|
-
- `si show --json` → `{ showVersion: 1, provider, app, service, stage,
|
|
121
|
-
stateLocation, backend: "saas|bucket_store|local", locked, lock, resources,
|
|
122
|
-
resourceCount, ... }`
|
|
169
|
+
<details>
|
|
170
|
+
<summary><b>稳定的输出 envelope、错误码与颜色行为</b></summary>
|
|
171
|
+
|
|
172
|
+
稳定的输出 envelope(每个都带版本号字段,结构只会在新版本号下变化):
|
|
173
|
+
|
|
174
|
+
- `si diff --json` → `{ planVersion: 1, provider, app, service, stage, changes: [{ logicalId, type, action: "create|update|destroy|recreate", attributes, drifted?, driftReasons? }], summary: { create, update, destroy, recreate, unchanged } }`
|
|
175
|
+
- `si validate --json` → `{ validateVersion: 1, valid, errors: [{ path, keyword, message, allowedValues? }] }`
|
|
176
|
+
- `si show --json` → `{ showVersion: 1, provider, app, service, stage, stateLocation, backend: "saas|bucket_store|local", locked, lock, resources, resourceCount, ... }`
|
|
123
177
|
- 失败时(`--json` 模式)→ stdout 输出 `{ error: { code, message } }`
|
|
124
178
|
|
|
125
|
-
|
|
126
|
-
惯例),出错时退出 `1`。`si validate` 校验通过退出 `0`,校验失败退出 `1`。
|
|
179
|
+
稳定的错误码:错误 `code` 是翻译消息背后的 i18n key(例如 `RAM_ROLE_NOT_FOUND_IN_CLOUD`)——在所有语言环境下保持一致,Agent 可以据此映射自愈动作,不受 `LANG` 影响。
|
|
127
180
|
|
|
128
|
-
|
|
129
|
-
`RAM_ROLE_NOT_FOUND_IN_CLOUD`)——在所有语言环境下保持一致,agent
|
|
130
|
-
可以据此映射自愈动作,不受 `LANG` 影响。
|
|
181
|
+
颜色:设置 `NO_COLOR` 环境变量([no-color.org](https://no-color.org))或传入 `--no-color` 时禁用 ANSI 颜色,保证非 TTY 环境下管道输出干净。
|
|
131
182
|
|
|
132
|
-
|
|
133
|
-
`--no-color` 时禁用 ANSI 颜色,保证非 TTY 环境下管道输出干净。
|
|
183
|
+
</details>
|
|
134
184
|
|
|
135
185
|
### 本地开发
|
|
136
186
|
|
|
137
|
-
|
|
187
|
+
无需部署到云端,也无需配置凭证,即可在本地运行和调试 Serverless 函数。
|
|
138
188
|
|
|
139
|
-
- **
|
|
140
|
-
-
|
|
141
|
-
- **火山引擎 HTTP 调用** —— 为[文档化的本地子集](docs/local-development.md)提供 veFaaS Node.js 事件、context 与响应转换,附带[可运行示例](samples/volcengine-local/serverlessinsight.yml)
|
|
189
|
+
- **HTTP 函数** —— 为阿里云 FC、腾讯云 SCF 函数 URL 与火山引擎 veFaaS 提供原生的 event、context 与响应转换
|
|
190
|
+
- **定时触发器** —— `functions.*.triggers.timer` 调度按 UTC 墙钟执行,以对应云平台的 timer 事件形状调用你的处理函数
|
|
142
191
|
- **存储桶文件服务** —— 通过 HTTP 访问本地存储文件,加速迭代
|
|
143
|
-
-
|
|
192
|
+
- **监听模式** —— 代码变更后自动重载
|
|
193
|
+
- **同一配置,不同目标** —— `si local -s dev` 复用你现有的配置
|
|
194
|
+
|
|
195
|
+
支持范围与可运行示例详见[本地开发文档](docs/local-development.md):[腾讯云 SCF](samples/tencent-local/serverlessinsight.yml) 与[火山引擎 veFaaS](samples/volcengine-local/serverlessinsight.yml)。
|
|
144
196
|
|
|
145
197
|
### API 网关与自定义域名
|
|
146
198
|
|
|
147
199
|
配置 HTTP 端点并绑定自定义域名,附带自动 DNS 验证。
|
|
148
200
|
|
|
149
|
-
- **
|
|
150
|
-
-
|
|
201
|
+
- **HTTP 触发器** —— 使用 HTTP 方法与路径定义触发器,并指定后端函数
|
|
202
|
+
- **自定义域名** —— 阿里云 OSS 与 API 网关自动完成 CNAME + DNS TXT 所有权验证;腾讯云通过 DNSPod 托管域名
|
|
151
203
|
- **CDN 加速** —— 为静态站点提供边缘缓存与全球内容分发
|
|
152
204
|
- **OSS 传输加速** —— 通过阿里云骨干网进行跨区域数据传输
|
|
205
|
+
- **腾讯云函数 URL** —— 无需独立网关资源即可提供 HTTP 入口
|
|
153
206
|
|
|
154
207
|
### 定时触发器
|
|
155
208
|
|
|
@@ -164,34 +217,74 @@ functions:
|
|
|
164
217
|
cron: '0 23 3 * * *' # 必填 —— si-cron,按 UTC 解释
|
|
165
218
|
payload: '{"job":"billing-run"}' # 可选,原样透传
|
|
166
219
|
enable: true # 可选,默认 true
|
|
167
|
-
description: 每日出账
|
|
220
|
+
description: 每日出账 # 可选
|
|
168
221
|
- name: report-hourly
|
|
169
222
|
cron: '@every 1h'
|
|
170
223
|
```
|
|
171
224
|
|
|
172
|
-
`cron` 支持标准 5 段表达式(`分 时 日 月 周`)、带秒前缀的 6 段,或
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
225
|
+
`cron` 支持标准 5 段表达式(`分 时 日 月 周`)、带秒前缀的 6 段,或 `@every <时长>`(`30s`、`5m`、`1h`、`1d` 等)。si-cron 一律按 **UTC** 解释——合成层负责翻译成各家方言(阿里云 FC3 六段、腾讯云 SCF 含年的七段、火山引擎 veFaaS 五段 crontab),并完成 UTC+8 字段平移,因此同一份 YAML 在所有云平台触发时刻一致。非法表达式与平台能力上限(腾讯云 SCF 单函数最多 10 个定时触发器)在 `si validate` 阶段即报错,不会进入部署。
|
|
226
|
+
|
|
227
|
+
<details>
|
|
228
|
+
<summary><b><code>triggers</code> 与顶层 <code>events</code> 的区分</b></summary>
|
|
229
|
+
|
|
230
|
+
`functions.*.triggers`(http、timer)是「调用本函数的东西」——函数级归属、随函数级联删除、没有独立配置面。顶层 `events`(如 `API_GATEWAY`)是拥有独立配置面的基础设施资源——自定义域名、证书、路由表——删除后端函数后它们依然存在。经验法则:有独立配置面 → `events`;纯调度/事件绑定 → `triggers`。
|
|
178
231
|
|
|
179
|
-
|
|
180
|
-
是「调用本函数的东西」——函数级归属、随函数级联删除、没有独立配置面。顶层
|
|
181
|
-
`events`(如 `API_GATEWAY`)是拥有独立配置面的基础设施资源——自定义域名、
|
|
182
|
-
证书、路由表——删除后端函数后它们依然存在。经验法则:有独立配置面 →
|
|
183
|
-
`events`;纯调度/事件绑定 → `triggers`。
|
|
232
|
+
</details>
|
|
184
233
|
|
|
185
234
|
### 资源管理
|
|
186
235
|
|
|
187
|
-
|
|
236
|
+
不止于函数——管理包含存储、数据库与数据表在内的完整 Serverless 技术栈。
|
|
188
237
|
|
|
189
238
|
- **对象存储** —— OSS(阿里云)、COS(腾讯云)、TOS(火山引擎)
|
|
190
|
-
- **数据库** —— RDS、
|
|
191
|
-
-
|
|
192
|
-
- **GPU 函数** ——
|
|
193
|
-
|
|
194
|
-
|
|
239
|
+
- **数据库** —— RDS MySQL Serverless、TDSQL-C 与 Elasticsearch Serverless
|
|
240
|
+
- **数据表** —— 阿里云 TableStore
|
|
241
|
+
- **GPU 函数** —— 在阿里云部署支持 GPU 的 Serverless 函数
|
|
242
|
+
|
|
243
|
+
## 支持的云服务商
|
|
244
|
+
|
|
245
|
+
| 云服务商 | 函数 | HTTP 入口 | 对象存储 | 数据库与数据表 | 状态 |
|
|
246
|
+
| ---------------- | -------------------------- | ---------------------- | -------- | ------------------------------------------------------------- | ------ |
|
|
247
|
+
| **阿里云** | ✅ FC3 | ✅ API 网关 | ✅ OSS | ✅ RDS MySQL Serverless、TableStore、Elasticsearch Serverless | 稳定 |
|
|
248
|
+
| **腾讯云** | ✅ SCF | ✅ 函数 URL 触发器 | ✅ COS | ✅ TDSQL-C、Elasticsearch Serverless | 稳定 |
|
|
249
|
+
| **火山引擎** | ✅ veFaaS | ✅ API 网关 | ✅ TOS | — | 稳定 |
|
|
250
|
+
| **华为云** | ⚠️ 仅生成 Terraform 模板 | — | — | — | 预览 |
|
|
251
|
+
| **AWS** | — | — | — | — | 计划中 |
|
|
252
|
+
| **Azure** | — | — | — | — | 计划中 |
|
|
253
|
+
| **Google Cloud** | — | — | — | — | 计划中 |
|
|
254
|
+
|
|
255
|
+
说明:
|
|
256
|
+
|
|
257
|
+
- 华为云配置可被解析并生成 Terraform HCL 模板,但部署能力尚未实现。
|
|
258
|
+
- 腾讯云没有独立的 API 网关资源,HTTP 入口由函数 URL 触发器提供。
|
|
259
|
+
- 火山引擎暂不支持 Serverless 数据库与数据表。
|
|
260
|
+
- 资源级细节见[完整支持矩阵](https://serverlessinsight.com/reference.html)。
|
|
261
|
+
|
|
262
|
+
## 文档
|
|
263
|
+
|
|
264
|
+
| 资源 | 链接 |
|
|
265
|
+
| ---------------- | ------------------------------------------------------------- |
|
|
266
|
+
| 快速入门 | <https://serverlessinsight.com/getting-started.html> |
|
|
267
|
+
| 配置参考 | <https://serverlessinsight.com/reference.html> |
|
|
268
|
+
| CLI 参考 | <https://serverlessinsight.com/cli.html> |
|
|
269
|
+
| JSON Schema | `si schema`(自包含 draft-07) |
|
|
270
|
+
| 本地开发 | [docs/local-development.md](docs/local-development.md) |
|
|
271
|
+
| 状态锁 | [docs/state-locking.md](docs/state-locking.md) |
|
|
272
|
+
| 架构决策记录 | [docs/adr](docs/adr) |
|
|
273
|
+
| 示例 | [samples](samples) |
|
|
274
|
+
| 更新日志 | [CHANGELOG.md](CHANGELOG.md) |
|
|
275
|
+
| 常见问题 | <https://serverlessinsight.com/faq.html> |
|
|
276
|
+
|
|
277
|
+
## 路线图
|
|
278
|
+
|
|
279
|
+
- 华为云函数部署(模板生成已就绪)
|
|
280
|
+
- AWS、Azure 与 Google Cloud 支持
|
|
281
|
+
- 腾讯云独立 API 网关资源
|
|
282
|
+
- 火山引擎 Serverless 数据库与数据表
|
|
283
|
+
- 更多 Serverless 资源与厂商能力
|
|
284
|
+
|
|
285
|
+
路线图仅表示方向,不构成承诺。欢迎通过 Issue 讨论优先级。
|
|
286
|
+
|
|
287
|
+
## 架构
|
|
195
288
|
|
|
196
289
|
ServerlessInsight 采用**函数式客户端架构**,将云厂商 SDK 与业务逻辑清晰分离:
|
|
197
290
|
|
|
@@ -203,27 +296,29 @@ ServerlessInsight 采用**函数式客户端架构**,将云厂商 SDK 与业
|
|
|
203
296
|
↓
|
|
204
297
|
┌─────────────────────────────────────────┐
|
|
205
298
|
│ Functional Client Layer │ ← 封装的 SDK 操作
|
|
206
|
-
│
|
|
299
|
+
│ (aliyunClient、tencentClient、 │
|
|
300
|
+
│ volcengineClient) │
|
|
207
301
|
└─────────────────────────────────────────┘
|
|
208
302
|
↓
|
|
209
303
|
┌─────────────────────────────────────────┐
|
|
210
|
-
│ Cloud Provider SDKs │ ← @alicloud
|
|
304
|
+
│ Cloud Provider SDKs │ ← @alicloud/*、tencentcloud-*、@volcengine/*
|
|
211
305
|
└─────────────────────────────────────────┘
|
|
212
306
|
```
|
|
213
307
|
|
|
214
308
|
- **函数式且纯粹** —— 业务逻辑使用不可变数据的纯函数
|
|
215
309
|
- **SDK 封装** —— 云厂商 SDK 仅能通过客户端模块访问
|
|
216
|
-
-
|
|
310
|
+
- **函数式优先** —— 优先使用 `type` 而非 `interface`,优先函数而非类,采用声明式集合处理
|
|
217
311
|
|
|
218
312
|
## 开发
|
|
219
313
|
|
|
220
|
-
ServerlessInsight 基于 [Node.js](https://nodejs.org/) + [TypeScript](https://www.typescriptlang.org/)、[Commander.js](https://github.com/tj/commander.js/) CLI
|
|
314
|
+
ServerlessInsight 基于 [Node.js](https://nodejs.org/) + [TypeScript](https://www.typescriptlang.org/)、[Commander.js](https://github.com/tj/commander.js/) CLI 构建,采用函数式架构。
|
|
221
315
|
|
|
222
316
|
### 前置要求
|
|
223
317
|
|
|
224
|
-
- **Node.js** >=
|
|
318
|
+
- **Node.js** >= 22.12
|
|
319
|
+
- **npm**(随 Node.js 附带)
|
|
225
320
|
|
|
226
|
-
###
|
|
321
|
+
### 从源码构建
|
|
227
322
|
|
|
228
323
|
```bash
|
|
229
324
|
git clone https://github.com/geek-fun/serverlessinsight.git
|
|
@@ -235,46 +330,44 @@ npm link
|
|
|
235
330
|
|
|
236
331
|
### 脚本
|
|
237
332
|
|
|
238
|
-
| 命令
|
|
239
|
-
|
|
|
240
|
-
| `npm run build`
|
|
241
|
-
| `npm test`
|
|
242
|
-
| `npm run test:unit` | 仅单元测试
|
|
243
|
-
| `npm run test:service` | 仅服务测试
|
|
244
|
-
| `npm run
|
|
245
|
-
| `npm run lint:
|
|
246
|
-
|
|
247
|
-
### 示例配置
|
|
248
|
-
|
|
249
|
-
```yaml
|
|
250
|
-
version: 0.0.1
|
|
251
|
-
provider:
|
|
252
|
-
name: aliyun
|
|
253
|
-
region: cn-hongkong
|
|
333
|
+
| 命令 | 说明 |
|
|
334
|
+
| ---------------------- | ---------------------- |
|
|
335
|
+
| `npm run build` | TypeScript 编译 |
|
|
336
|
+
| `npm test` | 运行全部测试(含覆盖率) |
|
|
337
|
+
| `npm run test:unit` | 仅单元测试 |
|
|
338
|
+
| `npm run test:service` | 仅服务测试 |
|
|
339
|
+
| `npm run test:ci` | CI 测试运行 |
|
|
340
|
+
| `npm run lint:check` | ESLint 检查 |
|
|
341
|
+
| `npm run lint:fix` | 自动修复 lint 问题 |
|
|
254
342
|
|
|
255
|
-
|
|
343
|
+
测试分为两类:完全隔离并 Mock 外部依赖的快速单元测试,以及运行真实 parser、planner、executor 与状态管理器的服务测试。覆盖率门槛为分支、函数、行与语句四项均达到 85%。
|
|
256
344
|
|
|
257
|
-
|
|
258
|
-
hello_function:
|
|
259
|
-
name: hello-world-fn
|
|
260
|
-
code:
|
|
261
|
-
runtime: nodejs18
|
|
262
|
-
handler: index.handler
|
|
263
|
-
path: ./src
|
|
264
|
-
memory: 512
|
|
265
|
-
timeout: 10
|
|
345
|
+
### 项目结构
|
|
266
346
|
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
347
|
+
```
|
|
348
|
+
src/
|
|
349
|
+
├── commands/ # CLI 命令处理(deploy、destroy、diff、local 等)
|
|
350
|
+
├── common/ # 共享工具、客户端、状态与锁管理
|
|
351
|
+
│ ├── aliyunClient/
|
|
352
|
+
│ ├── tencentClient/
|
|
353
|
+
│ └── volcengineClient/
|
|
354
|
+
├── lang/ # 国际化文案(en.ts、zh-CN.ts)
|
|
355
|
+
├── parser/ # YAML 解析与校验
|
|
356
|
+
├── stack/ # 各云厂商资源逻辑
|
|
357
|
+
│ ├── aliyunStack/
|
|
358
|
+
│ ├── scfStack/ # 腾讯云
|
|
359
|
+
│ ├── volcengineStack/
|
|
360
|
+
│ ├── localStack/ # 本地开发服务
|
|
361
|
+
│ └── rfsStack/ # 华为云 Terraform 模板(预览)
|
|
362
|
+
├── types/ # TypeScript 类型定义
|
|
363
|
+
└── validator/ # JSON Schema 校验
|
|
364
|
+
tests/
|
|
365
|
+
├── fixtures/ # 测试夹具(YAML 配置、制品)
|
|
366
|
+
├── unit/ # 隔离的单元测试
|
|
367
|
+
└── service/ # 端到端服务测试
|
|
275
368
|
```
|
|
276
369
|
|
|
277
|
-
|
|
370
|
+
编码规范、测试规则与架构原则见 [AGENTS.md](AGENTS.md)。
|
|
278
371
|
|
|
279
372
|
## 社区
|
|
280
373
|
|
|
@@ -292,7 +385,11 @@ events:
|
|
|
292
385
|
|
|
293
386
|
## 贡献
|
|
294
387
|
|
|
295
|
-
|
|
388
|
+
欢迎贡献——无论是缺陷反馈、功能建议、文档修正还是代码。
|
|
389
|
+
|
|
390
|
+
- 使用[缺陷报告](.github/ISSUE_TEMPLATE/bug_report.md)或[功能建议](.github/ISSUE_TEMPLATE/feature_request.md)模板提交 Issue。
|
|
391
|
+
- 提交 Pull Request 前,请运行 `npm run lint:check`、`npm run build` 与 `npm test`。
|
|
392
|
+
- 遵循 [AGENTS.md](AGENTS.md) 中的约定以及现有的 [Pull Request 模板](.github/PULL_REQUEST_TEMPLATE.md)。
|
|
296
393
|
|
|
297
394
|
## 赞助
|
|
298
395
|
|
package/dist/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@geek-fun/serverlessinsight",
|
|
3
|
-
"version": "0.9.
|
|
4
|
-
"description": "Full-lifecycle serverless IaC — one
|
|
3
|
+
"version": "0.9.4",
|
|
4
|
+
"description": "Full-lifecycle serverless IaC for Alibaba Cloud, Tencent Cloud and Volcengine — one YAML to define, deploy and operate functions, API gateways, storage and databases.",
|
|
5
5
|
"homepage": "https://serverlessinsight.com",
|
|
6
6
|
"main": "dist/src/index.js",
|
|
7
7
|
"types": "dist/src/index.d.ts",
|
|
@@ -29,28 +29,31 @@
|
|
|
29
29
|
},
|
|
30
30
|
"keywords": [
|
|
31
31
|
"serverless",
|
|
32
|
+
"serverless-framework",
|
|
33
|
+
"serverless-iac",
|
|
34
|
+
"infrastructure-as-code",
|
|
35
|
+
"iac",
|
|
36
|
+
"cli",
|
|
37
|
+
"faas",
|
|
38
|
+
"serverless-functions",
|
|
32
39
|
"serverless-insight",
|
|
33
|
-
"
|
|
34
|
-
"
|
|
35
|
-
"
|
|
36
|
-
"google-cloud-functions",
|
|
37
|
-
"tencent-cloud-functions",
|
|
40
|
+
"multi-cloud",
|
|
41
|
+
"alibaba-cloud",
|
|
42
|
+
"alibaba-serverless",
|
|
38
43
|
"alibaba-cloud-functions",
|
|
39
|
-
"
|
|
44
|
+
"tencent-cloud",
|
|
45
|
+
"tencent-serverless",
|
|
46
|
+
"tencent-cloud-functions",
|
|
47
|
+
"volcengine",
|
|
40
48
|
"volcengine-cloud-functions",
|
|
41
|
-
"serverless-
|
|
42
|
-
"serverless-
|
|
43
|
-
"serverless-
|
|
49
|
+
"serverless-tool",
|
|
50
|
+
"serverless-deploy",
|
|
51
|
+
"serverless-offline",
|
|
44
52
|
"serverless-observability",
|
|
45
53
|
"serverless-tracing",
|
|
46
|
-
"
|
|
47
|
-
"
|
|
48
|
-
"
|
|
49
|
-
"azure",
|
|
50
|
-
"huawei",
|
|
51
|
-
"google",
|
|
52
|
-
"volcengine",
|
|
53
|
-
"function"
|
|
54
|
+
"api-gateway",
|
|
55
|
+
"typescript",
|
|
56
|
+
"devops"
|
|
54
57
|
],
|
|
55
58
|
"dependencies": {
|
|
56
59
|
"@alicloud/alidns20150109": "^4.6.0",
|