我们可以使用 @malagu/fc-adapter 组件把应用部署到阿里云函数计算平台。基于约定大于配置原则,零配置,开箱即用。

云资源

适配器组件有一套默认的部署规则,该规则可以被覆盖。适配器组件在执行部署任务的时候,使用平台提供的 SDK,根据部署规则,创建需要的云资源。如果发现云资源已经存在,则差异更新云资源。适配器组件总是以尽可能安全的方式,创建或更新我们的云资源。比如,当我们配置了自定义域名,适配器组件则尝试创建或更新该自定义域名资源。

适配器组件将应用部署到一个函数中,也就是说一个应用对应着一个函数,如果我们的应用很大,我们应该将大应用拆解成一个个小的微应用或者微服务。就像微服务架构的粒度拆分原则一样,合理的粒度拆分,对我们的应用管理是有很多好处的。框架会保证一个应用在一个函数中的运行性能。

环境隔离

在 Malagu 框架中,提供了一个顶级配置属性 stage 表示环境。而在 @malagu/fc-adapter 组件约定的部署规则中,为了简化环境配置,使用 mode 属性映射 stage 属性。默认提供了三套环境:测试、预发和生产。表达式规则如下:

  1. stage: "${'test' in mode ? 'test' : 'pre' in mode ? 'pre' : 'prod' in mode ? 'prod' : cliContext.prod ? 'prod' : 'test'}" # test, pre, prod

stage 取值规则如下:

  • test 测试环境。当 mode 属性包含 test 模式,或者 mode 都不包含 test、pre、prod,且命令行参数 -p,--prod 没有被指定
  • pre 预发环境。当 mode 属性包含 pre 模式
  • prod 生产环境。当 mode 属性包含 prod 模式,或者命令行参数 -p,--prod 被指定

通过指定特殊的 mode 表示不同的部署环境:

  1. # 部署到测试环境
  2. malagu deploy -m test # 或者 malagu deploy
  3. # 部署到预发环境,我们也可以直接跳过预发环境的部署,直接部署到生产环境
  4. malagu deploy -m pre
  5. # 部署到生成环境
  6. malagu deploy -m prod

隔离级别

环境的隔离级别是可控制的。我们可以使用账号隔离环境:不同环境对于不同配置文件,不同配置文件分别配置不同的云账号。同理,我们也可以使用 Region、服务别名来隔离环境。框架默认提供的是服务别名隔离环境。隔离方式可以互相叠加。

stage 属性值与服务别名关联(以下是默认规则,无需配置):

  1. malagu:
  2. faas-adapter:
  3. alias:
  4. name: ${stage}

如果我们使用 API 网关的方式部署函数,与 API 网关的 stage 关联(以下是默认规则,无需配置):

  1. malagu:
  2. faas-adapter:
  3. apiGateway:
  4. stage:
  5. name: "${stage != 'prod' ? 'release' : stage}"

部署类型

适配器组件通过 type 属性定义部署类型,支持的部署类型如下:

  • **api-gateway** 基于 API 网关的部署类型。部署过程中,创建或更新 API 网关、服务、函数等云资源
  • **http** HTTP 触发器 + HTTP 函数。部署过程中,创建或更新 HTTP 触发器、服务、函数、自定义域名等云资源
  • **custom** 默认值,HTTP 触发器 + Custom 函数(推荐)。部署过程中,创建或更新 HTTP 触发器、服务、函数、自定义域名等云资源
    1. malagu:
    2. faas-adapter:
    3. type: custom

自定义部署规则

我们可以通过同名覆盖自定义部署规则。

默认规则

默认规则定义在 @malagu/fc-adapter 组件的 malagu-remote.yml 配置文件中。

自定义部署类型

  1. malagu:
  2. faas-adapter:
  3. type: api-gateway # 默认值是 custom,支持 custom、api-gateway、http

自定义服务名

  1. malagu:
  2. faas-adapter:
  3. service:
  4. name: xxxx # 默认值是 malagu

服务的其他属性也是类似的方式配置。

自定义函数名

  1. malagu:
  2. faas-adapter:
  3. function:
  4. name: xxxx # 默认值是 ${pkg.name}

函数的其他属性也是类似的方式配置。

属性配置

TODO