Skip to content

Commit 542a119

Browse files
author
dfounderliu
committed
Merge remote-tracking branch 'origin/master' into experience
2 parents 8f57171 + 2f26794 commit 542a119

File tree

5 files changed

+47
-16
lines changed

5 files changed

+47
-16
lines changed

docs/en/yaml.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,7 @@ functions:
8484
# stageName: release
8585
# serviceId:
8686
# httpMethod: ANY
87+
# integratedResponse: true
8788
# - cmq:
8889
# name: cmq_trigger
8990
# parameters:

docs/zh/README.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
## 前提条件
55
在使用之前,请确保如下软件已经安装:
66
- [Node.js](#node)(6.x或以上的版本)
7-
- [Serverless Framework CLI](#cli)(1.47.0或以上的版本)
7+
- [Serverless Framework CLI](#cli)(1.57.0或以上的版本)
88

99
如果这些条件已经满足,您可以跳过此步骤,直接 [开始部署一个服务](#buzhou)
1010

@@ -57,9 +57,6 @@ $ cd my-service
5757
$ npm install
5858
```
5959

60-
#### 配置账户信息
61-
参考 [配置账号](./配置账号.md) 文档。
62-
6360
#### 配置触发器
6461
云函数需要通过触发器的事件调用进行触发,因此可以在`serverless.yml`中增加对触发器的配置,以 API 网关触发器为例,配置如下:
6562
```yaml
@@ -68,13 +65,13 @@ service: my-service # service name
6865
provider: # provider information
6966
name: tencent
7067
runtime: Nodejs8.9
71-
credentials: ~/credentials #密钥配置需要和上一步配置的账户信息文件路径一致
68+
credentials: ~/credentials #如不使用二维码一键登录,密钥字段需要和credentials文件路径一致
7269

7370
plugins:
7471
- serverless-tencent-scf
7572

7673
functions:
77-
hello: # function name
74+
hello_world: # function name
7875
handler: index.main_handler
7976
runtime: Nodejs8.9
8077
events:
@@ -86,11 +83,16 @@ functions:
8683
httpMethod: ANY
8784
```
8885
86+
> 注,Serverless Framework会为控制台中实际部署的函数增加前缀组成函数名称,前缀规范为`service-stage-function`,默认的stage为`dev`。以上述配置为例,配置文件中的函数名称`hello_world`在控制台中的函数名称对应为`my-service-dev-hello_world`。
87+
8988
#### 部署服务
9089
通过该命令部署或更新您创建的函数和触发器,资源配置会和`serverless.yml`中保持一致。
9190
```bash
9291
serverless deploy
9392
```
93+
94+
如您的账号未[登陆](https://cloud.tencent.com/login)或[注册](https://cloud.tencent.com/register)腾讯云,您可以在运行该命令后,直接用`微信`扫描命令中弹出的二维码,对云账户进行授权登陆和注册。
95+
9496
更多部署详情参考 [部署服务](./部署服务.md) 文档。
9597

9698
#### 测试服务
@@ -105,15 +107,15 @@ $ curl -X POST https://service-xxxx-1300000000.ap-guangzhou.apigateway.myqcloud.
105107
通过以下命令云端调用函数并且获得日志信息的返回。
106108

107109
```bash
108-
serverless invoke -f hello
110+
serverless invoke -f hello_world
109111
```
110112
更多部署详情参考 [云端调用](./云端调用.md)。
111113

112114
#### 获取函数日志
113115

114-
单独开启一个命令行,通过如下命令,实时获取函数`hello`的云端调用日志信息。
116+
单独开启一个命令行,输入如下命令,再次云端调用函数,并实时获取函数`hello_world`的云端调用日志信息。
115117
```bash
116-
serverless logs -f hello -t
118+
serverless logs -f hello_world -t
117119
```
118120

119121
#### 移除服务
@@ -122,3 +124,6 @@ serverless logs -f hello -t
122124
```sh
123125
serverless remove
124126
```
127+
128+
#### 配置账户信息
129+
当前默认支持CLI扫描二维码登录,如您希望配置持久的环境变量/秘钥信息,也可以参考 [配置账号](./配置账号.md) 文档。

docs/zh/产品概述.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,18 @@
1-
Serverless Framework 是业界最受欢迎的无服务器应用框架,开发者无需关心底层资源即可部署完整可用的 Serverless 应用架构。Serverless Framework 具有资源编排、自动伸缩、事件驱动等能力,覆盖编码 - 调试 - 测试 - 部署等全生命周期帮助开发者通过联动云资源,迅速地构建 serverless 应用。
1+
Serverless Framework 是业界非常受欢迎的无服务器应用框架,开发者无需关心底层资源即可部署完整可用的 Serverless 应用架构。Serverless Framework 具有资源编排、自动伸缩、事件驱动等能力,覆盖编码、调试、测试、部署等全生命周期帮助开发者通过联动云资源,迅速构建 Serverless 应用。
22

3+
Serverless Framework 是一个 标准化、组件化 的 Serverless 应用开发产品,如下图所示:
34

5+
![Serverless Framework架构图](https://main.qcloudimg.com/raw/2c5d24285f2ea19151635d0352dc2a20.png)
46

5-
## 主要功能
6-
7-
### 应用级框架
7+
## 产品功能
8+
#### 应用级框架
89
Serverless Framework 提供贴合应用场景的框架,开发者根据实际需求选择对应框架后,只需专注于业务逻辑的开发,无需关注底层资源。
910

10-
### 便捷部署
11-
开发者部署应用时,Serverless Framework 会根据应用特性,自动完成云函数API 网关COS 等基础资源的部署和配置。开发者无需再手动部署配置每一项基础资源
11+
#### 便捷部署
12+
开发者部署应用时,Serverless Framework 会根据应用特性,自动完成云函数API 网关COS 等基础资源的部署和配置,无需再手动部署配置每一项基础资源
1213

14+
## 应用场景
15+
#### 一站式体验
16+
通过 Serverless Framework,您可以快速创建 Serverless 应用,并完成应用的调试和部署,监控已发布应用运行状态并快速排障。
17+
Serverless Framework 提供多种 Serverless 应用级别的组件,开发者无需关注 Serverless 应用底层资源,选择并下载符合自己业务场景的组件后,编写个性化的业务逻辑即可。
18+
![](https://main.qcloudimg.com/raw/f4f0af702e134982fd5ef068c31a070e.svg)

docs/zh/常见问题.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@ Serverless Framework 是无服务器应用框架,提供将云函数 SCF ,API
55
### Serverless Framework 提供了哪些应用框架
66
目前已提供 REST API 和 基础 website ,更多贴合实际应用场景的框架在持续输出中。
77

8+
### Serverless Framework 报错 "component" input is requires to run custom methods 怎么处理?
9+
运行Serverless Framework CLI时,如果yaml配置文件中默认引用了component组件,则需要保证文件夹之前为空,才可以正确运行component的安装命令。
10+
您可以尝试在一个空文件夹中重新运行`serverless create`命令,则不会再出现如下错误。
11+
812
### 云函数执行超时怎么处理?
913

1014
超时客户端会直接断开连接并报错,建议控制函数执行时间,尽量不要把耗时长的操作放在客户端直接调用的云函数内。

docs/zh/配置账号.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,19 @@
1-
如果您是首次使用云函数产品,需要前往控制台配置角色授权。
1+
# 微信扫码授权
2+
3+
如您的账号未[登陆](https://cloud.tencent.com/login)[注册](https://cloud.tencent.com/register)腾讯云,您可以在运行`serverless deploy`云端部署命令后,直接用`微信`扫描命令中弹出的二维码,对云账户进行授权登陆和注册。
4+
5+
当前Serverless Framework将获取以下权限:
6+
- COS所有操作
7+
- SCF(云函数)全读写权限
8+
- TAG(标签)全读写权限
9+
- CAM(访问管理)查看角色权限
10+
- CAM(访问管理)创建角色权限
11+
- VPC(私有网络)只读权限
12+
- Monitor(云监控)只读权限
13+
14+
# 账户秘钥配置授权
15+
16+
如您希望配置持久的环境变量/秘钥信息,需要按如下步骤前往控制台配置角色授权。
217

318
## 前提条件
419

0 commit comments

Comments
 (0)