BentoCloud API

This page provides API reference for creating and managing BentoCloud Deployments.

See also

See Manage Deployments for usage details.

Create

Create a Deployment on BentoCloud.

bentoml.deployment.create(name: str | None = None, path_context: str | None = None, *, bento: Tag | str | None = None, cluster: str | None = None, access_authorization: bool | None = None, scaling_min: int | None = None, scaling_max: int | None = None, instance_type: str | None = None, strategy: str | None = None, envs: t.List[EnvItemSchema] | t.List[dict[str, t.Any]] | None = None, extras: dict[str, t.Any] | None = None) → Deployment

bentoml.deployment.create(name: str | None = None, path_context: str | None = None, *, bento: Tag | str | None = None, config_file: str | None = None) → Deployment

bentoml.deployment.create(name: str | None = None, path_context: str | None = None, *, bento: Tag | str | None = None, config_dict: dict[str, t.Any] | None = None) → Deployment

For more information, see Create Deployments.

Get

Retrieve details about a specific Deployment.

bentoml.deployment.get(name: str, cluster: str | None = None, _cloud_client: BentoCloudClient = <simple_di.providers.SingletonFactory object>) → Deployment

For more information, see View.

List

List all Deployments on BentoCloud.

bentoml.deployment.list(cluster: str | None = None, search: str | None = None, dev: bool = False, q: str | None = None, labels: t.List[LabelItemSchema] | t.List[dict[str, t.Any]] | None = None, _cloud_client: BentoCloudClient = <simple_di.providers.SingletonFactory object>) → t.List[Deployment]

Update

Update the configuration of a specific Deployment.

bentoml.deployment.update(name: str | None = None, path_context: str | None = None, context: str | None = ..., cluster: str | None = None, *, bento: Tag | str | None = None, access_authorization: bool | None = None, scaling_min: int | None = None, scaling_max: int | None = None, instance_type: str | None = None, strategy: str | None = None, envs: t.List[EnvItemSchema] | t.List[dict[str, t.Any]] | None = None, extras: dict[str, t.Any] | None = None) → Deployment

bentoml.deployment.update(name: str | None = None, path_context: str | None = None, context: str | None = ..., cluster: str | None = None, *, bento: Tag | str | None = None, config_file: str | None = None) → Deployment

bentoml.deployment.update(name: str | None = None, path_context: str | None = None, context: str | None = ..., cluster: str | None = None, *, bento: Tag | str | None = None, config_dict: dict[str, t.Any] | None = None) → Deployment

For more information, see Update.

Apply

Create or update a Deployment based on the specifications provided.

bentoml.deployment.apply(name: str | None = None, cluster: t.Optional[str] = None, path_context: t.Optional[str] = None, *, bento: t.Optional[t.Union[Tag, str]] = None, config_dict: t.Optional[dict[str, t.Any]] = None) → Deployment

bentoml.deployment.apply(name: str | None = None, cluster: t.Optional[str] = None, path_context: t.Optional[str] = None, *, bento: t.Optional[t.Union[Tag, str]] = None, config_file: t.Optional[str] = None) → Deployment

For more information, see Apply.

Terminate

Stop a Deployment, which can be restarted later.

bentoml.deployment.terminate(name: str, cluster: str | None = None, wait: bool = False, _cloud_client: BentoCloudClient = <simple_di.providers.SingletonFactory object>) → Deployment

For more information, see Terminate.

Delete

Remove a Deployment from BentoCloud.

bentoml.deployment.delete(name: str, cluster: str | None = None, _cloud_client: BentoCloudClient = <simple_di.providers.SingletonFactory object>) → None

For more information, see Delete.