腾讯云 Severless-Express 项目开发和灰度发布最佳实践

发布于

Serverless 应用基本概念

一个 Serverless 应用是由单个或者多个组件实例构成的。每个组件中都会有一个 serverless.yml 文件，该文件定义了组件的一些参数，这些参数在部署时用于生成实例的信息。例如 region 参数，定义了资源的所在区。

组织是在 Serverless 应用上层的概念，主要是为了管理。例如，一个公司会有不同部门进行 Serverless 应用开发，设置不同组织名称，方便做后期的权限管理。

示例：开发一个 express 应用，最基本的是引入 express 组件，业务中间可能会涉及到其他一些云产品（如对象存储 COS），所以整个应用目录如下：

Serverless.yml 文件

serverless.yml 文件中定义了应用组织描述及组件 inputs 参数，每次部署时会根据 serverless.yml 文件中的配置信息进行资源的创建、更新和编排。

一份简单的 serverless.yml 文件如下：

代码语言：javascript
复制
# serverless.yml

org: xxx-department #  用于记录组织信息,默认为您的腾讯云 APPID

app: expressDemoApp #  应用名称，默认为与组件实例名称

stage: ${env:STAGE} #  用于开发环境的隔离，默认为 dev


component: express # (必填) 引用 component 的名称，当前用到的是 express-tencent 组件

name: expressDemo # (必填) 组件创建的实例名称


inputs:

src:

src: ./

exclude:

- .env

region: ap-guangzhou

runtime: Nodejs10.15

functionName: {name}-{stage}-{app}-{org} #云函数名称

apigatewayConf:

protocols:

- http

- https

environment: release

yml 文件中的配置信息：

操作场景

本文以 Tencent-Express 组件部署一个 Express 网站为例，模拟 Serverless Framework 开发项目、管理项目和部署发布上线全流程。

示例链接：https://github.com/June1991/serverless-express

流程说明

一个项目的开发上线流程大致如下：

  1. 初始化项目：将项目进行初始化。例如选择一些开发框架和模板完成基本的搭建工作。
  2. 开发阶段：对产品功能进行研发。可能涉及到多个开发者协作，开发者拉取不同的 feature 分支，开发并测试自己负责的功能模块；最后合并到 dev 分支，联调各个功能模块。
  3. 测试阶段：测试人员对产品功能进行测试。
  4. 发布上线：对于已完成测试的产品功能发布上线。由于新上线的版本可能有不稳定的风险，所以一般会进行灰度发布，通过配置一些规则监控新版本的稳定性，等到版本稳定后，流量全部切换到新版本。

开发项目过程可能会涉及以下分支：

操作步骤

初始化项目

  1. 参考 部署 Express.js 应用 文档，创建一个 express 项目，修改 yml 文件为以下内容：
代码语言：javascript
复制
#serverless.yml

org: xxx-department #  用于记录组织信息,默认为您的腾讯云appid

app: expressDemoApp #  应用名称，默认为与组件实例名称

stage: ${env:STAGE} #  用于开发环境的隔离，默认为dev


component: express # (必填) 引用 component 的名称，当前用到的是 express-tencent 组件

name: expressDemo # (必填) 组件创建的实例名称


inputs:

src:

src: ./

exclude:

- .env

region: ap-guangzhou

runtime: Nodejs10.15

funcitonName: {name}-{stage}-{app}-{org} #云函数名称

apigatewayConf:

protocols:

- http

- https

environment: release
  1. 在项目根目录下的 .env 文件中配置：
代码语言：javascript
复制
TENCENT_SECRET_ID=xxxxxxxxxx #您账号的 SecretId

TENCENT_SECRET_KEY=xxxxxxxx #您账号的 SecretKey

STAGE=prod #STAGE为prod环境，也可以sls deploy --stage=prod 参数传递的方式设置
  1. 执行 sls deploy 部署成功后，访问生成的 url 链接，效果如下：
  1. 创建远程仓库（示例链接：https://github.com/June1991/serverless-express），将项目代码提交到远程 master 分支。同时创建 testing、dev。此时三个分支的代码在同一个版本上（假设为版本 0）。

开发与测试

背景

现在需要开发某个功能模块。假设需要有两位开发者：Tom、Jorge。两位开发者分别从 dev（版本 0）上创建特性分支为 feature1、feature2 进行研发。

Tom 开始开发 feature1。在本示例中，为新增一个 feature.html，里面写文案「This is a new feature 1.」

开发

  1. 在 sls.js 文件中新增路由器配置：
代码语言：javascript
复制
// Routes

app.get(/feature, (req, res) => {

res.sendFile(path.join(__dirname, 'feature.html'))

})
  1. 新增 feature.html：
代码语言：javascript
复制
<!DOCTYPE html>

<html lang="en">

<head>

    <meta charset="UTF-8" />

    <meta name="viewport" content="width=device-width, initial-scale=1.0" />

<title>Serverless Component - Express.js</title>

</head>

<body>

<h1>

This is a new feature 1.

</h1>

</body>

</html>
  1. 在 .env 文件中设置自己的 stage，以便在开发过程中得到独立的运行和调试环境。例如 Tom 在 serverless.yml 的项目目录下配置 .env 如下：
代码语言：javascript
复制
TENCENT_SECRET_ID=xxxxxxxxxx

TENCENT_SECRET_KEY=xxxxxxxx

STAGE=feature1
  1. 执行 sls deploy 部署成功后，返回显示如下：
代码语言：javascript
复制
region: ap-guangzhou

apigw:

serviceId:   service-xxxxxx

subDomain:   service-xxxxxx-123456789.gz.apigw.tencentcs.com

environment: release

url:         https://service-xxxxxx-123456789.gz.apigw.tencentcs.com/release/

scf:

functionName: express-demo-feature1

runtime:      Nodejs10.15

namespace:    default

lastVersion:  $LATEST

traffic:      1


Full details: https://serverless.cloud.tencent.com/instances/expressDemoApp%3Afeature1%3AexpressDemo


10s » expressDemo » Success
  1. 访问生成的 url（https://service-xxxxxx-123456789.gz.apigw.tencentcs.com/release/feature），效果如下：

至此，Tom 开发功能完成并自测通过。

假设同时，Jorge 同时也完成自己的特性开发，并自测通过。在本示例中，为新增一个 feature.html，里面写文案「This is a new feature 2.」。

联调

  1. 两人把各自 feature 分支的代码合并到 dev 分支。（可能会存在冲突需要人为解决）
  1. 在 dev 进行联调。联调环境中的 .env 配置如下
代码语言：javascript
复制
TENCENT_SECRET_ID=xxxxxxxxxx

TENCENT_SECRET_KEY=xxxxxxxx

STAGE=dev
  1. 执行 sls deploy 联调部署后，访问 url（https://service-xxxxxx-123456789.gz.apigw.tencentcs.com/release/feature），效果如下。至此联调完成，整个功能已经开发完毕。

测试

  1. 把联调通过的 dev 分支合并到 testing 代码，进入测试。
  1. 测试环境中的 .env 配置如下：
代码语言：javascript
复制
TENCENT_SECRET_ID=xxxxxxxxxx

TENCENT_SECRET_KEY=xxxxxxxx

STAGE=testing
  1. 执行 sls deploy 部署成功后，测试人员开始进行相关测试，直至功能稳定通过。

发布上线

测试通过后，将测试代码合并到 master 分支，准备发布上线。

设置生产环境中的 .env 为：

代码语言：javascript
复制
TENCENT_SECRET_ID=xxxxxxxxxx

TENCENT_SECRET_KEY=xxxxxxxx

STAGE=prod

执行部署命令：

代码语言：javascript
复制
sls deploy

至此，我们完成了一 个severless-express 项目的开发和上线发布。

灰度发布

操作场景

在业务进行版本更新及切换时，为了保证线上业务稳定，建议采取灰度发布的方式。本文以已部署的 express 项目为例，为您介绍灰度发布的操作步骤。

前提条件

已完成 开发项目。

操作步骤

  1. 设置生产环境中的 .env：
代码语言：javascript
复制
TENCENT_SECRET_ID=xxxxxxxxxx

TENCENT_SECRET_KEY=xxxxxxxx

STAGE=prod
  1. 部署到线上环境 latest</code>，并切换 10% 的流量在 <code>latest 版本（90%的流量在最后一次发布的云函数版本N上）：
代码语言：javascript
复制
sls deploy --inputs.traffic=0.1
  1. 对 $latest 版本进行监控与观察，等版本稳定之后把流量 100% 切到该版本上：
代码语言：javascript
复制
sls deploy --inputs.traffic=1.0
  1. 流量全部切换成功后，对于一个稳定版本，我们需要对它进行标记，以免后续发布新功能时，如果遇到线上问题，方便快速回退版本。部署并发布函数版本 N+1，切换所有流量到版本 N+1：
代码语言：javascript
复制
sls deploy --inputs.publish --inputs.traffic=0

One More Thing

立即体验腾讯云 Serverless Demo，获取免费试用额度，请在 PC 端访问：

serverless.cloud.tencent.com/start?c=wx

#serverless#express#腾讯云测试服务#https#网络安全