巧用命令行工具UCloud CLI，轻量操作API管理云资源

Posted 2022-07-19

截止目前，UCloud已提供Python/Java/Golang等不同语言的API SDK。为进一步降低用户的运维人力投入，又推出了基于Golang SDK的命令行工具CLI（Command Line Interface），提供轻量化的API命令行调用方式,并在GitHub开源（https://github.com/ucloud/ucloud-cli）。CLI的命令行交互方式更符合研发运维的操作习惯，并且一些典型使用场景通过CLI也更容易代码化的沉淀和维护。

下面是一些用户遇到的实际场景， 用CLI都能更好地解决，在此总结并给出使用示例。

场景一：大批量创建和删除主机

PingCAP作为一家专业的分布式数据库供应商，使用UCloud时需要一次性批量创建300台云主机，进行分布式业务测试。而UCloud控制台一次最多允许创建10台云主机，因此需要用户进行傻瓜式操作30次。但是，主机API实际可以支持最多1000台并发创建。对于一次性API操作，花时间用SDK编写创建脚本的投入产出比很低。此类场景PingCAP便是通过CLI解决。

该场景的示例命令如下：

$ ucloud uhost create —cpu 1 —memory-gb 2 —image-id uimage-xxx —password test123 —count 300

（图：控制台页面主机创建一次性最多10台并发）

场景二：集中化管理/清理资源，不易遗漏

用户经常购买多种产品，每种的数量不一，部分应临时需求而创建的资源，结束使用后常忘记及时删除，因为分布零散不易管理，不知不觉中花了不少钱。如X.D. GLOBAL等用户，则善于利用CLI快速创建并及时清理不用的资源。

示例命令如下：

$ ucloud uhost delete --uhost-id ucloud uhost list --uhost-id-only --page-off

（图：控制台零散的产品资源）

场景三：全球动态加速PathX实例大量端口管理

海外游戏发行商为了提高玩家体验，经常使用UCloud全球动态加速服务PathX实现各地区玩家就近接入，有效规避跨国网络拥塞导致的响应慢、丢包等问题。

某游戏公司也使用了PathX，但其单条线路需要管理的端口数量超过60个。方法一，产品首先得在控制台非标支持60个端口管理，然后用户在页面对所有端口逐一添加配置。方法二是架构师编写脚本，用户通过参数更新调整端口。不过，伴随产品迭代、API调整，脚本的升级成为一个问题，强依赖双方配合。

（图：控制台PathX支持9个端口协议管理）

CLI通过沉淀这样的场景，直接支持了PathX 多端口管理，示例代码如下：# 给PathX指定的线路实例资源添加80个TCP端口

$ ucloud pathx uga add-port --uga-id uga-kjkxxx --protocol tcp --port 3000-3079,8080

场景四：频繁批量切换EIP

某资讯行业用户由于业务场景需要，会频繁触发其服务切换外网IP。投入研发人力以脚本实现该需求，已是行业内非常通用的做法。而使用UCloud CLI能以轻量的方式完成目标。

示例代码如下：# 创建eip并绑定，然后解绑释放之前已绑定的eip

$ ucloud ext uhost switch-eip --create-eip-bandwidth-mb 2 --uhost-id xxx --unband-all --release-all

（图：控制台先解绑再绑定新EIP）

UCloud CLI的便捷之处

1.多维度支持命令补全功能

在命令补全方面，通常每次发布新版本都需要终端用户再次生成补全脚本，功能局限并且使用成本较高。因此，UCloud CLI扩展了spf13/cobra框架的功能（相关代码已开源https://github.com/lixiaojun629/cobra），把命令补全功能集成到命令行工具内部，用户只需要一次配置，日后版本升级都不必再重新生成补全脚本，使用方便。

补全功能包括：支持命令补全、命令参数补全、命令参数值静态补全以及命令参数值动态补全等。针对命令参数值动态补全，为了减少调用API次数、避免卡顿，UCloud CLI还添加了动态补全本地缓存特性。

命令参数值静态补全以及命令参数值动态补全的代码示例见下图所示，其中参数line的可选值BGP和International是固定在代码里的静态枚举值，参数eip-id的可选值是由Tab键触发的API请求得到的。

（图：命令参数值静态补全）

（图：命令参数动态补全）

2.命令编写更简单高效

UCloud CLI批量操作资源时原生支持并发、UI多线程渲染等，相比开启多进程执行命令行，占用系统资源更少，而且命令编写更加简单，降低运维代码成本。例如批量删除主机命令：

#命令1

$ ucloud uhost list --uhost-id-only | xargs -P 32 -I ucloud uhost delete --yes --uhost-id
#命令2

$ ucloud uhost delete --uhost-id ucloud uhost list --uhost-id-only --page-off
很明显命令2更加简单，可以有效减少运维人员的代码操作。

（图：并发创建主机时，UI多线程渲染）

3.稳定可靠

由于UCloud CLI使用了spf13/cobra命令行开发框架，它也是Docker、Kubernetes和etcd等著名开源项目的CLI使用框架，久经考验，稳定可靠。

4.丰富的产品支持

在产品支持方面，目前UCloud CLI已经支持主机、网络、存储和数据库等常用云产品服务，基本能够满足用户大部分使用场景下的日常操作需求，支持产品列表见下图所示：

（图：CLI支持产品）

在Docker中运行UCloud CLI

在Docker中也可以快速地使用UCloud CLI，按下面的操作步骤示例，就可以体验了。

1.首先安装Docker，拉取我们为你准备好的镜像：uhub.service.ucloud.cn/ucloudcli/ucloud-cli:0.1.20

$ docker pull uhub.service.ucloud.cn/ucloudcli/ucloud-cli:0.1.20
此镜像的构建脚本如下：

FROM ubuntu:18.04RUN apt-get update && apt-get install wget -yRUN wget https://github.com/ucloud/ucloud-cli/releases/download/0.1.20/ucloud-cli-linux-0.1.20-amd64.tgzRUN tar -zxf ucloud-cli-linux-0.1.20-amd64.tgz -C /usr/local/bin/RUN echo "complete -C $(which ucloud) ucloud" >> ~/.bashrc #配置自动补全
2.执行以下命令，以uhub.service.ucloud.cn/ucloudcli/ucloud-cli:0.1.20为镜像启动一个容器，容器名字为ucloud-cli：

$ docker run --name ucloud-cli -it -d uhub.service.ucloud.cn/ucloudcli/ucloud-cli:0.1.20
3.执行如下命令连接到容器ucloud-cli，连接成功后即可开始使用ucloud-cli，建议先执行ucloud init命令初始化配置。

$ docker exec -it ucloud-cli bash

总结

UCloud CLI的一个重要意义在于能够将API、事务等有机组合，场景化支持用户的需求，把耗费人力的资源管理以标准化形式呈现，给用户提供便捷灵活的产品解决方案。未来，UCloud CLI也将在更多的使用场景下帮助运维者摆脱操作难题，欢迎大家点击阅读原文链接下载试用并提出反馈意见。（安装使用指南：https://docs.ucloud.cn/software/cli/intro）。

巧用命令行工具UCloud CLI，轻量操作API管理云资源

活动推荐：8月17日在上海原境界美术馆，【UCan下午茶—云原生Kubernetes的开发和运维】技术沙龙将邀请六位资深技术专家进行深入的技术探讨和实践案例分享。欢迎扫描下方二维码报名参加！