简介

通过使用自定义数据处理命令行工具 qufopctl，开发者能够创建、部署、维护、管理自定义数据处理应用。

下载

qufopctl 4.1 是最新版的自定义数据处理命令行工具，较之前的版本有许多改进，有一些旧的使用方式不再被支持，为了更好的使用体验，请下载最新版的命令行工具。下载地址请访问：

• Mac OS
• Linux 32bits
• Linux 64bits
• Windows 64bits
• Windows 32bits

更新升级

查看版本

用法：

qufopctl -v
或
qufopctl --version

查看命令行工具版本，最新版本为 4.1。

注意：如果您使用的是旧版命令行工具则无法查看版本信息。

如何更新

用法：

qufopctl -u
或
qufopctl --update

获取帮助

查看 qufopctl 帮助信息

用法：

qufopctl help
或
qufopctl -h
或
qufopctl --help

查看子命令帮助

用法：

qufopctl help <subcommand>
或
qufopctl <subcommand> -h
或
qufopctl <subcommand> --help

参数说明：

参数名称	说明	类型	必填
subcommand	子命令名	string	是

子命令介绍

login

若想使用 qufopctl 开发自定义数据处理，必须先登录。可以通过以下 3 种方式登录： - 使用七牛账户名和密码登录 - 使用 Access Key 和 Secret Key 登录 - 使用命令行交互式登录

使用七牛账户名和密码登录

用法：

qufopctl login -u <username> -p <password>

标志说明：

名称	说明	类型	必填
-u 或 –username	填写用户名，一般为注册邮箱	string	是
-p 或 –password	填写登录密码	string	是

使用 Access Key 和 Secret Key 登录

点击这里获取 Access Key 和 Secret Key

用法：

qufopctl login -u <access key> -p <secret key>

标志说明：

名称	说明	类型	必填
-u 或 –username	填写Access Key	string	是
-p 或 –password	填写Secret Key	string	是

命令行交互式登录

用法：

qufopctl login

在命令行提示下输入用户名、密码或 Access Key 和 Secret Key。

注意：旧版的用法已被废弃，虽然目前版本仍然可以使用，但是将来版本中可能会被移除。

reg

注册或删除注销自定义数据处理操作不可逆！注册自定义数据处理是使用开发自定义数据处理的第一步，自定义数据处理名称必须全局唯一。

注册自定义数据处理

用法：

qufopctl reg <app> -m <mode> [-d <description>]

参数、标志说明：

名称	说明	类型	必填
app	自定义数据处理名称，必须满足如下规则： ● 全局唯一 ● 小写字母、数字、减号、下划线组成 ● 长度为 5-20 个字符	string	是
-m 或 –mode	设置访问模式 0：public，任何人都能访问 1：protected，apply过的用户才能访问 2：private，只有自己才能访问。普通用户只能创建1或2的自定义数据处理	int	是
-d 或 –description	设置自定义数据处理的描述	string	否

注意：旧版中的标志 -mode、-desc 已被移除。 -mode 请用 -m 或 –mode 代替，-desc 请用 -d 或 –description 代替。

删除注销自定义数据处理

qufopctl reg <app> -u

参数、标志说明：

名称	说明	类型	必填
app	自定义数据处理名称	string	是
-u 或 –unregister	若命令中含有此标志，则为删除注销自定义数据处理	bool	是

build

构建一个自定义数据的某个版本，版本号是从 1 开始逐步递增。

构建配置文件 ufop.yaml 格式如下：

image: ubuntu
build_script:
- sudo mv $RESOURCE/* .
- chmod +x demo
run: ./demo 

• image：创建镜像时的基础镜像，ubuntu 或者以前创建好的一个镜像加版本，如：test.v7。
• build_script：创建镜像时的脚本，在这里进行安装环境等操作，主要为 bash 命令，包括 apt-get 等。
• run：运行程序的启动命令，对应的服务需要监听 9100 端口。

一些额外说明：

• $RESOURCE：框架定义的环境变量。 资源存放目录，其中的资源需要移动到当前目录或其他需要的路径下，这个目录在运行时不会保留
• $PWD：框架定义的环境变量，当前目录也是以后的的工作目录
• user 拥有 sudo 权限

用法：

qufopctl build <app> -f <folder> [-d <description>]

参数、标志说明：

名称	说明	类型	必填
app	自定义数据处理名称	string	是
-f 或 –folder	设置本地包含二进制程序和 ufop.yaml 的文件夹路径	string	是
-d 或 –description	设置构建版本的描述	string	否

注意：旧版中的标志 -dir、-desc已被移除。-dir 请用 -f 或 –folder 代替，-desc 请用 -d 或 –description 代替。

version

version命令提供如下功能：

• 查看自定义数据处理各个版本或某一版本信息，包括构建的状态、描述以及构建日期。
• 切换自定义数据的生产版本至某个指定版本，自定义数据处理构建好后，不会自动切换到最版本，需要手动切换。
• 删除自定义数据处理的某个版本或某些版本。

查看各个版本信息

用法：

qufopctl version <app> -l [-v <version>]

参数、标志说明：

名称	说明	类型	必填
app	自定义数据处理名称	string	是
-l 或 –list	若命令中含有此标志，则为查看版本信息	bool	是
-v 或 –version	查看某个指定版本信息	int	否

切换生产版本

用法：

qufopctl version <app> -c -v <version>

参数、标志说明：

名称	说明	类型	必填
app	自定义数据处理名称	string	是
-c 或 –change	若命令中含有此标志，则为切换生产版本	bool	是
-v 或 –version	设置切换到的版本号	int	是

批量删除版本

用法：

qufopctl version <app> -r -v <version>

参数说明：

名称	说明	类型	必填
app	自定义数据处理名称	string	是
-r 或 –remove	若命令中含有此标志，则为删除版本	bool	是
-v 或 –version	设置需要删除的版本号	int	是

注意： 如果 -l、-c、-r 出现多个，优先级 -l > -c > -r。如果 -l、-c、-r 都没有指定，则默认为 -l。

info

查看自定义数据处理的基本信息，可批量查看。

基本信息内容如下：

Ufop name:       <your ufop app name>
Owner:           <owner info>
Version:         <current version>
Access mode:     <ACL mode>
Access method:   <access method>
Access url:      <access url>
Description:     <description of your ufop app>
Create time:     <created time>
Instance num:    <how many instances it currently has>
Max instanceNum: <how many instances you can create>
Flavor:          <ufop app flavor>
Environments:    <its env info>
Access list:     <access list>

用法：

qufopctl info <app> [<app> ...]

参数说明：

名称	说明	类型	必填
app	自定义数据处理名称，可填写多个，用空格分隔	string	是

resize

调整实例个数，切换生产版本后，由于还没有实例运行，所以自定义数据处理本身还是处于未启用状态。可以通过此命令调整实例的个数，自定义数据处理平台通过负载均衡把请求转发到不同的实例上处理。

用法：

qufopctl resize <app> -n <num>

参数说明：

名称	说明	类型	必填
app	自定义数据处理名称	string	是
-n 或 –num	设置实例数，数量最大不能超过最大实例数（可通过info命令查看）	int	是

注意：旧版中的标志 -num 已被移除，请用 -n 或 –num 代替。

state

查看自定义数据处理一个或多个实例状态

查看全部实例状态

用法：

qufopctl state <app>

参数说明：

名称	说明	类型	必填
app	自定义数据处理名称	string	是

查看特定实例状态

用法：

qufopctl state <app> -i <index>

参数、标志说明：

名称	说明	类型	必填
app	自定义数据处理名称	string	是
-i 或 –index	设置需要查看的实例ID	int	是

注意：旧版中的标志 -index 已被移除，请用 -i 或 –index 代替。

查看特定ID范围的实例状态

用法：

qufopctl state <app> -r <start>:<end>

参数、标志说明：

名称	说明	类型	必填
app	自定义数据处理名称	string	是
-r 或 –range	设置需要查看的实例ID范围，如：1 : 3	int : int	是

注意：旧版中的标志 -range 已被移除，请用 -r 或 –range 代替。

start

启动一个或多个实例

启动全部实例

用法：

qufopctl start <app>

参数说明：

名称	说明	类型	必填
app	自定义数据处理名称	string	是

启动特定实例

用法：

qufopctl start <app> -i <index>

注意：旧版中的标志 -index 已被移除，请用 -i 或 –index 代替。

参数、标志说明：

名称	说明	类型	必填
app	自定义数据处理名称	string	是
-i 或 –index	设置需要启动的实例ID	int	是

启动特定ID范围的实例

用法：

qufopctl start <app> -r <start>:<end>

参数、标志说明：

名称	说明	类型	必填
app	自定义数据处理名称	string	是
-r 或 –range	设置需要启动的实例的ID范围，如：1 : 3	int : int	是

注意：旧版中的标志 -range 已被移除，请用 -r 或 –range 代替。

stop

暂停一个或多个实例

暂停全部实例

用法：

qufopctl stop <app>

参数说明：

名称	说明	类型	必填
app	自定义数据处理名称	string	是

暂停特定实例

用法

qufopctl stop <app> -i <index>

参数、标志说明：

名称	说明	类型	必填
app	自定义数据处理名称	string	是
-i 或 –index	设置需要暂停的实例ID	int	是

注意：旧版中的标志 -index 已被移除，请用 -i 或 –index 代替。

暂停特定ID范围的实例

用法：

qufopctl stop <app> -r <start>:<end>

参数、标志说明：

名称	说明	类型	必填
app	自定义数据处理名称	string	是
-r 或 –range	设置需要暂停的实例的ID范围，如：1 : 3	int : int	是

注意：旧版中的标志 -range 已被移除，请用 -r 或 –range 代替。

restart

重启一个或多个实例

重启全部实例

用法：

qufopctl restart <app>

参数说明：

名称	说明	类型	必填
app	自定义数据处理名称	string	是

重启特定实例

用法：

qufopctl restart <app> -i <index>

参数、标志说明：

名称	说明	类型	必填
app	自定义数据处理名称	string	是
-i 或 –index	设置需要重启的实例ID	int	是

重启特定ID范围的实例

用法：

qufopctl restart <app> -r <start>:<end>

参数、标志说明：

名称	说明	类型	必填
app	自定义数据处理名称	string	是
-r 或 –range	需要重启的实例的ID范围，如：1 : 3	int : int	是

upgrade

升级一个或多个实例，对于已经启动或暂停的实例，切换版本后这些实例并不会自动升级，需要运行此命令。

升级全部实例

用法：

qufopctl upgrade <app>

参数说明：

名称	说明	类型	必填
app	自定义数据处理名称	string	是

升级特定实例

用法：

qufopctl upgrade <app> -i <index>

参数、标志说明：

名称	说明	类型	必填
app	自定义数据处理名称	string	是
-i 或 –index	设置需要升级的实例ID	int	是

注意：旧版中的标志 -index 已被移除，请用 -i 或 –index 代替。

升级特定ID范围的实例

用法：

qufopctl upgrade <app> -r <start>:<end>

参数、标志说明：

名称	说明	类型	必填
app	自定义数据处理名称	string	是
-r 或 –range	设置需要升级的实例的ID范围，如：1 : 3	int : int	是

注意：旧版中的标志 -range 已被移除，请用 -r 或 –range 代替。

log

查看自定义数据处理实例的构建日志和运行日志

查看某一时间段运行日志

用法：

qufopctl log <app> -s <start> -d <duration>

参数、标志说明：

名称	说明	类型	必填
app	自定义数据处理名称	string	是
-s 或 –start	设置运行日志开始的时间。格式：<year><mont><day><hour><min>，如：201410261411。若没有指明，日志的结束时间为当前时间	bool	否
-d 或 –duration	设置获取的运行日志时间范围，默认值为5分钟。格式：<num><unit>，unit可以为 m（分钟）或 h（小时）。没有单位则为 m，如：30min 或 1h	bool	否

查看实时运行日志

用法：

qufopctl log <app> -f -v <version>

参数、标志说明：

名称	说明	类型	必填
app	自定义数据处理名称	string	是
-f 或 –follow	如果命令中包含此标志，则为取实时日志	bool	是
-v 或 –version	设置需要获取日志的自定义数据处理对应的版本	int	是

注意：旧版中的标志 -from、-to、-version 已被移除。 -from请用 -s 或 –start 代替，-version 请用 -v 或–version 代替。

查看构建日志

编译过程中可能出错，这时候需要查看这个版本的编译日志。

用法：

qufopctl log <app> -b -v <version>

参数、标志说明：

名称	说明	类型	必填
app	自定义数据处理名称	string	是
-b 或 –build	如果命令中包含此标志，则取构建日志	bool	是
-v 或 –version	设置需要获取日志的自定义数据处理对应的版本	int	是

list

罗列出当前用户可以使用的所有自定义数据处理名

用法：

qufopctl list

apply

申请使用其他开发者的自定义数据处理

对于其他开发者设置为 protected 访问模式的自定义数据处理，需要申请使用该自定义数据处理才能用于当前用户的 bucket 上，如：图普的 nrop 鉴黄自定义数据处理。可批量申请。

用法：

qufopctl apply <app> [<app> ...]

参数说明：

名称	说明	类型	必填
app	自定义数据处理名称	string	是

注意：apply 之后大概需要 5 分钟生效

取消使用其他开发者的自定义数据处理

与申请使用相反，添加 -u 标志可以取消使用其他开发者的自定义数据处理。

用法：

qufopctl apply <app> [<app> ...] -u

参数说明：

名称	说明	类型	必填
name	自定义数据处理名称	string	是
-u 或 –unapply	若命令包含此标志，则为取消使用	bool	是

chdesc

更新自定义数据处理的描述说明或者某一版本的版本说明。

用法：

qufopctl chdesc <app> -d <description> [-v <version>]

参数、标志说明：

名称	说明	类型	必填
app	自定义数据处理名称	string	是
-d 或 –description	设置新的描述说明	string	是
-v 或 –version	设置若要修改某个版本的说明，请设置此标志。若不设置此标志则修改自定义数据处理的描述说明	int	否

注意：旧版中的标志 -desc 已被移除，请用 -d 或 –description 代替。

chmode

修改自定义数据处理的访问模式。模式有如下三种：

• 0：public，任何人都能访问
• 1：proteced，申请使用的用户才能访问
• 2：private，只有自己才能访问

注意：普通用户只能把 private 改为 protected，用于发布自定义数据处理给别人使用。

用法：

qufopctl chmode <app> -m <mode>

参数、标志说明：

名称	说明	类型	必填
app	自定义数据处理名称	string	是
-m 或 –mode	设置访问模式	int	是

注意：旧版中的标志 -mode 已被移除，请用 -m 或 –mode 代替。

chflavor

修改自定义数据处理实例的硬件配置。修改完成后，需要重启下实例才能生效。目前自定义数据处理平台提供如下 4 种硬件配置：

• M0C1：单核 CPU，内存 512 MB，也称 default 配置
  
• M1C2：双核 CPU，内存 1 GB，也称 standard 配置
• M2C4: 四核 CPU，内存 2 GB
• M4C8：八核 CPU，内存 4 GB
• M8C12：12 核 CPU，内存 8 GB

用法：

qufopctl chflavor <app>

参数说明：

名称	说明	类型	必填
app	自定义数据处理名称，输入命令后会进入交互式操作	string	是

env

对于有些用户有需要单独设置环境变量的请求，例如密码等敏感信息。若是一般环境变量可以通过 ufop.yaml 设置。此命令设置好的环境变量可以在info中查看。

注意：改变只会影响到之后新生成的实例，upgrade或resize能产生新实例。

列出已存在的环境变量

用法：

qufopctl env <app> -l

参数说明：

名称	说明	类型	必填
app	自定义数据处理名称	string	是

新建或更新环境变量

用法：

qufopctl env <app> -s -v<key>=<value>
或
qufopctl env <app> -s -v=<key>=<value>

参数、标志说明：

名称	说明	类型	必填
app	自定义数据处理名称	string	是
-s 或 –set	设置如果包含此标志，则为新建或更新环境变量	string	是
-v 或 –variable	设置环境变量键值对	string	是

注意：旧版中的标志 -op、-k 已被移除，请查看新的使用方法。

删除环境变量

用法：

qufopctl env <app> -d -v=<key>

参数、标志说明：

名称	说明	类型	必填
app	自定义数据处理名称	string	是
-d 或 –delete	如果包含此标志，则为删除环境变量	string	是
-v 或 –variable	设置需要删除的环境变量Key	string	是

注意： 如果 -l，-v，-d出现多个，-l 优先级大于 -v 大于 -d。如果 -l，-v，-d 都没有指定，则默认为-l。

pushimage

上传本地可运行的 docker image 作为 ufop 的一个新版本。

用法：

qufopctl pushimage <app> <image> [-d <description>] 

参数、标志说明：

名称	说明	类型	必填
app	自定义数据处理名称	string	是
image	本地 image 的名称，如 ubuntu14.04	string	是
-d 或 –description	设置构建版本的描述	string	否

注意：如果本地的 docker 命令需要加上 sudo 才能运行，那么也需要加上 sudo 来运行 qufopctl。

废弃子命令

buildlog

编译过程中可能出错，这时候需要查看这个版本的编译日志。

废弃说明：

在 qufopctl 4.0 中，buildlog 命令已被废弃，虽然目前仍然可以使用，但在将来的版本中可能会被移除，推荐使用：

qufopctl log <app> -b -v <version>

更多信息请查看log命令用法

用法：

qufopctl buildlog <app> -v <version>

参数说明：

名称	说明	类型	必填
app	自定义数据处理名称	string	是
version	指定版本号	int	是

versions

build命令完成后，查看自定义数据处理各个版本信息，包括构建的状态、描述以及构建日期。

废弃说明：

在 qufopctl 4.0 中，versions 命令已被废弃，虽然目前仍然可以使用，但会在将来的版本中可能会被移除，推荐使用：

qufopctl version <app> -l [-v <version>]

更多信息请查看version命令用法

用法：

qufopctl versions <app> [-v <version>]

参数说明：

名称	说明	类型	必填
app	自定义数据处理名称	string	是
version	查看某个指定版本信息	int	否

chver

切换自定义数据处理版本，自定义数据处理构建好后，不会自动切换到最版本，需要通过此条命令来操作。

废弃说明：

在 qufopctl 4.0 中，chver 命令已被废弃，虽然目前仍然可以使用，但会在将来的版本中可能会被移除，推荐使用：

qufopctl version <app> -c -v <version>

更多信息请查看version命令用法

用法：

qufopctl chver <app> -c <version>

参数说明：

名称	说明	类型	必填
app	自定义数据处理名称	string	是
version	切换到的版本号	int	是

unapply

与apply相反，用户可以取消使用其他开发者的自定义数据处理。

废弃说明：

在 qufopctl 4.0 中，unapply 命令已被废弃，虽然目前仍然可以使用，但会在将来的版本中可能会被移除，推荐使用：

qufopctl apply <app> [<app> ...] -u

更多信息请查看apply命令用法

用法：

qufopctl unapply <app> 

参数说明：

名称	说明	类型	必填
app	自定义数据处理名称	string	是

rmversion

可批量删除某些版本

废弃说明：

在 qufopctl 4.0 中，rmversion 命令已被废弃，虽然目前仍然可以使用，但会在将来的版本中可能会被移除，推荐使用：

qufopctl version <app> -r -v <version>

更多信息请查看version命令用法

用法：

qufopctl rmversion <app> <version> ...

参数说明：

名称	说明	类型	必填
app	自定义数据处理名称	string	是
version	版本号，可以填写任意多个版本	int	是

unreg

删除注销自定义数据处理。此操作不可逆！

废弃说明：

在 qufopctl 4.0 中，unreg 命令已被废弃，虽然目前仍然可以使用，但会在将来的版本中可能会被移除，推荐使用：

qufopctl reg <app> -u

更多信息请查看reg命令用法

用法：

qufopctl unreg <app>

参数说明：

名称	说明	类型	必填
app	自定义数据处理名称	string	是