pods_manager

为网络子类化的 Podman 资源管理器。

class PodsManager(client: APIClient = None)

基类: Manager

Pod 资源的专用管理器。

初始化 Manager() 对象。

参数:

client – 配置为连接到 Podman 服务的 APIClient()。

create(name: str, **kwargs) → Pod

创建一个 Pod。

关键字参数:

参见 (API 文档) – https://docs.podman.org.cn/en/latest/_static/api.html#operation/CreatePod] 获取关键字的完整列表。

exists(key: str) → bool

如果 Pod 存在，则返回 True。

get(pod_id: str) → Pod

返回 Pod 的信息，使用名称或 ID。

参数:

pod_id – Pod 的名称或 ID。

引发:

• NotFound – 当网络不存在时

• APIError – 当服务返回错误时

list(**kwargs) → List[Pod]

报告 Pod 信息。

关键字参数:

filters (Mapping[str, str]) –

列出 Pod 的条件。可用的过滤器

• ctr-ids (List[str]): 要按其过滤的容器 ID 列表。

• ctr-names (List[str]): 要按其过滤的容器名称列表。

• ctr-number (List[int]): 列出具有给定容器数量的 Pod。

• ctr-status (List[str]): 列出处于给定状态的容器的 Pod。合法值为：“created”、“running”、“paused”、“stopped”、“exited”或“unknown”

• id (str) - 列出具有此 ID 的 Pod。

• name (str) - 列出具有此名称的 Pod。

• status (List[str]): 列出处于给定状态的 Pod。合法值为：“created”、“running”、“paused”、“stopped”、“exited”或“unknown”

• label (List[str]): 列出具有给定标签的 Pod。

• network (List[str]): 列出与给定网络 ID（而非名称）关联的 Pod。

引发:

APIError – 当服务返回错误时

prepare_model(attrs: PodmanResource | Mapping[str, Any]) → PodmanResourceType

根据一组属性创建模型。

prune(filters: Dict[str, str] | None = None) → Dict[str, Any]

删除未使用的 Pod。

返回:

• PodsDeleted (List[str]): 已删除的 Pod ID 列表。

• SpaceReclaimed (int): 始终为零。

返回类型:

字典键

引发:

APIError – 当服务报告错误时

remove(pod_id: Pod | str, force: bool | None = None) → None

删除 Pod。

参数:

• pod_id – 要删除的 Pod 的标识符。

• force – 如果为 True，则在删除 Pod 之前停止并删除 Pod 中的所有容器。

引发:

• NotFound – 当 Pod 未找到时

• APIError – 当服务报告错误时

备注

仅限 Podman。

stats(**kwargs) → List[Dict[str, Any]] | Iterator[List[Dict[str, Any]]]

Pod 中容器的资源使用统计信息。

关键字参数:

• all (bool) – 提供所有正在运行的 Pod 的统计信息。

• name (Union[str, List[str]]) – 要包含在报告中的 Pod。

• stream (bool) – 流式传输统计信息，直到取消。默认值：False。

• decode (bool) – 如果为 True，则响应将解码为字典。默认值：False。

引发:

• NotFound – 当 Pod 未找到时

• APIError – 当服务报告错误时

property resource

prepare_model() 将创建 Pod 类。

类型:

Type[Pod]