openscow-cli是OpenSCOW集群安装、配置和管理工具，您可以使用openscow-cli高效管理您的集群。

下载

请通过以下方法下载openscow-cli，并将下载的文件解压，将里面的可执行文件存放到您将会存放OpenSCOW配置文件的目录下。

GitHub Release: OpenSCOW每次发布新的版本时，将会将此版本的openscow-cli上传到Release中

想获取最新的openscow-cli版本？您可以从GitHub Actions的Test, Build and Publish Projects workflow中下载到上传到Archive的openscow-cli。

参考命令

# 如果没有wget，可以先install
yum install wget

# 下载对应的release版本。修改latest、cli-x64可下载指定版本cli
# 修改latest为v0.4.0即可下载0.4.0版本的cli，如 https://github.com/PKUHPC/OpenSCOW/releases/download/v0.4.0/cli-x64
# 可修改cli-x64为cli-arm64下载arm64版本，如 https://github.com/PKUHPC/OpenSCOW/releases/download/v0.4.0/cli-arm64
wget https://github.com/PKUHPC/OpenSCOW/releases/download/latest/cli-x64

# 重命名
mv cli-x64 cli

#修改文件权限
chmod +x cli

配置

openscow-cli使用运行目录下的install.yaml作为配置来管理集群，但您可以通过-c命令行选项指定install.yaml的路径。

使用

# docker compose 操作
# 在compose后跟任意compose参数
# 注意：每次运行compose的操作时，cli将会在本目录下创建一个临时的docker-compose-{时间戳}.yml文件，运行结束后会删除此文件
# 以保证docker compose配置的内容为最新
# 启动集群
./cli compose up -d
# 关闭集群
./cli compose down
# 更新镜像
./cli compose pull

# 生成docker-compose.yml文件
./cli generate -o docker-compose.yml

# 进入数据库
./cli db

# 将最简版本的示例配置文件放到当前目录下
./cli init

# 将全版本的示例配置文件放到当前目录下
./cli init -f

# 查看当前使用install.yaml的内容
./cli view-install

# 检查./config目录下的OpenSCOW配置文件的格式
./cli check-config

从scow-deployment迁移

从scow-deployment迁移到openscow-cli是非常容易的。

首先，请先下载openscow-cli到您的scow-deployment文件夹中，确保config.py存在于目录中，然后运行

./cli migrate

此命令将会读取当前目录中config.py中的配置，并生成对应的install.yaml。

之后，您就可以使用openscow-cli来管理您的集群了。

常见命令的对照

使用	`scow-deployment`	`openscow-cli`
启动系统	`./compose.sh up -d`	`./cli compose up -d`
停止系统	`./compose.sh down`	`./cli compose down`
跟随查看所有日志	`./compose.sh logs -f`	`./cli compose logs -f`
更新镜像	`./compose.sh pull`	`./cli compose pull`
进入数据库	`./db.sh`	`./cli db`

更新`openscow-cli`

openscow-cli可以自我更新。

# 更新到PR 535对应的最新的版本
./cli update --pr 535

# 将test分支的最新cli下载到./cli-test
./cli update --pr 535 -o ./cli-test

# 更新到test分支的最新cli版本
./cli update --branch test

# 更新至最新版本的openscow-cli
./cli update

# 更新cli至v0.4.0版本
./cli update --release v0.4.0

# 下载v0.4.0版本的openscow-cli并保存到./cli-test
./cli update --release v0.4.0 -o ./cli-test

使用--pr或者--branch选项需要您创建一个有workflow权限的GitHub Token ( https://github.com/settings/tokens/new )，并将这个token放到cli目录下的.env文件

.env

# .env
GITHUB_TOKEN={token}

代理

CLI需要访问网络的功能（例如更新openscow-cli）可以设置HTTP代理。您可以通过设置HTTPS_PROXY, https_proxy, HTTP_PROXY, http_proxy环境变量来设置代理。如果多个环境变量同时存在，则使用优先级为上面列出来的顺序。

# 环境变量也可以写入.env中
export HTTPS_PROXY=http://localhost:1080
./cli update

打印调试日志

LOG_LEVEL="debug" ./cli

下载

配置

使用

从scow-deployment迁移

常见命令的对照​

更新openscow-cli

代理

打印调试日志

常见命令的对照

更新`openscow-cli`