Skip to content

Commit 715b31d

Browse files
Create README.md
1 parent ddac853 commit 715b31d

File tree

1 file changed

+124
-0
lines changed

1 file changed

+124
-0
lines changed

docs/zh/README.md

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
## 操作场景
2+
您可以通过如下几步,使用 Serverless Framework 开源 CLI 在腾讯云上部署一个服务,完成配置、创建、测试、部署等步骤。
3+
4+
## 前提条件
5+
在使用之前,请确保如下软件已经安装:
6+
- [Node.js](#node)(6.x或以上的版本)
7+
- [Serverless Framework CLI](#cli)(1.47.0或以上的版本)
8+
9+
如果这些条件已经满足,您可以跳过此步骤,直接 [开始部署一个服务](#buzhou)
10+
11+
12+
<span id="node"></span>
13+
#### 安装 Node.js 和 NPM
14+
15+
- 参考 [Node.js 安装指南](https://nodejs.org/zh-cn/download/) 根据您的系统环境进行安装。
16+
- 安装完毕后,通过`node -v` 命令,查看安装好的 Node.js 版本信息:
17+
```sh
18+
$ node -v
19+
vx.x.x
20+
```
21+
- 通过 `npm -v` 命令,查看安装好的 npm 版本信息:
22+
```sh
23+
$ npm -v
24+
x.x.x
25+
```
26+
27+
<span id="cli"></span>
28+
#### 安装 Serverless Framework CLI
29+
30+
- 在命令行中运行如下命令:
31+
```sh
32+
npm install -g serverless
33+
```
34+
35+
- 安装完毕后,通过运行 `serverless -v` 命令,查看 Serverless Framework CLI 的版本信息。
36+
```sh
37+
$ serverless -v
38+
x.x.x
39+
```
40+
41+
<span id="buzhou"></span>
42+
## 操作步骤
43+
44+
完成上述安装准备后,通过如下步骤开始部署一个 Serverless 服务。
45+
46+
#### 通过模板创建服务
47+
1. 使用 Serverless Framework 的 `tencent-nodejs` 模板创建一个新的服务。
48+
通过运行如下命令进行创建,`--path`可以指定服务的路径:
49+
```sh
50+
# 创建一个serverless服务
51+
$ serverless create --template tencent-nodejs --path my-service
52+
```
53+
2. 安装依赖。
54+
进入服务所在路径,运行如下命令安装依赖:
55+
```sh
56+
$ cd my-service
57+
$ npm install
58+
```
59+
60+
#### 配置账户信息
61+
参考 [配置账号](./配置账号.md) 文档。
62+
63+
#### 配置触发器
64+
云函数需要通过触发器的事件调用进行触发,因此可以在`serverless.yml`中增加对触发器的配置,以 API 网关触发器为例,配置如下:
65+
```yaml
66+
service: my-service # service name
67+
68+
provider: # provider information
69+
name: tencent
70+
runtime: Nodejs8.9
71+
credentials: ~/credentials #密钥配置需要和上一步配置的账户信息文件路径一致
72+
73+
plugins:
74+
- serverless-tencent-scf
75+
76+
functions:
77+
function_one:
78+
handler: index.main_handler
79+
runtime: Nodejs8.9
80+
events:
81+
- apigw:
82+
name: hello_world_apigw
83+
parameters:
84+
stageName: release
85+
serviceId:
86+
httpMethod: ANY
87+
```
88+
89+
#### 部署服务
90+
通过该命令部署或更新您创建的函数和触发器,资源配置会和`serverless.yml`中保持一致。
91+
```bash
92+
serverless deploy
93+
```
94+
更多部署详情参考 [部署服务](./部署服务.md) 文档。
95+
96+
#### 测试服务
97+
98+
替换如下命令中的链接地址,通过 curl 对其进行测试,该链接可以在`sls deploy`命令执行后获取得到。
99+
```bash
100+
$ curl -X POST https://service-xxxx-1300000000.ap-guangzhou.apigateway.myqcloud.com/release/
101+
```
102+
103+
#### 云端调用
104+
105+
通过以下命令云端调用函数并且获得日志信息的返回。
106+
107+
```bash
108+
serverless invoke -f hello
109+
```
110+
更多部署详情参考 [云端调用](./云端调用.md)。
111+
112+
#### 获取函数日志
113+
114+
单独开启一个命令行,通过如下命令,实时获取函数`hello`的云端调用日志信息。
115+
```bash
116+
serverless logs -f hello -t
117+
```
118+
119+
#### 移除服务
120+
121+
如果您不再需要此服务,可以通过如下命令一键移除服务,该命令会清理相应函数和触发器资源。
122+
```sh
123+
serverless remove
124+
```

0 commit comments

Comments
 (0)