Skip to content

Commit 734777c

Browse files
committed
chore: update docs
Signed-off-by: Xie Zhihao <[email protected]>
1 parent 48e7cf1 commit 734777c

File tree

3 files changed

+24
-12
lines changed

3 files changed

+24
-12
lines changed

docs/content/9.deploy/1.from-scratch.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,19 @@ Run python `deploy.py` for deployment on Volcengine FaaS platform.
3131
它会提示你输入如下几个参数:
3232

3333
- 本地项目名称(即项目的本地目录名称)
34-
- VeFaaS应用名称(不可带下划线)
35-
- 火山引擎网关实例名称(可选)
36-
- 火山引擎网关服务名称(可选)
37-
- 火山引擎网关Upstream名称(可选)
34+
- 火山引擎函数服务应用名称(不可带下划线)
35+
- 火山引擎API网关实例名称(可选)
36+
- 火山引擎API网关服务名称(可选)
37+
- 火山引擎API网关Upstream名称(可选)
3838
- 部署模式
3939
1. A2A / MCP Server
4040
2. VeADK Web
41+
- 认证方式
42+
1. 不认证
43+
2. API key(仅限A2A / MCP Server的部署模式)
44+
3. OAuth2
45+
- 火山引擎Identity用户池名称(可选)
46+
- 火山引擎Identity客户端名称(可选,仅限VeADK Web的部署模式)
4147

4248
生成后的项目结构如下:
4349

docs/content/9.deploy/2.from-proj.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,13 @@ navigation:
2121
| - | - | - |
2222
| `--access-key` | 字符串 | 火山引擎AK |
2323
| `--secret-key` | 字符串 | 火山引擎SK |
24-
| `--vefaas-app-name` | 字符串 | 火山引擎 VeFaaS 平台应用名称 |
25-
| `--veapig-instance-name` | 字符串 | 火山引擎 APIG 实例名称 |
26-
| `--veapig-service-name` | 字符串 | 火山引擎 APIG 服务名称 |
27-
| `--veapig-upstream-name` | 字符串 | 火山引擎 APIG Upstream 名称 |
24+
| `--vefaas-app-name` | 字符串 | 火山引擎函数服务应用名称 |
25+
| `--veapig-instance-name` | 字符串 | 火山引擎 API 网关实例名称 |
26+
| `--veapig-service-name` | 字符串 | 火山引擎 API 网关服务名称 |
27+
| `--veapig-upstream-name` | 字符串 | 火山引擎 API 网关 Upstream 名称 |
2828
| `--short-term-memory-backend` | `local` \| `mysql` | 短期记忆后端 |
2929
| `--use-adk-web` | FLAG | 设置后将会在云端启动 web,否则为 A2A / MCP 模式 |
3030
| `--path` | 字符串 | 本地项目路径,默认为当前目录 |
31+
| `--auth-method` | `none` \| `api-key` \| `oauth2` | 认证方式 |
32+
| `--user-pool-name` | 字符串 | 火山引擎 Identity 用户池名称 |
33+
| `--client-name` | 字符串 | 火山引擎 Identity 客户端名称 |

docs/content/9.deploy/3.from-code.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,14 @@ cloud_app = engine.deploy(...)
2828
| 参数名称 | 类型 | 说明 |
2929
| --- | --- | --- |
3030
| path | str | 本地Agent项目路径 |
31-
| application_name | str | 云应用名称 |
32-
| gateway_name | str | 火山引擎网关实例名称 |
33-
| gateway_service_name | str | 火山引擎网关服务名称 |
34-
| gateway_upstream_name | str | 火山引擎网关Upstream名称 |
31+
| application_name | str | 函数服务应用名称 |
32+
| gateway_name | str | 火山引擎 API 网关实例名称 |
33+
| gateway_service_name | str | 火山引擎 API 网关服务名称 |
34+
| gateway_upstream_name | str | 火山引擎 API 网关Upstream名称 |
3535
| use_adk_web | bool | 是否在云端使用VeADK Web / Google Web |
36+
| auth_method | str | 认证方式 |
37+
| identity_user_pool_name | str | 火山引擎 Identity 用户池名称 |
38+
| identity_client_name | str | 火山引擎 Identity 客户端名称 |
3639

3740
### Cloud App
3841

0 commit comments

Comments
 (0)