serverless-webide

基于 Serverless 架构和 Vscode 的即开即用，用完即走的轻量 Web IDE 服务。主要特点：

• 全功能 Vscode Web IDE，支持海量的插件。
• 虚拟机级别的多租安全隔离。
• 数据实时保存。用户可以随时关闭页面而不必担心数据丢失。
• 状态实时恢复。依托于函数计算极致的启动速度，秒级恢复到上次的状态。用户可随时继续。
• 资源利用率高，低成本。绝大多数 IDE 的使用是碎片化的，只在一天中的少部分时间被使用，因此 IDE 实例常驻是不明智的。借助函数计算完全按需付费，忙闲时单独定价的计费策略，成本比常驻型 IDE 实例低 3-10x。

快速体验

1. 开通阿里云函数计算，对象存储服务。

2. 在函数计算控制台应用中心部署 Serverless WebIDE 服务。

3. 在浏览器中访问服务的网址。Web IDE 的配置以及 /workspace 下的数据将自动保存。

基本流程

本项目主要实现了一个 Reverse Proxy，请求的处理流程如下图所示。

环境配置

在 configs 目录下，包含了一些配置文件。请根据需要修改对应的配置文件。

• dev.yaml：在本地启动 webide-server 所需的配置文件
• test.yaml：运行测试所需的配置文件
• fc.yaml：在函数计算（FC） runtime 环境中运行 webide-server 所需的配置文件

在本地启动 webide-server，或者运行测试，还需要配置以下3个环境变量。

• ALI_KEY_ID：您的阿里云 access key id
• ALI_KEY_SECRET：您的阿里云 access key secret
• ALI_REGION：您要运行测试的阿里云区域，例如 cn-hangzhou，cn-beijing 等等

开发调试

本地需要提前安装好 Golang, 下面的开发调试流程仅针对 mac 和 linux

如果您使用 windows 进行开发，且本地安装了 docker， 可以使用如下命令进入 linux 容器，完成下面的开发调试 docker run -it -v {your repo dir}:/code -p 9000:9000 golang bash 其中 {your repo dir} 对应你 git clone 这个仓库的目录，进入容器后， 跳转到 /code 目录

在项目根目录下按如下步骤执行 shell 命令。

1. 修改 dev.yaml 中的配置项，执行下述命令编译项目。成功后，会在项目根目录下新建 target 目录，包含了二进制文件，对应的启动配置文件等交付物。

   注意 binaryDirectory 这个值, 跟您的开发平台有有关， 您可以先 make build 之后， 参考 third_party 下面的 openvscode-server-v${VSCODE_SERVER_VERSION}-${OS}-${ARCH} 目录， 然后修改 dev.yaml， 重新 make build

   make build

2. 在本地环境启动 webide server。

   ./target/webide-server -logtostderr=true

   如果您是 mac amd64 机型，./target/webide-server -logtostderr=true 有 readlink: illegal option -- f, 请尝试安装 brew install coreutils 解决，详情

3. 请注意，step 2 只是创建了反向代理 ide-server，后台的 vscode-server 并没有启动。只有执行下述命令后，web ide 才功能就绪。其中端口请后 ide-server 启动时的端口保持一致。

   curl localhost:9000/initialize

4. Shutdown webide-server，将 vscode-server 的配置数据和 workspace 下的用户数据保存到 oss。

   curl localhost:9000/shutdown

本地测试

在本地运行测试，需要配置以下3个环境变量，以及 configs 目录中的 test.yaml 中的配置项。

• ALI_KEY_ID：您的阿里云 access key id
• ALI_KEY_SECRET：您的阿里云 access key secret
• ALI_REGION：您要运行测试的阿里云区域，例如 cn-hangzhou，cn-beijing 等等

在项目根目录执行命令运行测试。

make test

安装 Serverless Devs 工具

该项目使用 Serverless Devs 工具部署 FC 应用，请按照文档安装该工具。

部署 FC layer

Web IDE 应用依赖三方的 openvscode-server。执行下述命令，将依赖的 openvscode-server 作为 FC 的 layer 发布，这样在部署 Web IDE 应用时，就可以只更新 ide server 交付物。

make layer

在结果输出的最后，能找到如下内容。

其中需要使用红框中的内容更新项目根目录的 s.yaml 文件中的函数 layers 的配置。

部署应用到函数计算（FC）

1. 修改 fc.yaml 中的配置项, 主要是 ossBucketName 这个值

2. 交叉编译，生成可部署到 FC 的交付物。

   make release

3. 使用 Serverless Devs 工具部署到 FC。

   s deploy

函数计算（FC）应用调试技巧

实时日志查询

可在 FC 控制台可查看函数实时日志。也可使用 Serverless Devs 工具查询实时日志。在项目根目录（s.yaml 所在目录）执行命令：

s logs --tail

实例登录

可在 FC 控制台登录实例。也可使用 Serverless Devs 工具登录。在项目根目录（s.yaml 所在目录）执行命令：

1. 首先列出当前函数的实例。

   s instance list

2. 然后登录实例。请将 your-instance-id 换成您在 step 1 中列出的实例 id。

   s instance exec -it your-instance-id /bin/bash