容器 API¶

以下页面包含构建 BentoContainer 的 Python SDK。

bentoml.container.build(bento_tag: Tag | str, backend: t.Literal['docker'] = 'docker', image_tag: tuple[str, ...] | None = None, features: t.Sequence[str] | None = None, *, file: PathType | None = ..., context_path: PathType | None = ..., add_host: dict[str, str] | ArgType = ..., build_arg: dict[str, str] | ArgType = ..., cache_from: str | dict[str, str] | ArgType = ..., disable_content_trust: t.Literal[True, False] = ..., iidfile: PathType | None = ..., isolation: t.Literal['default', 'process', 'hyperv'] | None = ..., label: dict[str, str] | ArgType = ..., network: str | None = ..., no_cache: t.Literal[True, False] = ..., output: str | dict[str, str] | ArgType = ..., platform: str | ArgType = ..., progress: t.Literal['auto', 'tty','plain'] = ..., pull: t.Literal[True, False] = ..., quiet: t.Literal[True, False] = ..., secret: str | dict[str, str] | ArgType = ..., ssh: str | ArgType = ..., target: str | ArgType = ..., **kwargs: t.Any) → t.Any[source]¶

bentoml.container.build(bento_tag: Tag | str, backend: t.Literal['nerdctl'] = 'docker', image_tag: tuple[str] | None = None, features: t.Sequence[str] | None = None, *, file: PathType | None = ..., tag: tuple[str] | None = ..., context_path: PathType = '.', build_arg: dict[str, str] | ArgType = ..., buildkit_host: str | None = ..., cache_from: str | dict[str, str] | ArgType = ..., cache_to: str | dict[str, str] | ArgType = ..., iidfile: PathType | None = ..., ipfs: t.Literal[True, False] = ..., label: dict[str, str] | ArgType = ..., no_cache: t.Literal[True, False] = ..., output: str | dict[str, str] | ArgType = ..., platform: str | ArgType = ..., progress: t.Literal['auto', 'tty', 'plain'] | ArgType = ..., quiet: t.Literal[True, False] = ..., rm: t.Literal[True, False] = ..., secret: str | dict[str, str] | ArgType = ..., ssh: str | ArgType = ..., target: str | None = ..., address: str | None = ..., host: str | None = ..., cgroup_manager: str | None = ..., cni_netconfpath: PathType | None = ..., cni_path: PathType | None = ..., data_root: PathType | None = ..., debug: t.Literal[True, False] = ..., debug_full: t.Literal[True, False] = ..., hosts_dir: str | ArgType = ..., insecure_registry: t.Literal[True, False] = ..., namespace: str | None = ..., snapshotter: str | None = ..., storage_driver: str | None = ..., **kwargs: t.Any) → t.Any

构建给定的 BentoML 为 OCI 兼容镜像。

import bentoml

bento = bentoml.get("pytorch_vgg:latest")
bentoml.container.build(bento, backend='podman', features=["grpc", "tracing"])

参数：

bento_tag – 格式为 NAME:VERSION 的 Bento 标签
backend –
用于构建镜像的后端。当前支持的构建后端包括 docker、podman、buildah、nerdctl、buildctl 和 buildx。

注意

buildx 是 docker buildx build 的语法糖。详情请参阅 https://docs.dockerd.com.cn/build/。这样做的原因是 buildx 曾经是 bentoml containerize 的默认行为。
image_tag – 可选的额外镜像标签，应用于构建的镜像。
features – 可选的包含在容器文件中的功能。有关附加的 BentoML 功能，请参阅概念/bento:Python 包。
**kwargs – 传递给构建后端的可选关键字参数。请参考上面的重载定义以了解每个后端支持的参数。

bentoml.container.health(backend: DefaultBuilder) → bool[source]¶

bentoml.container.health(backend: str) → bool

检查后端是否健康。

参数：: backend – 后端的名称。

注意

如果给定的后端类型是 OCIBuilder 且未注册，请确保使用 bentoml.container.register_backend 注册它。

返回：: 如果后端健康则返回 True，否则返回 False。

bentoml.container.get_backend(backend: DefaultBuilder) → OCIBuilder[source]¶

bentoml.container.get_backend(backend: str) → OCIBuilder

获取给定后端。

抛出异常：: ValueError – 如果给定的后端在后端注册表中不可用。

bentoml.container.register_backend(backend: str, *, buildkit_support: bool, health: t.Callable[[], bool], construct_build_args: t.Callable[P, Arguments], binary: str | None = None, build_cmd: t.Sequence[str] | None = None, env: dict[str, str] | None = None)[source]¶

注册自定义后端，并提供构建和健康检查实现。

参数：

backend – 后端的名称。
buildkit_support – 后端是否支持 BuildKit。
health – 健康检查实现。这是一个不接受参数并返回布尔值的可调用对象。
construct_build_args – 这是一个接受可能的后端关键字参数并返回命令行参数列表的可调用对象。
env – 此 OCI 构建器实现的默认环境变量字典。
binary – 可选的二进制文件路径。如果未提供，将使用后端名称作为二进制文件。请确保该二进制文件在你的 PATH 中。
build_cmd – 可选的构建命令。如果未提供，命令将为 ‘build’。

示例

from bentoml.container import register_backend

register_backend(
    "lima",
    binary=shutil.which("limactl"),
    buildkit_support=True,
    health=buildx_health,
    construct_build_args=buildx_build_args,
    env={"DOCKER_BUILDKIT": "1"},
)

实用函数¶

我们还提供了一些实用函数来帮助你自定义容器化过程。

bentoml.container.get_containerfile(bento_tag: Tag | str, output_path: str | None = None, enable_buildkit: bool = True, features: t.Sequence[str] | None = None, _bento_store: BentoStore = <simple_di.providers.SingletonFactory object>)[source]¶

返回给定 Bento 的生成的容器文件。

注意，Bento 内的容器文件 (Dockerfile) 是极简的，而此实用函数返回的是 bentoml containerize 将使用的容器文件。

注意

如果未指定 output_path，则容器文件的内容将打印到 sys.stderr。如果提供了此参数，则最终容器文件将写入到指定的路径。

参数：

bento_tag – 给定的 bento 标签。
output_path – 可选的输出路径，用于写入最终容器文件。请注意，如果 output_path 是一个目录，则目标文件将是 output_path + os.sep + "<bento_tag>.dockerfile"。
enable_buildkit – 容器文件是否包含 BuildKit 语法。
features – 可选的包含在容器文件中的功能。有关附加的 BentoML 功能，请参阅概念/bento:Python 包。