2 Star 1 Fork 1

Serverless Framework / Documentation

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
该仓库未声明开源许可证文件(LICENSE),使用请关注具体项目描述及其代码上游依赖。
克隆/下载
yml 文件规范.md 4.91 KB
一键复制 编辑 原始数据 按行查看 历史
April 提交于 2020-11-22 04:00 . Update yml 文件规范.md

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

基本信息

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

#应用组织信息(可选)
org: '' # 组织名称。留空则则使用默认值为用户appid
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 各个组件的全量配置信息列表如下:

基础组件

组件名称 全量配置
SCF 组件 serverless.yml 全量配置
Website 组件 serverless.yml 全量配置
API 网关组件 serverless.yml 全量配置
VPC 组件 serverless.yml 全量配置
COS 组件 serverless.yml 全量配置
PostgreSQL 组件 serverless.yml 全量配置
CynosDB 组件 serverless.yml 全量配置
CDN 组件 serverless.yml 全量配置
Layer 组件 serverless.yml 全量配置

框架组件

组件名称 全量配置
Express 组件 serverless.yml 全量配置
Koa 组件 serverless.yml 全量配置
Egg 组件 serverless.yml 全量配置
Next.js 组件 serverless.yml 全量配置
Nuxt.js 组件 serverless.yml 全量配置
Flask 组件 serverless.yml 全量配置
Django 组件 serverless.yml 全量配置
Laravel 组件 serverless.yml 全量配置
ThinkPHP 组件 serverless.yml 全量配置
1
https://gitee.com/serverless-framework/documentation.git
git@gitee.com:serverless-framework/documentation.git
serverless-framework
documentation
Documentation
main

搜索帮助