配置文档

全部配置

# serverless.yml

org: orgDemo # (可选) 用于记录组织信息，默认值为您的腾讯云账户 appid，必须为字符串
app: appDemo # (可选) 用于记录组织信息. 默认与name相同，必须为字符串
stage: dev # (可选) 用于区分环境信息，默认值是 dev

component: framework # (必选) 组件名称，在该实例中为framework
name: frameworkDemo # 必选) 组件实例名称.

inputs:
  framework: express
  region: ap-guangzhou # 云函数所在区域
  entryFile: sls.js # 自定义 server 的入口文件名，默认为 sls.js，如果不想修改文件名为 sls.js 可以自定义
  src:
    src: ./ # 本地需要打包的文件目录
    exclude: # 被排除的文件或目录
      - .env
      # - 'node_modules/**'
  faas: # 函数配置相关
    name: frameworkDemo # 云函数名称
    projectName: djangodemo # 此参数只有在 framework 为 django 时必须配置
    runtime: Nodejs10.15 # 运行环境
    timeout: 10 # 超时时间，单位秒
    eip: false # 是否固定出口IP
    memorySize: 128 # 内存大小，单位MB
    environments: #  环境变量
      - key: TEST
        value: 123
    vpc: # 私有网络配置
      vpcId: vpc-xxxx # 私有网络的Id
      subnetId: subnet-xxxx # 子网ID
    layers:
      - name: layerName #  layer名称
        version: 1 #  版本
  apigw: #  api网关配置
    isDisabled: false # 是否禁用自动创建 API 网关功能
    id: service-xxx # api网关服务ID
    name: mytest # api网关服务名称
    description: mytest # api网关描述
    cors: true #  允许跨域
    protocols:
      - http
      - https
    environment: test
    timeout: 15
    customDomains: # 自定义域名绑定
      - domain: abc.com # 待绑定的自定义的域名
        certId: abcdefg # 待绑定自定义域名的证书唯一 ID
        customMap: true # 是否自定义路径
        pathMap:
          - path: /
            environment: release
        protocols: # 绑定自定义域名的协议类型，默认与服务的前端协议一致。
          - http
          - https
  # 项目中静态资源自动托管到对象存储
  static:
    cos:
      bucket: static-bucket
      acl:
        permissions: public-read
      sources:
        - src: .next/static
          targetDir: /_next/static
        - src: public
          targetDir: /
    cdn:
      area: mainland
      domain: abc.com
      autoRefresh: true
      refreshType: delete
      https:
        http2: on
        certId: 'abc'
      forceRedirect:
        switch: on
        redirectType: https
        redirectStatusCode: 301

配置描述

主要的参数

参数名称	必选	类型	默认值	描述
framework	是	string		项目使用的框架
src	是	Src 或者 string		代码目录, 如果是对象
region	否		`ap-guangzhou`	项目部署所在区域
entryFile	否		`sls.js`	自定义 server 的入口文件名
faas	否	FaasConfig		函数配置
apigw	否	ApigwConfig		API 网关配置
static	否	StaticConfig		静态资源 CDN 配置

注意：目前 framework 支持 Web 框架有 express、koa、egg、next、nuxt、nest、laravel、thinkphp、flask、django。

Src

执行目录

参数名称	必选	类型	描述
src	否	string	代码路径。与 obejct 不能同时存在。
exclude	否	string[]	不包含的文件或路径, 遵守 glob 语法
bucket	否	string	bucket 名称。
obejct	否	string	部署的代码在存储桶中的路径。

注意：如果配置了 src，表示部署 src 的代码并压缩成 zip 后上传到 bucket-appid 对应的存储桶中；如果配置了 obejct，表示获取 bucket-appid 对应存储桶中 obejct 对应的代码进行部署。

比如需要忽略项目的 node_modules 目录，可以配置如下：

exclude:
  - 'node_modules/**'

FaasConfig

函数配置，参考: https://cloud.tencent.com/document/product/583/18586

参数名称	必选	类型	默认值	描述
runtime	否	string	`Nodejs10.15`	执行环境, 目前支持: Nodejs6.10, Nodejs8.9, Nodejs10.15, Nodejs12.16
name	否	string		云函数名称
projectName	否			Django 初始化的项目名称，只有在 `framework` 为 `django` 时必须
timeout	否	number	`3`	函数最长执行时间，单位为秒，可选值范围 1-900 秒，默认为 3 秒
memorySize	否	number	`128`	函数运行时内存大小，可选范围 64、128MB-3072MB，并且以 128MB 为阶梯
environments	否	Env[]		函数的环境变量
vpc	否	Vpc		函数的 VPC 配置
eip	否	boolean	`false`	是否固定出口 IP
layers	否	Layer[]		云函数绑定的 layer

此处只是列举，faas 参数支持 scf 组件的所有基础配置（ events 除外）

Env

环境变量

参数名称	类型	描述
key	string	环境变量 key
value string	环境变量 value

Vpc

VPC - 私有网络

参数名称	类型	描述
vpcId	string	VPC ID
subnetId	string	子网 ID

Layer

层配置

参数名称	类型	描述
name	string	层名称
version	string	层版本

ApigwConfig

API 网关配置

参数名称	必选	类型	默认值	描述
id	否			API 网关服务 ID,如果存在将使用这个 API 网关服务
name	否		`serverless`	API 网关服务名称, 默认创建一个新的服务名称
description	否			API 网关服务描述
protocols	否	string[]	`['http']`	前端请求的类型，如 http，https，http 与 https
environment	否	string	`release`	发布环境. 目前支持三种发布环境: test、prepub、release.
cors	否	boolean	`false`	开启跨域。默认值为否。
timeout	否	number	`15`	Api 超时时间，单位: 秒
isDisabled	否	boolean	`false`	关闭自动创建 API 网关功能。默认值为否，即默认自动创建 API 网关。
customDomains	否	CustomDomain[]		自定义 API 域名配置

CustomDomain

自定义域名配置，相关文档: https://cloud.tencent.com/document/product/628/14906

参数名称	必选	类型	默认值	描述
domain	是	string		待绑定的自定义的域名。
certId	否	string		待绑定自定义域名的证书唯一 ID，如果设置了 type 为 `https`，则为必选
customMap	否	string	`false`	是否自定义路径映射。为 `true` 时，表示自定义路径映射，此时 `pathMap` 必填。
pathMap	否	PathMap[]	`[]`	自定义路径映射的路径。
protocol	否	string[]		绑定自定义域名的协议类型，默认与服务的前端协议一致。

PathMap

自定义路径映射

参数名称	必选	类型	Description
path	是	string	自定义映射路径
environment	是	string	自定义映射环境

使用自定义映射时，可一次仅映射一个 path 到一个环境，也可映射多个 path 到多个环境。并且一旦使用自定义映射，原本的默认映射规则不再生效，只有自定义映射路径生效。

StaticConfig

静态资源 CDN 配置

参数名称	必选	类型	默认值	描述
cos	是	CosConfig		COS 配置
cdn	否	CdnConfig		CDN 配置

CosConfig

COS 配置

参数名称	必选	类型	描述
bucket	是	string	COS 存储同名称，没有将自动创建
acl	否	AclConfig	存储桶权限配置
sources	否	SourceConfig[]	需要托管到 COS 的静态资源目录

默认的 sources:

[{ "src": "public", "target": "/" }]

AclConfig

COS 访问控制

参数名称	必选	类型	默认值	描述
permissions	是	string	`public-read`	公共权限配置

SourceConfig

静态资源目录配置，可以根据个人需要自定义需要托管到 COS 的静态资源目录

参数名称	必选	类型	默认值	描述
src	是	string		源目录
target	是	string		目标目录

CdnConfig

CDN 配置

参数名称	必选	类型	默认值	描述
domain	是	string		CDN 域名
area	否	string	`mainland`	加速区域，mainland: 大陆，overseas：海外，global：全球加速
autoRefresh	否	boolean	`true`	是否自动刷新 CDN
refreshType	否	boolean	`delete`	CDN 刷新类型，delete：刷新全部资源，flush：刷新变更资源
https	否	Https		https 配置
forceRedirect	否	ForceRedirect		访问协议强制跳转配置

Https

HTTPS 相关配置

参数名称	必选	类型	默认值	描述
certId	是	string		腾讯云托管域名证书 ID
http2	是	string		是否开启 HTTP2，on：开启，off：关闭

ForceRedirect

访问协议强制跳转配置

参数名称	必选	类型	默认值	描述
switch	是	string	`on`	访问强制跳转配置开关, on：开启，off：关闭
redirectType	是	string	`http`	访问强制跳转类型，http：强制 http 跳转，https：强制 https 跳转
redirectStatusCode	是	number	`301`	强制跳转时返回状态码，支持 301、302

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

configure.md

configure.md

配置文档

全部配置

配置描述

Src

FaasConfig

Env

Vpc

Layer

ApigwConfig

CustomDomain

PathMap

StaticConfig

CosConfig

AclConfig

SourceConfig

CdnConfig

Https

ForceRedirect

Files

configure.md

Latest commit

History

configure.md

File metadata and controls

配置文档

全部配置

配置描述

Src

FaasConfig

Env

Vpc

Layer

ApigwConfig

CustomDomain

PathMap

StaticConfig

CosConfig

AclConfig

SourceConfig

CdnConfig

Https

ForceRedirect