Skip to content

Commit 363160a

Browse files
yugasunyugasun
committed
docs: update configure document
1 parent 305afcf commit 363160a

File tree

1 file changed

+32
-37
lines changed

1 file changed

+32
-37
lines changed

‎docs/configure.md‎

Lines changed: 32 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,18 @@
66
# serverless.yml
77

88
component: flask # (必选) 组件名称，在该实例中为flask
9-
name: flashDemo # (必选) 组件实例名称.
9+
name: flaskDemo # 必选) 组件实例名称.
1010
org: orgDemo # (可选) 用于记录组织信息，默认值为您的腾讯云账户 appid，必须为字符串
1111
app: appDemo # (可选) 用于记录组织信息. 默认与name相同，必须为字符串
1212
stage: dev # (可选) 用于区分环境信息，默认值是 dev
1313

1414
inputs:
15-
src: # 打包src对应目录下的代码上传到默认cos上
16-
hook: 'pip install -r requirements.txt -t ./' # (可选) 安装python相关依赖，每次执行部署前都会构建代码并放到当前目录下
17-
dist: ./ # (可选) 要上传的源码的路径，默认为一个hello world app
18-
exclude: # (可选) 被排除的文件或目录
19-
- .env
20-
# src: ./src # 第一种为string时，会打包src对应目录下的代码上传到默认cos上。
15+
region: ap-guangzhou # 云函数所在区域
16+
functionName: flaskDemo # 云函数名称
17+
serviceName: mytest # api网关服务名称
18+
runtime: Nodejs10.15 # 运行环境
19+
serviceId: service-np1uloxw # api网关服务ID
20+
src: ./src # 第一种为string时，会打包src对应目录下的代码上传到默认cos上。
2121
# src: # 第二种，部署src下的文件代码，并打包成zip上传到bucket上
2222
# src: ./src # 本地需要打包的文件目录
2323
# bucket: bucket01 # bucket name，当前会默认在bucket name后增加 appid 后缀, 本例中为 bucket01-appid
@@ -27,34 +27,30 @@ inputs:
2727
# src: # 第三种，在指定存储桶bucket中已经存在了object代码，直接部署
2828
# bucket: bucket01 # bucket name，当前会默认在bucket name后增加 appid 后缀, 本例中为 bucket01-appid
2929
# object: cos.zip # bucket key 指定存储桶内的文件
30-
region: ap-guangzhou # 云函数所在区域
31-
functionName: expressDemo # 云函数名称
32-
serviceName: mytest # api网关服务名称
33-
runtime: Python3.6 # 运行环境
34-
serviceId: service-np1uloxw # api网关服务ID
3530
layers:
3631
- name: layerName # layer名称
3732
version: 1 # 版本
33+
traffic: 0.9 # 配置默认流量中 $LATEST 版本比重：0 - 1
3834
functionConf: # 函数配置相关
3935
timeout: 10 # 超时时间，单位秒
4036
memorySize: 128 # 内存大小，单位MB
4137
environment: # 环境变量
4238
variables: # 环境变量数组
4339
TEST: vale
4440
vpcConfig: # 私有网络配置
45-
subnetId: '' # 私有网络的Id
46-
vpcId: '' # 子网ID
41+
vpcId: '' # 私有网络的Id
42+
subnetId: '' # 子网ID
4743
apigatewayConf: # api网关配置
4844
isDisabled: false # 是否禁用自动创建 API 网关功能
4945
enableCORS: true # 允许跨域
5046
customDomains: # 自定义域名绑定
5147
- domain: abc.com # 待绑定的自定义的域名
5248
certificateId: abcdefg # 待绑定自定义域名的证书唯一 ID
53-
# 自定义路径映射的路径。使用自定义映射时，可一次仅映射一个 path 到一个环境，也可映射多个 path 到多个环境。并且一旦使用自定义映射，原本的默认映射规则不再生效，只有自定义映射路径生效
49+
# 自定义路径映射的路径。使用自定义映射时，可一次仅映射一个 path 到一个环境，也可映射多个 path 到多个环境。并且一旦使用自定义映射，原本的默认映射规则不再生效，只有自定义映射路径生效。
5450
pathMappingSet:
5551
- path: /
5652
environment: release
57-
protocols: # 绑定自定义域名的协议类型，默认与服务的前端协议一致
53+
protocols: # 绑定自定义域名的协议类型，默认与服务的前端协议一致。
5854
- http # 支持http协议
5955
- https # 支持https协议
6056
protocols:
@@ -77,30 +73,29 @@ inputs:
7773
7874
主要的参数
7975
80-
| 参数名称 | 是否必选 | 默认值 | 描述 |
81-
| ------------------------------------ | :------: | :-------------: | :------------------------------------------------------------- |
82-
| runtime | 否 | Python3.6 | 执行环境, 目前支持: Python3.x |
83-
| region | 否 | ap-guangzhou | 项目部署所在区域，默认广州区 |
84-
| functionName | 否 | | 云函数名称 |
85-
| serviceName | 否 | | API 网关服务名称, 默认创建一个新的服务名称 |
86-
| serviceId | 否 | | API 网关服务 ID,如果存在将使用这个 API 网关服务 |
87-
| src | 否 | `process.cwd()` | 默认为当前目录, 如果是对象, 配置参数参考 [执行目录](#执行目录) |
88-
| layers | 否 | | 云函数绑定的 layer, 配置参数参考 [层配置](#层配置) |
89-
| exclude | 否 | | 不包含的文件 |
90-
| include | 否 | | 包含的文件, 如果是相对路径，是相对于 `serverless.yml`的路径 |
91-
| [functionConf](#函数配置) | 否 | | 函数配置 |
92-
| [apigatewayConf](#API-网关配置) | 否 | | API 网关配置 |
93-
| [cloudDNSConf](#DNS-配置) | 否 | | DNS 配置 |
94-
| [Region special config](#指定区配置) | 否 | | 指定区配置 |
76+
| 参数名称 | 是否必选 | 默认值 | 描述 |
77+
| ------------------------------------ | :------: | :-------------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
78+
| runtime | 否 | Python3.6 | 执行环境, 目前支持: Python3.6, Python2.7 |
79+
| region | 否 | ap-guangzhou | 项目部署所在区域，默认广州区 |
80+
| functionName | 否 | | 云函数名称 |
81+
| serviceName | 否 | | API 网关服务名称, 默认创建一个新的服务名称 |
82+
| serviceId | 否 | | API 网关服务 ID,如果存在将使用这个 API 网关服务 |
83+
| src | 否 | `process.cwd()` | 默认为当前目录, 如果是对象, 配置参数参考 [执行目录](#执行目录) |
84+
| layers | 否 | | 云函数绑定的 layer, 配置参数参考 [层配置](#层配置) |
85+
| traffic | 否 | 1 | 配置默认流量中 `$LATEST` 版本比重，取值范围：0 ~ 1，比如 80%，可配置成 0.8。注意如果配置灰度流量，需要配置对应的 API 网关触发器的 endpoints 的 `function.functionQualifier` 参数为 `$DEFAULT` (默认流量) |
86+
| [functionConf](#函数配置) | 否 | | 函数配置 |
87+
| [apigatewayConf](#API-网关配置) | 否 | | API 网关配置 |
88+
| [cloudDNSConf](#DNS-配置) | 否 | | DNS 配置 |
89+
| [Region special config](#指定区配置) | 否 | | 指定区配置 |
9590

9691
## 执行目录
9792

98-
| 参数名称 | 是否必选 | 类型 | 默认值 | 描述 |
99-
| -------- | -------- | --------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
100-
| src | 否 | String | | 代码路径。与 object 不能同时存在。 |
101-
| exclude | 否 | Array of String | | 不包含的文件或路径, 遵守 [glob 语法](https://github.com/isaacs/node-glob) |
102-
| bucket | 否 | String | | bucket 名称。如果配置了 src，表示部署 src 的代码并压缩成 zip 后上传到 bucket-appid 对应的存储桶中；如果配置了 object,表示获取 bucket-appid 对应存储桶中 object 对应的代码进行部署。 |
103-
| object | 否 | String | | 部署的代码在存储桶中的路径。 | |
93+
| 参数名称 | 是否必选 | 类型 | 默认值 | 描述 |
94+
| -------- | :------: | :-------------: | :----: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
95+
| src | 否 | String | | 代码路径。与 object 不能同时存在。 |
96+
| exclude | 否 | Array of String | | 不包含的文件或路径, 遵守 [glob 语法](https://github.com/isaacs/node-glob) |
97+
| bucket | 否 | String | | bucket 名称。如果配置了 src，表示部署 src 的代码并压缩成 zip 后上传到 bucket-appid 对应的存储桶中；如果配置了 object，表示获取 bucket-appid 对应存储桶中 object 对应的代码进行部署。 |
98+
| object | 否 | String | | 部署的代码在存储桶中的路径。 |
10499

105100
## 层配置
106101

0 commit comments

Comments
 (0)