pods

Pod 资源的模型和管理器。

class Pod(attrs: Mapping[str, Any] | None = None, client: APIClient | None = None, collection: Manager | None = None)[source]

基类:PodmanResource

由 Podman 服务管理的 Pod 的详细信息和配置。

初始化 PodmanResource 的基类。

参数:
  • attrs – 来自 Podman 服务的资源属性映射。

  • client – 与 Podman 服务的已配置连接。

  • collection – 此类资源的管理器,名为 collection 以确保兼容性

kill(signal: str | int | None = None) None[source]

向 Pod 发送信号。

参数:

signal – 要发送到 Pod 的信号。

引发:
  • NotFound – 当 Pod 未找到时

  • APIError – 当服务报告错误时

pause() None[source]

暂停 Pod。

引发:
  • NotFound – 当 Pod 未找到时

  • APIError – 当服务报告错误时

reload() None

从服务刷新此对象的的数据。

remove(force: bool | None = None) None[source]

删除 Pod。

参数:

force – 为 True 时,在删除 Pod 之前停止并删除 Pod 中的所有容器。

引发:
  • NotFound – 当 Pod 未找到时

  • APIError – 当服务报告错误时

restart() None[source]

重启 Pod。

引发:
  • NotFound – 当 Pod 未找到时

  • APIError – 当服务报告错误时

start() None[source]

启动 Pod。

引发:
  • NotFound – 当 Pod 未找到时

  • APIError – 当服务报告错误时

stop(timeout: None | float | Tuple[float, float] | Tuple[float, None] = None) None[source]

停止 Pod。

引发:
  • NotFound – 当 Pod 未找到时

  • APIError – 当服务报告错误时

top(**kwargs) Dict[str, Any][source]

报告 Pod 中正在运行的进程。

关键字参数:

ps_args (str) – 传递给 ps 的可选参数。

引发:
  • NotFound – 当 Pod 未找到时

  • APIError – 当服务报告错误时

unpause() None[source]

取消暂停 Pod。

引发:
  • NotFound – 当 Pod 未找到时

  • APIError – 当服务报告错误时

property id

返回对象的标识符。

类型:

str

property name

返回 Pod 的名称。

类型:

str

property short_id

返回截断的标识符。当 id 中包含 ‘sha256’ 时,会保留。

不会尝试确保返回的值对所有资源在语义上都有意义。

类型:

str