tencent cloud

文档反馈

yml 文件规范

最后更新时间:2021-03-05 15:25:51

    Serverless Framework 通过项目配置文件 serverless.yml 完成应用的类型识别与资源配置,本地开发完成后的项目,必须先配置 yml 文件,才可以通过运行 sls deploy 命令,将 serverless.yml 中的配置文件和 inputs 中指定参数或代码目录会都被传入 Serverless Components 部署引擎中,从而完成云端部署。

    基本信息

    一个基本的 serverless.yml 文件里,第一层配置字段为以下内容:

    #应用组织信息(可选)
    app: '' # 应用名称。留空则默认取当前组件的实例名称为app名称。
    stage: '' # 环境名称。默认值是 dev。建议使用 ${env.STAGE} 变量定义环境名称
    
    #组件信息
    component: scf # (必选) 组件名称,在该实例中为 scf
    name: scfdemo # (必选) 组件实例名称。
    
    #组件参数配置,根据每个组件,实现具体的资源信息配置
    inputs:
    

    详细配置

    inputs 字段里,根据每个组件创建的云上资源,会进行对应的信息配置,此处以 云函数 SCF 组件 为例,input 字段内的二级目录如下:

    inputs:
      name: xxx # 云函数名称,默认为 ${name}-${stage}-${app}
      src: ./src # 项目代码路径,默认写法,新建特定命名的 COS Bucket 并上传
      handler: index.main_handler #入口
      runtime: Nodejs10.15 # 运行环境 默认 Nodejs10.15
      region: ap-guangzhou # 函数所在区域
      description: This is a function in ${app} application.
      environment: #  环境变量
        variables: #  环境变量对象
          TEST: value
      layers: #layer配置
        - name: scfLayer #  layer名称
          version: 1 #  版本
      events: # 触发器配置
        - timer: # 定时触发器
            parameters:
              cronExpression: '*/5 * * * * * *' # 每5秒触发一次
              enable: true

    全量配置列表

    目前 Serverless Framework 各个组件的全量配置信息列表如下:

    基础组件

    框架组件

    联系我们

    联系我们,为您的业务提供专属服务。

    技术支持

    如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

    7x24 电话支持