Skip to content

Commit

Permalink
fix: support eip config
Browse files Browse the repository at this point in the history
  • Loading branch information
@yugasun
yugasun committed Aug 6, 2020
1 parent ad546a6 commit fa0358b
Show file tree
Hide file tree
Showing 4 changed files with 246 additions and 54 deletions.
56 changes: 29 additions & 27 deletions docs/configure.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ inputs:
version: 1 # 版本
functionConf: # 函数配置相关
timeout: 10 # 超时时间，单位秒
eip: false # 是否固定出口IP
memorySize: 128 # 内存大小，单位MB
environment: # 环境变量
variables: # 环境变量数组
Expand Down Expand Up @@ -98,8 +99,8 @@ inputs:
| 参数名称 | 是否必选 | 默认值 | 描述 |
| ------------------------------------ | :------: | :-------------: | :------------------------------------------------------------------ |
| runtime | 否 | Nodejs10.15 | 执行环境, 目前支持: Nodejs6.10, Nodejs8.9, Nodejs10.15, Nodejs12.16 |
| region | 否 | ap-guangzhou | 项目部署所在区域，默认广州区 |
| runtime | 否 | `Nodejs10.15` | 执行环境, 目前支持: Nodejs6.10, Nodejs8.9, Nodejs10.15, Nodejs12.16 |
| region | 否 | `ap-guangzhou` | 项目部署所在区域，默认广州区 |
| functionName | 否 | | 云函数名称 |
| serviceName | 否 | | API 网关服务名称, 默认创建一个新的服务名称 |
| serviceId | 否 | | API 网关服务 ID,如果存在将使用这个 API 网关服务 |
Expand All @@ -113,12 +114,12 @@ inputs:

## 执行目录

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

## 层配置

Expand All @@ -133,7 +134,7 @@ inputs:

| 参数名称 | 是否必选 | 类型 | 默认值 | 描述 |
| ---------- | :------: | -------- | :----: | :---------------------------------------------- |
| ttl | 否 | Number | 600 | TTL 值，范围 1 - 604800，不同等级域名最小值不同 |
| ttl | 否 | Number | `600` | TTL 值，范围 1 - 604800，不同等级域名最小值不同 |
| recordLine | 否 | String[] | | 记录的线路名称 |

### 指定区配置
Expand All @@ -148,12 +149,13 @@ inputs:

参考: https://cloud.tencent.com/document/product/583/18586

| 参数名称 | 是否必选 | 类型 | 默认值 | 描述 |
| ----------- | :------: | :----: | :----: | :------------------------------------------------------------------------------ |
| timeout | 否 | Number | 3 | 函数最长执行时间，单位为秒，可选值范围 1-900 秒，默认为 3 秒 |
| memorySize | 否 | Number | 128 | 函数运行时内存大小，默认为 128M，可选范围 64、128MB-3072MB，并且以 128MB 为阶梯 |
| environment | 否 | Object | | 函数的环境变量, 参考 [环境变量](#环境变量) |
| vpcConfig | 否 | Object | | 函数的 VPC 配置, 参考 [VPC 配置](#VPC-配置) |
| 参数名称 | 是否必选 | 类型 | 默认值 | 描述 |
| ----------- | :------: | :-----: | :-----: | :------------------------------------------------------------------------------ |
| timeout | 否 | Number | `3` | 函数最长执行时间，单位为秒，可选值范围 1-900 秒，默认为 3 秒 |
| memorySize | 否 | Number | `128` | 函数运行时内存大小，默认为 128M，可选范围 64、128MB-3072MB，并且以 128MB 为阶梯 |
| environment | 否 | Object | | 函数的环境变量, 参考 [环境变量](#环境变量) |
| vpcConfig | 否 | Object | | 函数的 VPC 配置, 参考 [VPC 配置](#VPC-配置) |
| eip | 否 | Boolean | `false` | 是否固定出口 IP |

##### 环境变量

Expand All @@ -170,16 +172,16 @@ inputs:

### API 网关配置

| 参数名称 | 是否必选 | 类型 | 默认值 | 描述 |
| -------------- | :------: | :------- | :------- | :--------------------------------------------------------------------------------- |
| protocols | 否 | String[] | ['http'] | 前端请求的类型，如 http，https，http 与 https |
| environment | 否 | String | release | 发布环境. 目前支持三种发布环境: test（测试）, prepub（预发布） 与 release（发布）. |
| usagePlan | 否 | | | 使用计划配置, 参考 [使用计划](#使用计划) |
| auth | 否 | | | API 密钥配置, 参考 [API 密钥](#API-密钥配置) |
| customDomain | 否 | Object[] | | 自定义 API 域名配置, 参考 [自定义域名](#自定义域名) |
| enableCORS | 否 | Boolean | `false` | 开启跨域。默认值为否。 |
| serviceTimeout | 否 | Number | `15` | Api 超时时间，单位: 秒 |
| isDisabled | 否 | Boolean | `false` | 关闭自动创建 API 网关功能。默认值为否，即默认自动创建 API 网关。 |
| 参数名称 | 是否必选 | 类型 | 默认值 | 描述 |
| -------------- | :------: | :------- | :--------- | :--------------------------------------------------------------------------------- |
| protocols | 否 | String[] | `['http']` | 前端请求的类型，如 http，https，http 与 https |
| environment | 否 | String | `release` | 发布环境. 目前支持三种发布环境: test（测试）, prepub（预发布） 与 release（发布）. |
| usagePlan | 否 | | | 使用计划配置, 参考 [使用计划](#使用计划) |
| auth | 否 | | | API 密钥配置, 参考 [API 密钥](#API-密钥配置) |
| customDomain | 否 | Object[] | | 自定义 API 域名配置, 参考 [自定义域名](#自定义域名) |
| enableCORS | 否 | Boolean | `false` | 开启跨域。默认值为否。 |
| serviceTimeout | 否 | Number | `15` | Api 超时时间，单位: 秒 |
| isDisabled | 否 | Boolean | `false` | 关闭自动创建 API 网关功能。默认值为否，即默认自动创建 API 网关。 |

##### 使用计划

Expand All @@ -190,7 +192,7 @@ inputs:
| usagePlanId | 否 | String | 用户自定义使用计划 ID |
| usagePlanName | 否 | String | 用户自定义的使用计划名称 |
| usagePlanDesc | 否 | String | 用户自定义的使用计划描述 |
| maxRequestNum | 否 | Int | 请求配额总数，如果为空，将使用-1 作为默认值，表示不开启 |
| maxRequestNum | 否 | Number | 请求配额总数，如果为空，将使用-1 作为默认值，表示不开启 |

##### API 密钥配置

Expand All @@ -209,7 +211,7 @@ Refer to: https://cloud.tencent.com/document/product/628/14906
| ---------------- | :------: | :------: | :----: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| domain | 是 | String | | 待绑定的自定义的域名。 |
| certificateId | 否 | String | | 待绑定自定义域名的证书唯一 ID，如果设置了 type 为 https，则为必选 |
| isDefaultMapping | 否 | String | `true` | 是否使用默认路径映射，默认为 true。为 false 时，表示自定义路径映射，此时 pathMappingSet 必填。 |
| isDefaultMapping | 否 | String | `true` | 是否使用默认路径映射。为 false 时，表示自定义路径映射，此时 pathMappingSet 必填。 |
| pathMappingSet | 否 | Object[] | `[]` | 自定义路径映射的路径。使用自定义映射时，可一次仅映射一个 path 到一个环境，也可映射多个 path 到多个环境。并且一旦使用自定义映射，原本的默认映射规则不再生效，只有自定义映射路径生效。 |
| protocol | 否 | String[] | | 绑定自定义域名的协议类型，默认与服务的前端协议一致。 |

Expand Down
Loading

0 comments on commit fa0358b

Please sign in to comment.