tcb cloudrun deploy
把本地项目代码或镜像发布到云托管服务。
语法
tcb cloudrun deploy [options]
参数
| 参数 | 必填 | 说明 | 默认值 |
|---|---|---|---|
-e, --env-id <envId> | 否 | 环境 ID | — |
-s, --service-name <serviceName> | 否 | 服务名称 | — |
--port <port> | 否 | 容器型服务端口,函数型服务设置无效 | — |
--source <source> | 否 | 部署代码所在目录,相对当前目录解析;镜像部署可省略 | 项目目录 |
--image-url <imageUrl> | 否 | 镜像地址,如 ccr.ccs.tencentyun.com/ns/img:v1 | — |
--create-agent | 否 | 创建函数型 Agent,同时部署依赖的函数型服务 | false |
--force | 否 | 跳过所有确认提示 | false |
--yes | 否 | 部署前确认直接通过,适合 CI/CD | false |
--install-dependency <bool> | 否 | 在线安装依赖,true / false | — |
--traffic | 否 | 灰度部署,发布成功后需手动切换流量到新版本 | false |
--min-num <minNum> | 否 | 最小副本数,非负整数 | — |
--max-num <maxNum> | 否 | 最大副本数,非负整数 | — |
--open-access-types <types> | 否 | 访问策略类型,英文逗号分隔:OA / PUBLIC / MINIAPP / VPC | OA,PUBLIC,MINIAPP |
--vpc-config <json> | 否 | VPC 网络配置 JSON,需含 vpcId、vpcCIDR、subnetId、subnetCIDR | — |
--wait | 否 | 阻塞等待部署完成,每 3 秒轮询一次,最长 30 分钟;不能与 --traffic 同用 | false |
--env-params <json> | 否 | 环境变量 JSON(v3.8.9+),值须为字符串;已存在的服务按整包覆盖 | — |
--dry-run | 否 | 验证代码加载和配置,不实际部署 | false |
前置条件
授权
云托管相关预设策略,关联到云开发服务角色 TCB_QcsRole:
| 策略 | 用途 |
|---|---|
QcloudAccessForTCBRoleInAccessCloudBaseRun | 云开发访问 VPC、CVM 等云服务资源的权限,用于云托管 |
子账号操作时,还需主账号为其授权对应的预设策略,见预设策略。
使用 --image-url 指向私有仓库镜像时,需确保云托管服务角色具备拉取权限。镜像拉取使用的是服务关联角色,而非当前登录的开发者账号,权限不足时表现为镜像拉取失败(403 Forbidden)。TCR 侧的权限模型见 TCR 访问管理。
镜像要求
- CLI 只把镜像地址提交给云端,不负责构建和推送:镜像必须已存在于可访问的仓库中,部署时由云端按地址拉取
- 云托管基于 X86 架构运行,不支持 ARM 镜像,需使用
amd64镜像 - 当前仅支持上海地域
- 镜像可来自腾讯云 TCR(公有 / 私有)、Docker Hub 或其他仓库,地址形如
ccr.ccs.tencentyun.com/<namespace>/<image>:<tag> - 容器内监听端口需与
--port一致,建议显式指定
docker login ccr.ccs.tencentyun.com
docker tag my-app:latest ccr.ccs.tencentyun.com/ns/my-app:v1
docker push ccr.ccs.tencentyun.com/ns/my-app:v1
示例
# 交互式部署,CLI 会引导选择服务和环境
tcb cloudrun deploy
# 部署当前目录代码到指定服务
tcb cloudrun deploy -e env-123456 -s my-service
# 部署容器型服务并指定端口
tcb cloudrun deploy -e env-123456 -s api-service --port 8080
# 部署指定目录的代码
tcb cloudrun deploy -e env-123456 -s my-service --source ./dist
# 强制部署,跳过确认提示
tcb cloudrun deploy -e env-123456 -s my-service --force
# 使用镜像地址部署
tcb cloudrun deploy -e env-123456 -s my-service --image-url ccr.ccs.tencentyun.com/ns/img:v1 --port 3000
# 指定 VPC 网络配置
tcb cloudrun deploy -e env-123456 -s my-service --vpc-config '{"vpcId":"vpc-xxx","vpcCIDR":"10.0.0.0/16","subnetId":"subnet-xxx","subnetCIDR":"10.0.1.0/24"}'
# 等待部署任务完成,适用于 CI/CD
tcb cloudrun deploy -e env-123456 -s my-service --force --yes --wait
创建 Agent 并部署
# 创建函数型 Agent 并部署依赖的函数服务
tcb cloudrun deploy -e env-123456 --create-agent
# 创建 Agent 并强制部署
tcb cloudrun deploy -e env-123456 --create-agent --force
环境变量
--env-params 接收 JSON 字符串,值的类型必须是字符串,{"PORT":8080} 会被拒绝:
tcb cloudrun deploy -e env-123456 -s my-service --env-params '{"NODE_ENV":"production","REDIS_HOST":"10.0.0.10"}'
该参数按整包替换处理,不是按 key 合并:
| 传参方式 | 结果 |
|---|---|
--env-params '{"A":"1"}' | 线上环境变量替换为 {"A":"1"},其余变量被删除 |
不传 --env-params | 线上环境变量保持不变 |
--env-params '{}' | 清空线上环境变量 |
只改其中一个变量时,需要把其余变量一并传入。环境变量随部署一起提交,修改后需重新部署才生效。
注意事项
- 小程序调用必须开通
MINIAPP访问类型:wx.cloud.callContainer依赖该类型,缺失时小程序侧报-501000、云托管侧返回403。不传--open-access-types时默认OA,PUBLIC,MINIAPP;一旦传入就整体覆盖默认值,只写OA,PUBLIC会让小程序调用失败 - 容器型服务需要指定
--port,函数型服务无需指定 - 部署前先在本地用
tcb cloudrun run调通 - 云托管代码项目示例:nodejs_hello_world