BentoCloud CLI¶

此页面提供使用 BentoML CLI 访问 BentoCloud 和管理部署的 API 参考。

bentoml cloud¶

BentoCloud 子命令组。

bentoml cloud [OPTIONS] COMMAND [ARGS]...

current-context¶

获取当前云上下文。

bentoml cloud current-context [OPTIONS]

选项

--context <cloud_context>¶: BentoCloud 上下文名称。

--do-not-track¶: 不发送使用信息

--verbose, --debug¶: 生成调试信息

-q, --quiet¶: 禁止所有警告和信息日志

环境变量

BENTOML_DO_NOT_TRACK: 为 --do-not-track 提供默认值

BENTOML_VERBOSITY: 为 -q 提供默认值

list-context¶

列出所有可用上下文。

bentoml cloud list-context [OPTIONS]

选项

--context <cloud_context>¶: BentoCloud 上下文名称。

--do-not-track¶: 不发送使用信息

--verbose, --debug¶: 生成调试信息

-q, --quiet¶: 禁止所有警告和信息日志

环境变量

BENTOML_DO_NOT_TRACK: 为 --do-not-track 提供默认值

BENTOML_VERBOSITY: 为 -q 提供默认值

login¶

登录到 BentoCloud。

bentoml cloud login [OPTIONS]

选项

--endpoint <endpoint>¶

BentoCloud 端点

默认值:: 'https://cloud.bentoml.com'

--api-token <api_token>¶: BentoCloud 用户 API 令牌

--context <cloud_context>¶: BentoCloud 上下文名称。

--do-not-track¶: 不发送使用信息

--verbose, --debug¶: 生成调试信息

-q, --quiet¶: 禁止所有警告和信息日志

环境变量

update-current-context¶

更新当前上下文

bentoml cloud update-current-context [OPTIONS] CONTEXT_NAME

选项

--context <cloud_context>¶: BentoCloud 上下文名称。

--do-not-track¶: 不发送使用信息

--verbose, --debug¶: 生成调试信息

-q, --quiet¶: 禁止所有警告和信息日志

参数

CONTEXT_NAME¶: 必需参数

环境变量

BENTOML_DO_NOT_TRACK: 为 --do-not-track 提供默认值

BENTOML_VERBOSITY: 为 -q 提供默认值

bentoml deploy¶

在 BentoCloud 上创建部署。

使用参数或配置 YAML 文件创建部署。

bentoml deploy [OPTIONS] [BENTO]

选项

-n, --name <name>¶: 部署名称

--cluster <cluster>¶: 集群名称

--access-authorization <access_authorization>¶: 启用访问授权

--scaling-min <scaling_min>¶: 最小扩缩容值

--scaling-max <scaling_max>¶: 最大扩缩容值

--instance-type <instance_type>¶: 实例类型

--strategy <strategy>¶

部署策略

选项:: RollingUpdate | Recreate | RampedSlowRollout | BestEffortControlledRollout

--env <env>¶: 通过 –env key[=value] –env … 传递的环境变量列表

--secret <secret>¶: 通过 –secret name1, –secret name2, … 传递的密钥名称列表

-f, --config-file <config_file>¶: 配置文件路径

--config-dict <config_dict>¶: 配置 JSON 字符串

--wait, --no-wait¶: 不等待部署准备就绪

--timeout <timeout>¶: 部署准备就绪的超时时间（秒）

--arg <KEY=VALUE>¶: 以 key1=value1[,key2=value2…] 形式指定的 Bento 参数对，可以指定多次

参数

BENTO¶: 可选参数

bentoml deployment¶

部署子命令组

bentoml deployment [OPTIONS] COMMAND [ARGS]...

apply¶

在 BentoCloud 上应用部署。

可以使用配置 YAML 文件应用部署。

bentoml deployment apply [OPTIONS] [BENTO]

选项

-n, --name <name>¶: 部署名称

--cluster <cluster>¶: 集群名称

--access-authorization <access_authorization>¶: 启用访问授权

--scaling-min <scaling_min>¶: 最小扩缩容值

--scaling-max <scaling_max>¶: 最大扩缩容值

--instance-type <instance_type>¶: 实例类型

--strategy <strategy>¶

部署策略

选项:: RollingUpdate | Recreate | RampedSlowRollout | BestEffortControlledRollout

--env <env>¶: 通过 –env key[=value] –env … 传递的环境变量列表

--secret <secret>¶: 通过 –secret name1, –secret name2, … 传递的密钥名称列表

-f, --config-file <config_file>¶: 配置文件路径

--config-dict <config_dict>¶: 配置 JSON 字符串

--context <cloud_context>¶: BentoCloud 上下文名称。

--do-not-track¶: 不发送使用信息

--verbose, --debug¶: 生成调试信息

-q, --quiet¶: 禁止所有警告和信息日志

参数

BENTO¶: 可选参数

环境变量

BENTOML_DO_NOT_TRACK: 为 --do-not-track 提供默认值

BENTOML_VERBOSITY: 为 -q 提供默认值

create¶

在 BentoCloud 上创建部署。

使用参数或配置 YAML 文件创建部署。

bentoml deployment create [OPTIONS] [BENTO]

选项

-n, --name <name>¶: 部署名称

--cluster <cluster>¶: 集群名称

--access-authorization <access_authorization>¶: 启用访问授权

--scaling-min <scaling_min>¶: 最小扩缩容值

--scaling-max <scaling_max>¶: 最大扩缩容值

--instance-type <instance_type>¶: 实例类型

--strategy <strategy>¶

部署策略

选项:: RollingUpdate | Recreate | RampedSlowRollout | BestEffortControlledRollout

--env <env>¶: 通过 –env key[=value] –env … 传递的环境变量列表

--secret <secret>¶: 通过 –secret name1, –secret name2, … 传递的密钥名称列表

-f, --config-file <config_file>¶: 配置文件路径

--config-dict <config_dict>¶: 配置 JSON 字符串

--wait, --no-wait¶: 不等待部署准备就绪

--timeout <timeout>¶: 部署准备就绪的超时时间（秒）

--arg <KEY=VALUE>¶: 以 key1=value1[,key2=value2…] 形式指定的 Bento 参数对，可以指定多次

--context <cloud_context>¶: BentoCloud 上下文名称。

--do-not-track¶: 不发送使用信息

--verbose, --debug¶: 生成调试信息

-q, --quiet¶: 禁止所有警告和信息日志

参数

BENTO¶: 可选参数

环境变量

BENTOML_DO_NOT_TRACK: 为 --do-not-track 提供默认值

BENTOML_VERBOSITY: 为 -q 提供默认值

delete¶

删除 BentoCloud 上的部署。

bentoml deployment delete [OPTIONS] NAME

选项

--cluster <cluster>¶: 集群名称。

--context <cloud_context>¶: BentoCloud 上下文名称。

--do-not-track¶: 不发送使用信息

--verbose, --debug¶: 生成调试信息

-q, --quiet¶: 禁止所有警告和信息日志

参数

NAME¶: 必需参数

环境变量

BENTOML_DO_NOT_TRACK: 为 --do-not-track 提供默认值

BENTOML_VERBOSITY: 为 -q 提供默认值

get¶

获取 BentoCloud 上的部署。

bentoml deployment get [OPTIONS] NAME

选项

--cluster <cluster>¶: 集群名称。

-o, --output <output>¶

显示此命令的输出。

选项:: yaml | json

--context <cloud_context>¶: BentoCloud 上下文名称。

--do-not-track¶: 不发送使用信息

--verbose, --debug¶: 生成调试信息

-q, --quiet¶: 禁止所有警告和信息日志

参数

NAME¶: 必需参数

环境变量

BENTOML_DO_NOT_TRACK: 为 --do-not-track 提供默认值

BENTOML_VERBOSITY: 为 -q 提供默认值

list¶

列出 BentoCloud 上的现有部署。

bentoml deployment list [OPTIONS]

选项

--cluster <cluster>¶: 集群名称。

--search <search>¶: 搜索列表请求。

-o, --output <output>¶

显示此命令的输出。

选项:: json | yaml | table

--label <KEY=VALUE>¶: 按标签过滤部署。

--context <cloud_context>¶: BentoCloud 上下文名称。

--do-not-track¶: 不发送使用信息

--verbose, --debug¶: 生成调试信息

-q, --quiet¶: 禁止所有警告和信息日志

环境变量

BENTOML_DO_NOT_TRACK: 为 --do-not-track 提供默认值

BENTOML_VERBOSITY: 为 -q 提供默认值

list-instance-types¶

列出 BentoCloud 集群中的现有实例类型。

bentoml deployment list-instance-types [OPTIONS]

选项

--cluster <cluster>¶: 集群名称。

-o, --output <output>¶

显示此命令的输出。

选项:: json | yaml | table

--context <cloud_context>¶: BentoCloud 上下文名称。

--do-not-track¶: 不发送使用信息

--verbose, --debug¶: 生成调试信息

-q, --quiet¶: 禁止所有警告和信息日志

环境变量

BENTOML_DO_NOT_TRACK: 为 --do-not-track 提供默认值

BENTOML_VERBOSITY: 为 -q 提供默认值

terminate¶

终止 BentoCloud 上的部署。

bentoml deployment terminate [OPTIONS] NAME

选项

--cluster <cluster>¶: 集群名称。

--wait¶: 等待部署被终止

--context <cloud_context>¶: BentoCloud 上下文名称。

--do-not-track¶: 不发送使用信息

--verbose, --debug¶: 生成调试信息

-q, --quiet¶: 禁止所有警告和信息日志

参数

NAME¶: 必需参数

环境变量

BENTOML_DO_NOT_TRACK: 为 --do-not-track 提供默认值

BENTOML_VERBOSITY: 为 -q 提供默认值

update¶

更新 BentoCloud 上的部署。

可以使用参数或配置 YAML 文件更新部署。

您还可以通过提供项目路径或现有 Bento 来更新 Bento。

bentoml deployment update [OPTIONS] [NAME]

选项

--cluster <cluster>¶: 集群名称。

--bento <bento>¶: Bento 名称或 Bento 项目目录路径

--access-authorization <access_authorization>¶: 启用访问授权

--scaling-min <scaling_min>¶: 最小扩缩容值

--scaling-max <scaling_max>¶: 最大扩缩容值

--instance-type <instance_type>¶: 实例类型

--strategy <strategy>¶

部署策略

选项:: RollingUpdate | Recreate | RampedSlowRollout | BestEffortControlledRollout

--env <env>¶: 通过 –env key[=value] –env … 传递的环境变量列表

--secret <secret>¶: 通过 –secret name1, –secret name2, … 传递的密钥名称列表

-f, --config-file <config_file>¶: 配置文件路径，与其他配置选项互斥

--config-dict <config_dict>¶: 配置 JSON 字符串

--arg <KEY=VALUE>¶: 以 key1=value1[,key2=value2…] 形式指定的 Bento 参数对，可以指定多次

--context <cloud_context>¶: BentoCloud 上下文名称。

--do-not-track¶: 不发送使用信息

--verbose, --debug¶: 生成调试信息

-q, --quiet¶: 禁止所有警告和信息日志

参数

NAME¶: 可选参数

环境变量

BENTOML_DO_NOT_TRACK: 为 --do-not-track 提供默认值

BENTOML_VERBOSITY: 为 -q 提供默认值

bentoml secret¶

密钥子命令组

bentoml secret [OPTIONS] COMMAND [ARGS]...

apply¶

在 BentoCloud 上应用密钥更新。

通过 key1=value1 key2=value2 传递键值对

通过 key1=@./path_to_file1 key2=@./path_to_file2 从文件传递键值

bentoml secret apply [OPTIONS] NAME [KEY_VALS]...

选项

--cluster <cluster>¶: 集群名称

-d, --description <description>¶: 密钥描述

-t, --type <type>¶

挂载为环境变量或文件

选项:: env | file

-p, --path <path>¶: 密钥在容器中挂载的路径。该路径必须位于 ($BENTOML_HOME) 目录下。

-f, --from-file <DOTENV_FILE>¶: 从 dotenv 文件读取环境变量

--context <cloud_context>¶: BentoCloud 上下文名称。

--do-not-track¶: 不发送使用信息

--verbose, --debug¶: 生成调试信息

-q, --quiet¶: 禁止所有警告和信息日志

参数

NAME¶: 必需参数

KEY_VALS¶: 可选参数

环境变量

BENTOML_DO_NOT_TRACK: 为 --do-not-track 提供默认值

BENTOML_VERBOSITY: 为 -q 提供默认值

create¶

在 BentoCloud 上创建密钥。

通过 key1=value1 key2=value2 传递键值对

通过 key1=@./path_to_file1 key2=@./path_to_file2 从文件传递键值

bentoml secret create [OPTIONS] NAME [KEY_VALS]...

选项

-d, --description <description>¶: 密钥描述

-t, --type <type>¶

挂载为环境变量或文件

选项:: env | file

--cluster <cluster>¶: 集群名称

-p, --path <path>¶: 密钥在容器中挂载的路径。该路径必须位于 ($BENTOML_HOME) 目录下。

-f, --from-file <DOTENV_FILE>¶: 从 dotenv 文件读取环境变量

--context <cloud_context>¶: BentoCloud 上下文名称。

--do-not-track¶: 不发送使用信息

--verbose, --debug¶: 生成调试信息

-q, --quiet¶: 禁止所有警告和信息日志

参数

NAME¶: 必需参数

KEY_VALS¶: 可选参数

环境变量

BENTOML_DO_NOT_TRACK: 为 --do-not-track 提供默认值

BENTOML_VERBOSITY: 为 -q 提供默认值

delete¶

删除 BentoCloud 上的密钥。

bentoml secret delete [OPTIONS] NAME

选项

--cluster <cluster>¶: 集群名称

--context <cloud_context>¶: BentoCloud 上下文名称。

--do-not-track¶: 不发送使用信息

--verbose, --debug¶: 生成调试信息

-q, --quiet¶: 禁止所有警告和信息日志

参数

NAME¶: 必需参数

环境变量

BENTOML_DO_NOT_TRACK: 为 --do-not-track 提供默认值

BENTOML_VERBOSITY: 为 -q 提供默认值

list¶

列出 BentoCloud 上的所有密钥。

bentoml secret list [OPTIONS]

选项

--search <search>¶: 搜索列表请求。

-o, --output <output>¶

显示此命令的输出。

选项:: json | yaml | table

--context <cloud_context>¶: BentoCloud 上下文名称。

--do-not-track¶: 不发送使用信息

--verbose, --debug¶: 生成调试信息

-q, --quiet¶: 禁止所有警告和信息日志

环境变量

BENTOML_DO_NOT_TRACK: 为 --do-not-track 提供默认值

BENTOML_VERBOSITY: 为 -q 提供默认值