BentoCloud CLI¶

This page provides API reference for accessing BentoCloud and managing Deployments using the BentoML CLI.

bentoml cloud¶

BentoCloud Subcommands Groups.

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

current-context¶

Get current cloud context.

bentoml cloud current-context [OPTIONS]

Options

--context <cloud_context>¶: BentoCloud context name.

--do-not-track¶: Do not send usage info

--verbose, --debug¶: Generate debug information

-q, --quiet¶: Suppress all warnings and info logs

Environment variables

BENTOML_DO_NOT_TRACK: Provide a default for --do-not-track

BENTOML_VERBOSITY: Provide a default for -q

list-context¶

List all available context.

bentoml cloud list-context [OPTIONS]

Options

--context <cloud_context>¶: BentoCloud context name.

--do-not-track¶: Do not send usage info

--verbose, --debug¶: Generate debug information

-q, --quiet¶: Suppress all warnings and info logs

Environment variables

BENTOML_DO_NOT_TRACK: Provide a default for --do-not-track

BENTOML_VERBOSITY: Provide a default for -q

login¶

bentoml cloud login [OPTIONS]

Options

--endpoint <endpoint>¶

BentoCloud endpoint

Default:: 'https://cloud.bentoml.com'

--api-token <api_token>¶: BentoCloud user API token

--context <cloud_context>¶: BentoCloud context name.

--do-not-track¶: Do not send usage info

--verbose, --debug¶: Generate debug information

-q, --quiet¶: Suppress all warnings and info logs

Environment variables

update-current-context¶

Update current context

bentoml cloud update-current-context [OPTIONS] CONTEXT_NAME

Options

--context <cloud_context>¶: BentoCloud context name.

--do-not-track¶: Do not send usage info

--verbose, --debug¶: Generate debug information

-q, --quiet¶: Suppress all warnings and info logs

Arguments

CONTEXT_NAME¶: Required argument

Environment variables

BENTOML_DO_NOT_TRACK: Provide a default for --do-not-track

BENTOML_VERBOSITY: Provide a default for -q

bentoml deploy¶

Create a deployment on BentoCloud.

Create a deployment using parameters, or using config yaml file.

bentoml deploy [OPTIONS] [BENTO]

Options

-n, --name <name>¶: Deployment name

--cluster <cluster>¶: Name of the cluster

--access-authorization <access_authorization>¶: Enable access authorization

--scaling-min <scaling_min>¶: Minimum scaling value

--scaling-max <scaling_max>¶: Maximum scaling value

--instance-type <instance_type>¶: Type of instance

--strategy <strategy>¶

Deployment strategy

Options:: RollingUpdate | Recreate | RampedSlowRollout | BestEffortControlledRollout

--env <env>¶: List of environment variables pass by –env key[=value] –env …

--secret <secret>¶: List of secret names pass by –secret name1, –secret name2, …

-f, --config-file <config_file>¶: Configuration file path

--config-dict <config_dict>¶: Configuration json string

--wait, --no-wait¶: Do not wait for deployment to be ready

--timeout <timeout>¶: Timeout for deployment to be ready in seconds

Arguments

BENTO¶: Optional argument

bentoml deployment¶

Deployment Subcommands Groups

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

apply¶

Apply a deployment on BentoCloud.

A deployment can be applied using config yaml file.

bentoml deployment apply [OPTIONS] [BENTO]

Options

-n, --name <name>¶: Deployment name

--cluster <cluster>¶: Name of the cluster

--access-authorization <access_authorization>¶: Enable access authorization

--scaling-min <scaling_min>¶: Minimum scaling value

--scaling-max <scaling_max>¶: Maximum scaling value

--instance-type <instance_type>¶: Type of instance

--strategy <strategy>¶

Deployment strategy

Options:: RollingUpdate | Recreate | RampedSlowRollout | BestEffortControlledRollout

--env <env>¶: List of environment variables pass by –env key[=value] –env …

--secret <secret>¶: List of secret names pass by –secret name1, –secret name2, …

-f, --config-file <config_file>¶: Configuration file path

-f, --config-file <config_file>¶: Configuration file path, mututally exclusive with other config options

--config-dict <config_dict>¶: Configuration json string

--context <cloud_context>¶: BentoCloud context name.

--do-not-track¶: Do not send usage info

--verbose, --debug¶: Generate debug information

-q, --quiet¶: Suppress all warnings and info logs

Arguments

BENTO¶: Optional argument

Environment variables

BENTOML_DO_NOT_TRACK: Provide a default for --do-not-track

BENTOML_VERBOSITY: Provide a default for -q

create¶

Create a deployment on BentoCloud.

Create a deployment using parameters, or using config yaml file.

bentoml deployment create [OPTIONS] [BENTO]

Options

-n, --name <name>¶: Deployment name

--cluster <cluster>¶: Name of the cluster

--access-authorization <access_authorization>¶: Enable access authorization

--scaling-min <scaling_min>¶: Minimum scaling value

--scaling-max <scaling_max>¶: Maximum scaling value

--instance-type <instance_type>¶: Type of instance

--strategy <strategy>¶

Deployment strategy

Options:: RollingUpdate | Recreate | RampedSlowRollout | BestEffortControlledRollout

--env <env>¶: List of environment variables pass by –env key[=value] –env …

--secret <secret>¶: List of secret names pass by –secret name1, –secret name2, …

-f, --config-file <config_file>¶: Configuration file path

--config-dict <config_dict>¶: Configuration json string

--wait, --no-wait¶: Do not wait for deployment to be ready

--timeout <timeout>¶: Timeout for deployment to be ready in seconds

--context <cloud_context>¶: BentoCloud context name.

--do-not-track¶: Do not send usage info

--verbose, --debug¶: Generate debug information

-q, --quiet¶: Suppress all warnings and info logs

Arguments

BENTO¶: Optional argument

Environment variables

BENTOML_DO_NOT_TRACK: Provide a default for --do-not-track

BENTOML_VERBOSITY: Provide a default for -q

delete¶

Delete a deployment on BentoCloud.

bentoml deployment delete [OPTIONS] NAME

Options

--cluster <cluster>¶: Name of the cluster.

--context <cloud_context>¶: BentoCloud context name.

--do-not-track¶: Do not send usage info

--verbose, --debug¶: Generate debug information

-q, --quiet¶: Suppress all warnings and info logs

Arguments

NAME¶: Required argument

Environment variables

BENTOML_DO_NOT_TRACK: Provide a default for --do-not-track

BENTOML_VERBOSITY: Provide a default for -q

get¶

Get a deployment on BentoCloud.

bentoml deployment get [OPTIONS] NAME

Options

--cluster <cluster>¶: Name of the cluster.

-o, --output <output>¶

Display the output of this command.

Options:: yaml | json

--context <cloud_context>¶: BentoCloud context name.

--do-not-track¶: Do not send usage info

--verbose, --debug¶: Generate debug information

-q, --quiet¶: Suppress all warnings and info logs

Arguments

NAME¶: Required argument

Environment variables

BENTOML_DO_NOT_TRACK: Provide a default for --do-not-track

BENTOML_VERBOSITY: Provide a default for -q

list¶

List existing deployments on BentoCloud.

bentoml deployment list [OPTIONS]

Options

--cluster <cluster>¶: Name of the cluster.

--search <search>¶: Search for list request.

-o, --output <output>¶

Display the output of this command.

Options:: json | yaml | table

--label <KEY=VALUE>¶: Filter deployments by label(s).

--context <cloud_context>¶: BentoCloud context name.

--do-not-track¶: Do not send usage info

--verbose, --debug¶: Generate debug information

-q, --quiet¶: Suppress all warnings and info logs

Environment variables

BENTOML_DO_NOT_TRACK: Provide a default for --do-not-track

BENTOML_VERBOSITY: Provide a default for -q

list-instance-types¶

List existing instance types in cluster on BentoCloud.

bentoml deployment list-instance-types [OPTIONS]

Options

--cluster <cluster>¶: Name of the cluster.

-o, --output <output>¶

Display the output of this command.

Options:: json | yaml | table

--context <cloud_context>¶: BentoCloud context name.

--do-not-track¶: Do not send usage info

--verbose, --debug¶: Generate debug information

-q, --quiet¶: Suppress all warnings and info logs

Environment variables

BENTOML_DO_NOT_TRACK: Provide a default for --do-not-track

BENTOML_VERBOSITY: Provide a default for -q

terminate¶

Terminate a deployment on BentoCloud.

bentoml deployment terminate [OPTIONS] NAME

Options

--cluster <cluster>¶: Name of the cluster.

--wait¶: Wait for the deployment to be terminated

--context <cloud_context>¶: BentoCloud context name.

--do-not-track¶: Do not send usage info

--verbose, --debug¶: Generate debug information

-q, --quiet¶: Suppress all warnings and info logs

Arguments

NAME¶: Required argument

Environment variables

BENTOML_DO_NOT_TRACK: Provide a default for --do-not-track

BENTOML_VERBOSITY: Provide a default for -q

update¶

Update a deployment on BentoCloud.

A deployment can be updated using parameters, or using config yaml file.

You can also update bento by providing a project path or existing bento.

bentoml deployment update [OPTIONS] [NAME]

Options

--cluster <cluster>¶: Name of the cluster.

--bento <bento>¶: Bento name or path to Bento project directory

--access-authorization <access_authorization>¶: Enable access authorization

--scaling-min <scaling_min>¶: Minimum scaling value

--scaling-max <scaling_max>¶: Maximum scaling value

--instance-type <instance_type>¶: Type of instance

--strategy <strategy>¶

Deployment strategy

Options:: RollingUpdate | Recreate | RampedSlowRollout | BestEffortControlledRollout

--env <env>¶: List of environment variables pass by –env key[=value] –env …

--secret <secret>¶: List of secret names pass by –secret name1, –secret name2, …

-f, --config-file <config_file>¶: Configuration file path, mututally exclusive with other config options

--config-dict <config_dict>¶: Configuration json string

--context <cloud_context>¶: BentoCloud context name.

--do-not-track¶: Do not send usage info

--verbose, --debug¶: Generate debug information

-q, --quiet¶: Suppress all warnings and info logs

Arguments

NAME¶: Optional argument

Environment variables

BENTOML_DO_NOT_TRACK: Provide a default for --do-not-track

BENTOML_VERBOSITY: Provide a default for -q

bentoml secret¶

Secret Subcommands Groups

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

apply¶

Apply a secret update on BentoCloud.

Pass key value pairs by key1=value1 key2=value2

Pass key value from file by key1=@./path_to_file1 key2=@./path_to_file2

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

Options

-d, --description <description>¶: Secret description

-t, --type <type>¶

Mount as Environment Variable or File

Options:: env | file

-p, --path <path>¶: Path where the secret will be mounted in the container. The path must be under the ($BENTOML_HOME) directory.

-f, --from-file <DOTENV_FILE>¶: Read environment variables from dotenv file

--context <cloud_context>¶: BentoCloud context name.

--do-not-track¶: Do not send usage info

--verbose, --debug¶: Generate debug information

-q, --quiet¶: Suppress all warnings and info logs

Arguments

NAME¶: Required argument

KEY_VALS¶: Optional argument(s)

Environment variables

BENTOML_DO_NOT_TRACK: Provide a default for --do-not-track

BENTOML_VERBOSITY: Provide a default for -q

create¶

Create a secret on BentoCloud.

Pass key value pairs by key1=value1 key2=value2

Pass key value from file by key1=@./path_to_file1 key2=@./path_to_file2

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

Options

-d, --description <description>¶: Secret description

-t, --type <type>¶

Mount as Environment Variable or File

Options:: env | file

-p, --path <path>¶: Path where the secret will be mounted in the container. The path must be under the ($BENTOML_HOME) directory.

-f, --from-file <DOTENV_FILE>¶: Read environment variables from dotenv file

--context <cloud_context>¶: BentoCloud context name.

--do-not-track¶: Do not send usage info

--verbose, --debug¶: Generate debug information

-q, --quiet¶: Suppress all warnings and info logs

Arguments

NAME¶: Required argument

KEY_VALS¶: Optional argument(s)

Environment variables

BENTOML_DO_NOT_TRACK: Provide a default for --do-not-track

BENTOML_VERBOSITY: Provide a default for -q

delete¶

Delete a secret on BentoCloud.

bentoml secret delete [OPTIONS] NAME

Options

--context <cloud_context>¶: BentoCloud context name.

--do-not-track¶: Do not send usage info

--verbose, --debug¶: Generate debug information

-q, --quiet¶: Suppress all warnings and info logs

Arguments

NAME¶: Required argument

Environment variables

BENTOML_DO_NOT_TRACK: Provide a default for --do-not-track

BENTOML_VERBOSITY: Provide a default for -q

list¶

List all secrets on BentoCloud.

bentoml secret list [OPTIONS]

Options

--search <search>¶: Search for list request.

-o, --output <output>¶

Display the output of this command.

Options:: json | yaml | table

--context <cloud_context>¶: BentoCloud context name.

--do-not-track¶: Do not send usage info

--verbose, --debug¶: Generate debug information

-q, --quiet¶: Suppress all warnings and info logs

Environment variables

BENTOML_DO_NOT_TRACK: Provide a default for --do-not-track

BENTOML_VERBOSITY: Provide a default for -q