804 字约 3 分钟
云开发仅预览模式是云原生开发的衍生能力。在该模式下,点击 云原生开发 按钮将不会打开 WebIDE,而是直接启动并打开预览页面,提供更快捷的预览体验。
注意事项
- 此功能为 beta 版本,相关配置和使用方法后续可能会变更。
- 仅预览模式无法打开 WebIDE 和 ssh。可借助自定义按钮定义打开云开发模式(支持 WebIDE)的按钮入口
如何配置?
# .cnb.yml
$:
vscode:
- docker:
build: .ide/Dockerfile
services:
# launch 启动命令中如需使用到 docker 命令或 docker compose 命令,docker service 需写在 vscode service 前面
- docker
- name: vscode
options:
# 启用预览模式
onlyPreview: true
# 启动业务端口的命令,端口必须启动在 8686
launch: node index.js
# 保活时间,单位毫秒,不设置默认 10 分钟没有心跳(检测不到开发环境内的 http 连接)即关闭开发环境
keepAliveTimeout: 3600000
# 是否守护进程模式,默认为 false,非守护进程模式
# true:以守护进程模式启动,即 launch 启动预览业务服务时,会直接运行在后台
# false:非守护进程模式启动,执行 launch 启动预览业务服务时,可以看到日志,且需要等待 launch 启动完成并主动退出,才会继续执行后续流程
# 推荐设置为 false,由用户自己实现业务启动成功后退出进程并后台运行,这样可以看到业务启动日志,方便定位问题
daemon: true
# 开发环境启动后会执行的任务
stages:
- name: ls
script: ls -al参数详解
onlyPreview
- 类型:
Boolean - 说明: 是否启用仅预览模式
- 效果: 设置为
true时,点击云原生开发按钮将直接打开预览页面。此时不支持启动 WebIde 和 ssh 服务,即无法打开 WebIDE 和 ssh 连接
launch
- 类型:
String - 说明: 启动业务服务的命令
- 注意: 业务服务必须启动在
8686端口 - 示例:
node index.js,npm start,python app.py等
keepAliveTimeout
- 类型:
Number|String(单位默认为:毫秒) - 默认值:
600000(ms, 10分钟) - 说明: 开发环境的保活时间。当检测不到开发环境内的 HTTP 连接时,超过设定时间后将自动关闭开发环境
- 示例:
3600000表示 1 小时
可直接写数字,表示多少毫秒,也可以写成带单位的字符串格式,例如:10m 表示 10 分钟,支持以下单位:
ms: 毫秒(默认)s: 秒m: 分钟h: 小时
daemon
- 类型:
Boolean - 默认值:
false - 说明: 进程启动模式配置:
true(守护进程模式):launch 命令启动的服务直接运行在后台false(非守护进程模式):可以查看 launch 命令的启动日志,需要等待服务启动完成并主动退出后才会继续后续流程
使用流程
- 在项目根目录创建
.cnb.yml文件 - 按照上述配置示例进行配置
- 确保业务服务监听在
8686端口 - 点击云原生开发按钮
- 系统将自动启动开发环境并打开预览页面