抖音云 CLI 工具

更新时间 2024-07-24 02:58:49
收藏
我的收藏

介绍​

抖音云托管推出的 CLI 命令行工具,帮助开发者在本地或者自定义 CI/CD 流水线中快速便捷的进行服务创建部署或其他操作。​

使用限制​

    1.CLI 工具的安装需要依赖 Node.js 环境,所以需要前置的在本地安装 Node.js,且要求node version >= 14.0.0。​
    2.当前dycloud-cli 命令行工具暂时只支持邮箱登录抖音云账号,不支持手机号登录。开发者可以前往抖音开放平台控制台绑定邮箱。​

操作指引​

以上传一个 docker 镜像为例看下如何使用dycloud-cli。​
    1.通过npm 安装 dycloud 工具。​
关于安装 Node.js
    方式一:使用 Node 管理工具去安装 Node.js(推荐)​
这边我们推荐两款, nvmfnm,这边以 fnm 举例:​
    a.首先在本地安装 fnm,参考 文档 安装部分进行安装。​
    fnm 是一个跨平台的 Node 管理工具,根据自己平台使用对应的安装方法。​
    a.使用 fnm 命令安装 node 版本并启用。​
Bash
复制
# 判断 fnm 是否安装成功
fnm --version
# 安装 node
fnm install
# 启用安装的 node
fnm use
# 判断 node 是否安装成功
node -v
## fnm 更多命令可参考 文档
    方式二:下载 Node.js 安装包​
打开 官网,选择 LTS 版本下载并安装,安装完成后,打开终端执行以下命令判断是否安装成功:​
Bash
复制
# 检查 node 是否安装成功
node -v
安装完成后执行以下命令:​
Bash
复制
npm install -g @open-dy/cloud-cli --registry=https://registry.npmmirror.com/
# 安装完成后,终端会支持 `dycloud` 的根命令。
# 使用 dycloud --version 校验是否安装成功。
dycloud --version
    2.下载docker desktop 进行 docker 镜像打包。​
    3.通过docker build 构建镜像。​
    4.通过 dycloud login 登录抖音云账号(目前暂时只支持邮箱登录)。​
    5. 选择应用和环境。​
    6.获取该应用下的服务列表。​
    7.将本地构建好的镜像上传到对应的服务里,并且打上tag 和备注。​
    8.在服务部署里选择对应 tag 的镜像并且进行部署。​

相关命令​

登录​

传入用户邮箱和密码,进行用户登录。​
Shell
复制
USAGE
$ dycloud login [-e <value>] [-p <value>]
$ dycloud login [-i]
FLAGS
-e, --email=<value> 登录邮箱
-i, --info 当前登录用户
-p, --password=<value> 登录密码

注销​

退出当前登录。​
Shell
复制
USAGE
$ dycloud logout

查看环境​

查看当前应用下的环境。​
Shell
复制
USAGE
$ dycloud env:list

切换环境​

切换选中的应用与环境。​
Shell
复制
USAGE
$ dycloud env:switch [--app-name <value>] [--env dev|prod]
FLAGS
--app-name=<value> 目标应用
--env=(dev|prod) 目标环境

本地生成Dockerfile​

本地检查项目/环境 自动生成Dockerfile。​
Shell
复制
USAGE
$ dycloud dockerfile

查看服务​

查看当前环境下的服务列表。​
Shell
复制
USAGE
$ dycloud service:list

部署服务​

部署当前环境下的指定服务。​
Bash
复制
USAGE
$ dycloud service:deploy [--service-name <value>] [-n <value>] [-t <value>] [--no-confirm] [--env-params <value>] [--service-size 1|2|3]
FLAGS
-n, --note=<value> 发布备注
-t, --tag=<value> 镜像版本号
--env-params=<value> 环境变量,格式为 "aa=bb&cc=dd",注意使用时添加引号 '"',默认值为上一次的部署配置
--no-confirm 跳过二次确认
--service-name=<value> 服务名称
--service-size=(1|2|3) 容器规格,枚举值: 1 = 1核 1G; 2 = 2核 2G; 3 = 3核 3G,默认值为上一次的部署配置

拉取模板配置本地构建镜像​

根据云端模板在本地创建镜像,支持docker build指令参数透传,详见:https://docs.docker.com/engine/reference/commandline/build/
Shell
复制
USAGE
$ dycloud service:build [--service-name <value>]
FLAGS
--service-name=<value> 服务名称

拉取镜像​

拉取镜像至本地。​
Shell
复制
USAGE
$ dycloud container:pull [--service-name <value>]
FLAGS
--service-name=<value> 服务名称

推送镜像​

推送镜像至指定服务下。​
Shell
复制
USAGE
$ dycloud container:push [--tag <value>] [--remark <value>] [--image-id <value>] [--service-name <value>]
FLAGS
--image-id=<value> 本地镜像ID
--remark=<value> 镜像备注
--service-name=<value> 服务名称
--tag=<value> 设置镜像的 TAG