Serverless Custom (Container) Runtime

我们知道 Serverless 可以理解为 Serverless = FaaS + BaaS。Serverless 应用中，对于服务端业务逻辑代码，开发者是以函数的形式去实现的，即 FaaS（函数即服务）。Serverless 相关文章可以看下团队结合阿里云 FC 谈谈我对 FaaS 的理解。

对于云厂商的 FaaS 平台，虽然他们支持多种编程语言及版本的标准运行环境，但毕竟还是有限的。所以，为了满足用户更多个性化开发语言及版本的函数实现需求，他们提供了 Custom Runtime 服务，即可定制化运行环境，支持用户用任何编程语言编写的函数。

以阿里云函数计算 FC 为例，这是它所支持的开发语言列表：

可以看出，对于我们前端工程师，如果想使用阿里云 FC 平台，并不能随心所欲的使用 Node.js 和 TypeScript。因为 Node.js 只支持表格中的四种版本，而 TypeScript，FC 平台自身完全不支持。所以要想使用 Node.js 的其它版本和 TypeScript，就需要自定义运行时。

那么什么是 Custom Runtime 呢？

概念

运行时（Runtime）指函数代码在运行时所依赖的环境，包括任何库、代码包、框架或平台。Custom Runtime 就是完全由用户自定义函数的运行环境。

FaaS 平台通过开放实现自定义函数运行时，支持根据需求使用任意开发语言的任意版本来编写函数。

作用

阿里云官方文档中说到，基于 Custom Runtime 我们可以实现这两件事：

• 定制个性化语言（例如 Go、Lua、Ruby）和各种语言的小版本（例如 Python 3.7、Node.js 14）的执行环境，打造属于您的运行环境。
• 一键迁移现有的 Web 应用或基于传统开发的 Web 项目到函数计算平台，不用做任何改造。

实现 Custom Runtime

本文将以阿里云 FC 为例，实现一个 Custom Runtime。其它平台比如腾讯云 SCF 等，原理和过程也都大致相同。

工作原理

Custom Runtime 本质上是一个 HTTP Server，代码里面包含一个名为 bootstrap 的启动文件，之后这个 HTTP Server 接管了函数计算平台的所有请求，包括事件调用或者 HTTP 函数调用等。

如今 Typescript 在 Node 中的应用已经越来越广泛，所以笔者将实现一个可以运行 TS 代码的 TypeScript 运行时。

操作步骤

准备工作

为了更快更好地玩转 Serverless 应用，需要先安装阿里云的一个 Fun 工具 (https://help.aliyun.com/document_detail/64204.html)，它是一个用于支持 Serverless 应用部署的工具，能帮助我们便捷地管理函数计算、API 网关、日志服务等资源。它通过一个资源配置文件（template.yml），协助我们进行开发、构建、部署操作。

安装配置过程如下：

（1）安装：

// 安装命令
$ npm install @alicloud/fun -g

// 执行 fun --version 检查安装是否成功
$ fun --version

3.6.21

（2）安装好后，使用 fun config 命令配置账户信息（配置文档 (https://help.aliyun.com/document_detail/146702.html#section-h9e-864-bom)），按照提示依次配置 Account ID、AccessKey ID、AccessKey Secret、Default Region Name。

配置完成后，先在本地创建一个 TypeScript 项目 custom-runtime-typescript，并安装相关依赖。

npm i typescript ts-node @types/node

接下来，开始 Custom Runtime 的开发流程，一步一步打造属于自己的自定义运行环境。

1.搭建一个具有监听端口的 HTTP Server

• 需要注意的是，这个服务一定要监听 0.0.0.0:CAPort 或 *:CAPort 端口，默认是 9000。如果使用 127.0.0.1:CAPort 端口，会导致请求超时

用 TS 编写一个 HTTP Server 文件 server.ts 如下：

注意：在开发函数具体的逻辑之前，一般会确认开发的函数是事件函数还是 HTTP 函数

import * as http from 'http';

// 创建一个 HTTP Server
const server = http.createServer(function (req: http.IncomingMessage, res: http.ServerResponse): void {
  var rid = req.headers["x-fc-request-id"];
  console.log(`FC Invoke Start RequestId: ${rid}`);
  
  var rawData = "";
  req.on('data', function (chunk) {
    rawData += chunk;
  });
  
  req.on('end', function () {
    // 处理业务逻辑 ……
    console.log(rawData);
    
    res.writeHead(200);
    res.end(rawData);
    console.log(`FC Invoke End RequestId: ${rid}`);
  });
});

server.timeout = 0; // never timeout
server.keepAliveTimeout = 0; // kee palive, never timeout

// 启动 HTTP 服务并监听 0.0.0.0:9000 端口
server.listen(9000, '0.0.0.0', function () {
  console.log('FunctionCompute typescript runtime inited.');
});

编写完成后，可以先在本地测试该服务是否启动成功，通过安装在项目中的 ts-node 命令来运行上述代码：

# 启动 HTTP 服务

$ ./node_modules/.bin/ts-node server.ts

启动后，在另一个终端中使用 curl 命令测试：

$ curl 0.0.0.0:9000 -X POST -d "hello world" -H "x-fc-request-id:123" 

hello world

若服务已正常启动，说明它可以在接收 HTTP 请求后处理业务逻辑，然后将处理结果再以 HTTP 响应的形式返回给 FaaS 平台。

2.创建一个启动目标 Server 的可执行文件 bootstrap

函数计算冷启动 Custom Runtime 时，会默认调用 bootstrap 文件启动自定义的 HTTP Server。然后这个 HTTP Server 接管了函数计算系统的所有请求。

• bootstrap 是运行时入口引导程序文件，它会告诉 FaaS 如何启动你的自定义运行时。Custom Runtime 加载函数时会固定检索 bootstrap 同名文件，并执行该程序来启动 Custom Runtime 运行时。
• bootstrap 需具备 777 或 755 可执行权限
• 如果是 shell 脚本，一定要添加 #!/bin/bash

创建 bootstrap 文件如下：

#!/bin/bash
./node_modules/.bin/ts-node server.ts

3.编写资源配置文件 template.yaml

在当前目录下编写一份用于部署到函数计算的资源配置文件 template.yaml：

ROSTemplateFormatVersion: '2015-09-01'
Transform: 'Aliyun::Serverless-2018-04-03'
Resources:
  custom-runtime: # 服务名称
    Type: 'Aliyun::Serverless::Service' 
    Properties:
      Description: 'helloworld'
    custom-runtime-ts: # 函数名称
      Type: 'Aliyun::Serverless::Function' 
      Properties:
        Handler: index.handler # Handler 在此时没有实质意义，填写任意的一个满足函数计算 Handler 字符集约束的字符串即可， 例如 index.handler
        Runtime: custom # custom 代表自定义运行时
        MemorySize: 512
        CodeUri: './'

4.部署、调用测试、完成

（1）使用 fun deploy -y 命令将我们的自定义运行时和业务逻辑代码所有资源部署到阿里云。

（2）使用命令调用部署函数，验证

$ fun invoke -e "hello,my custom runtime"  

看到成功输出，就代表我们的 Custom Runtime 大功告成了！它可以直接运行我们写的 TS 代码了。

实现 Custom Container Runtime

TS 的运行环境问题可以用 Custom Runtime 解决，但是 Node 某些版本平台不支持的问题，就不能用同样的办法了。因为 Node 是全局安装的，依赖系统环境。

FC 平台已经为我们想好了此类问题的解决办法，为我们提供了 Custom Container Runtime（自定义容器运行环境）的能力。FaaS 平台有这种能力，是因为它的底层实现原理是 Docker 容器，所以它通过运用容器技术，把我们的应用代码和运行环境打包为 Docker 镜像，保持环境一致性。实现一次构建，到处运行。

工作原理

Custom Container Runtime 工作原理与 Custom Runtime (https://help.aliyun.com/document_detail/132044.htm#Task-2259898) 基本相同：

• 函数计算系统初始化执行环境实例前会扮演该函数的服务角色，获得临时用户名和密码并拉取镜像。
• 拉取成功后根据指定的启动命令 Command、参数 Args 及 CAPort 端口（默认 9000）启动自定义的 HTTP Server。
• 然后这个 HTTP Server 接管了函数计算系统的所有请求，包括来自事件函数调用及 HTTP 函数调用。

下面我们自定义一个 Node V16.1.0 版本的容器运行环境。

操作步骤

1.自定义 HTTP Server

这一步和 Custom Runtime 相同，使用 Node.js Express 自定义一个 Http 服务 server.js，GET 和 POST 方法分别路由至不同的 Handler:

// server.js 文件
'use strict';

const express = require('express');

// Constants
const PORT = 9000;
const HOST = '0.0.0.0';

// HTTP 函数调用
const app = express();
app.get('/*', (req, res) => {
  res.send(`Hello FunctionCompute, http function, runtime is : Node ${process.version}\n`);
});

// 事件函数调用
app.post('/invoke', (req, res) => {
  res.send(`Hello FunctionCompute, event function,runtime is : Node ${process.version}\n`);
});

// 启动 HTTP 服务并监听 9000 端口
var server = app.listen(PORT, HOST);
console.log(`Running on http://${HOST}:${PORT}`);

server.timeout = 0; // never timeout
server.keepAliveTimeout = 0; // keepalive, never timeout

启动服务，本地测试一下：

# 启动 HTTP 服务
$ node server.js

# 新开一个终端，通过 curl 命令测试
$ curl http://0.0.0.0:9000
Hello FunctionCompute, http GET, this runtime is : Node v11.5.0     # 这是我本地的 Node 版本，后面在自定义容器中会输出 v16.1.0                 

验证通过。

2.构建镜像并上传

同样的，需要先做两个准备工作：

• 1）安装启动 Docker

• 2）使用阿里云容器镜像服务创建命名空间和镜像仓库 (https://cr.console.aliyun.com/) 存放我们的自定义镜像

接下来，先编写 Dockerfile，再构建包含我们 Node 指定版本运行环境和应用代码的镜像，最后上传到自己的镜像仓库。

（有需要的同学可以先看下这篇文章如何把一个 Node.js web 应用程序给 Docker 化 (https://nodejs.org/zh-cn/docs/guides/nodejs-docker-webapp/) ）

(1) 编写 Dockerfile：

# 基于基础镜像 node:16.1.0-alpine3.11 构建我们自己的镜像
FROM node:16.1.0-alpine3.11

# 设置容器工作目录
WORKDIR /usr/src/app

# 将 package.json 和 package-lock.json 都拷贝到工作目录
COPY package*.json ./

# 安装依赖
RUN npm install

# 将当前目录下的所有文件拷贝到容器工作目录中
COPY . .

# 暴露容器 8080 端口
EXPOSE 8080

# 在容器中启动应用程序
ENTRYPOINT [ "node", "server.js" ]

（2）安装启动 Docker，登录阿里云镜像服务，构建并上传：

# 登录
$ sudo docker login --username=xxx registry.cn-hangzhou.aliyuncs.com

登录成功后，先构建 Docker 镜像：

# 指定 ACR 镜像地址：其中 my_serverless 为你自己的容器命名空间；nodejs 为你自己的镜像仓库名称；v16.1.0 为镜像版本号
$ export IMAGE_NAME="registry.cnhangzhou.aliyuncs.com/my_serverless/nodejs:v16.1.0"

# 构建镜像
# -t 给镜像取名字打标签，通常 name:tag 或者 name 格式
$ docker build -t $IMAGE_NAME .

再启动容器，本地打开浏览器 http://localhost:9000/ 看是否可以正常响应，来验证我们的自定义镜像是否可以运行成功：

# 启动容器：将容器的 9000 端口映射到主机的 9000 端口$ docker run -p 9000:9000 -d $IMAGE_NAME

验证通过后，最后上传镜像：

# 上传镜像
$ docker push $IMAGE_NAME  

上传成功后，可以在阿里云镜像服务中看到我们的镜像。后面就可以使用它啦！

3.定义 template.yaml

创建一个 template.yaml文件如下：

ROSTemplateFormatVersion: '2015-09-01'
Transform: 'Aliyun::Serverless-2018-04-03'
Resources:
  CustomContainerRuntime: # 服务名称
    Type: 'Aliyun::Serverless::Service'
    Properties:
      Policies:
        - AliyunContainerRegistryReadOnlyAccess
      InternetAccess: true
    nodejs-express-http: # 函数名称
      Type: 'Aliyun::Serverless::Function'
      Properties:
        Description: 'HTTP function powered by nodejs express'
        Runtime: custom-container # 表示自定义容器
        Timeout: 60
        CAPort: 9000 # 注意！这里Custom Container Runtime使用的监听端口一定要和HTTP Server监听的端口保持一致，否则会出现错误
        Handler: not-used
        MemorySize: 1024
        CodeUri: ./   # Root directory for the function or the Dockerfile path
        CustomContainerConfig: # 容器镜像配置
          # Sample image value: registry-vpc.cn-shenzhen.aliyuncs.com/fc-demo/nodejs-express:v0.1  使用同地域的VPC镜像地址加速
          Image: 'registry.cn-hangzhou.aliyuncs.com/my_serverless/nodejs:v16.1.0'
          Command: '[ "node"]'
          Args: '["server.js"]'
      Events:
        http-trigger-test:
          Type: HTTP
          Properties:
              AuthType: ANONYMOUS
              Methods: ['GET', 'POST', 'PUT']

4.部署测试

# 使用命令部署到 FC 
$ fun deploy -y

部署成功后，我们去 FC 平台上进行测试。

因为我们在 template.yaml 中配置的触发器是 http 触发器，所以我们点击“执行”按钮进行调试，发现正常运行,返回结果为 runtime is: Node V16.1.0，说明我们的自定义容器运行环境也成功实现了！

小结

Custom Runtime 为我们打破了 FaaS 平台对语言的限制；Custom Container Runtime 让开发者可以将应用代码和运行环境打包成容器镜像作为函数的交付物，优化开发者体验、提升开发和交付效率。

自定义（容器）运行时让我们开发者使用 Serverless 的自由度更高，通过它们可以让我们无需代码改造，一键迁移我们的 Web 应用。

参考资料

what-is-runtime (https://stackoverflow.com/questions/3900549/what-is-runtime)

为阿里云 serverless 打造 Deno 运行时 (https://zhuanlan.zhihu.com/p/137204273)

Custom Runtime 说明 (https://cloud.tencent.com/document/product/583/47274)

fun 工具 (https://help.aliyun.com/document_detail/64204.html)

函数计算支持容器镜像-加速应用 Serverless 进程 (https://developer.aliyun.com/article/772788)

Custom Runtime - 打破云函数语言限制 (https://cloud.tencent.com/developer/article/1690709)

点个『在看』支持下