containers_create¶

提供创建容器的 `create()` 方法的 Mixin。

class CreateMixin[source]¶

基类: object

为 `ContainersManager` 提供创建方法的类。

create(image: Image | str, command: str | List[str] | None = None, **kwargs) → Container[source]¶

创建一个容器。

参数:

image – 要运行的镜像。
command – 在容器中运行的命令。

关键字参数:

auto_remove (bool) – 当容器进程退出时，启用在守护进程端自动删除容器。
blkio_weight_device (Dict[str, Any]) – 块IO权重（相对设备权重），格式为：[{“Path”: “device_path”, “Weight”: weight}]。
blkio_weight (int) – 块IO权重（相对权重），接受10到1000之间的权重值。
cap_add (List[str]) – 添加内核功能。例如：[“SYS_ADMIN”, “MKNOD”]。
cap_drop (List[str]) – 删除内核功能。
cgroup_parent (str) – 覆盖默认的父cgroup。
cpu_count (int) – 可用CPU的数量（仅限Windows）。
cpu_percent (int) – 可用CPU的可用百分比（仅限Windows）。
cpu_period (int) – CPU周期长度（微秒）。
cpu_quota (int) – 容器在一个CPU周期内可以获得的CPU时间（微秒）。
cpu_rt_period (int) – 限制CPU实时周期（微秒）。
cpu_rt_runtime (int) – 限制CPU实时运行时间（微秒）。
cpu_shares (int) – CPU份额（相对权重）。
cpuset_cpus (str) – 允许执行的CPU（0-3, 0,1）。
cpuset_mems (str) – 允许执行的内存节点（MEM）（0-3, 0,1）。仅在NUMA系统上有效。
detach (bool) – 在后台运行容器并返回一个 `Container` 对象。
device_cgroup_rules (List[str]) – 要应用于容器的cgroup规则列表。
device_read_bps – 限制从设备读取速率（每秒字节数），格式为：[{“Path”: “device_path”, “Rate”: rate}]
device_read_iops – 限制从设备读取速率（每秒IO次数）。
device_write_bps – 限制向设备写入速率（每秒字节数）。
device_write_iops – 限制向设备写入速率（每秒IO次数）。
devices (List[str]) –
将主机设备公开给容器，以List[str]的形式，格式为<path_on_host>:<path_in_container>:<cgroup_permissions>。

例如
/dev/sda:/dev/xvda:rwm 允许容器通过容器内的名为/dev/xvda的节点读取和写入主机上的/dev/sda。
dns (List[str]) – 设置自定义DNS服务器。
dns_opt (List[str]) – 要添加到容器的resolv.conf文件中的其他选项。
dns_search (List[str]) – DNS搜索域。
domainname (Union[str, List[str]]) – 设置自定义DNS搜索域。
entrypoint (Union[str, List[str]]) – 容器的入口点。
environment (Union[Dict[str, str], List[str]) – 要在容器内部设置的环境变量，可以是字典或List[str]，格式为[“SOMEVARIABLE=xxx”, “SOMEOTHERVARIABLE=xyz”]。
extra_hosts (Dict[str, str]) – 要在容器内部解析的其他主机名，以主机名到IP地址的映射形式。
group_add (List[str]) – 容器进程将以其运行的其他组名和/或ID的列表。
healthcheck (Dict[str,Any]) – 指定要执行的测试以检查容器是否健康。
health_check_on_failure_action (int) – 如果健康检查失败，则指定一个操作。
hostname (str) – 容器的可选主机名。
init (bool) – 在容器内运行一个init，它转发信号并回收进程。
init_path (str) – docker-init二进制文件的路径。
ipc_mode (str) – 设置容器的IPC模式。
isolation (str) – 要使用的隔离技术。默认值：None。
kernel_memory (int or str) – 内核内存限制。
labels (Union[Dict[str, str], List[str]) – 名称-值标签的字典（例如{“label1”: “value1”, “label2”: “value2”}）或要设置为空值的标签名称列表（例如[“label1”, “label2”]）。
links (Optional[Dict[str, str]]) – 使用{‘container’: ‘alias’}格式的链接映射。别名是可选的。此字典中声明的容器将使用提供的别名链接到新容器。默认值：None。
log_config (LogConfig) – 日志配置。
lxc_config (Dict[str, str]) – LXC配置。
mac_address (str) – 要分配给容器的MAC地址。
mem_limit (Union[int, str]) – 内存限制。接受浮点值（表示以字节为单位创建的容器的内存限制）或带有单位标识符字符的字符串（100000b、1000k、128m、1g）。如果指定了不带单位字符的字符串，则假定字节为目标单位。
mem_reservation (Union[int, str]) – 内存软限制。
mem_swappiness (int) – 调节容器的内存交换行为。接受0到100之间的数字。
memswap_limit (Union[int, str]) – 容器允许消耗的最大内存+交换空间量。
mounts (List[Mount]) –
要添加到容器的挂载点的规范。比卷更强大的替代方案。列表中的每个项目都应为 `Mount` 对象。例如

[

{

“type”: “bind”,

”source”: “/a/b/c1”,

”target” “/d1”,

”read_only”: True,

”relabel”: “Z”

},

{

“type”: “tmpfs”,

# 如果未传递此选项，则会创建常规目录

# 而不是tmpfs挂载点！！！

# 因为这会导致在/proc/self/mountinfo中

# 出现无效条目

”source”: “tmpfs”,

”target” “/d2”,

”size”: “100k”,

”chown”: True

}

]
name (str) – 此容器的名称。
nano_cpus (int) – 以1e-9 CPU为单位的CPU配额。
networks (Dict[str, Dict[str, Union[str, List[str]]) –
在创建容器期间将连接到容器的网络。网络配置的值可以是
- 字符串
- 字符串列表（例如别名）
network_disabled (bool) – 禁用网络。
network_mode (str) –
以下之一
- bridge: 在桥接网络上为容器创建一个新的网络栈。
- none: 此容器没有网络。
- container:<name|id>: 重用另一个容器的网络栈。
- host: 使用主机网络栈。
- ns:<path>: 用户定义的netns路径。
与network不兼容。
oom_kill_disable (bool) – 是否禁用OOM killer。
oom_score_adj (int) – 一个整数，包含赋予容器的分数，以调整OOM killer的偏好。
pid_mode (str) – 如果设置为host，则在容器内使用主机PID命名空间。
pids_limit (int) – 调节容器的pids限制。设置为-1表示无限制。
platform (str) – 格式为os[/arch[/variant]]的平台。仅当方法需要拉取请求的镜像时才使用。
ports (Dict[str, Union[int, Tuple[str, int], List[int], Dict[str, Union[int, Tuple[str, int], List[int]]]]]) –
要绑定到容器内的端口。

字典的键是要绑定到容器内的端口，可以是整数或字符串，格式为port/protocol，其中protocol可以是tcp、udp或sctp。

字典的值是要在主机上打开的相应端口，可以是
- 端口号，以整数表示。
  
  例如：{‘2222/tcp’: 3333} 将在容器内暴露端口2222作为主机上的端口3333。
- None，分配随机主机端口。
  
  例如：{‘2222/tcp’: None}。
- 如果要指定主机接口，则为(address, port)元组。
  
  例如：{‘1111/tcp’: (‘127.0.0.1’, 1111)}。
- 如果要将多个主机端口绑定到单个容器端口，则为整数或(address, port)元组的列表。
  
  例如：{‘1111/tcp’: [1234, (“127.0.0.1”, 4567)]}。
  
  例如：{‘9090’: 7878, ‘10932/tcp’: ‘8781’,
  ”8989/tcp”: (“127.0.0.1”, 9091)}
- 除了随机主机端口之外，还可以是上述选项的字典。
  字典还有额外的选项“range”，
  允许绑定端口范围。
  
  例如
  - {‘2222/tcp’: {“port”: 3333, “range”: 4}}
  - {‘1111/tcp’: {“port”: (‘127.0.0.1’, 1111), “range”: 4}}
  - {‘1111/tcp’: [
    
    {“port”: 1234, “range”: 4},
    
    {“ip”: “127.0.0.1”, “port”: 4567}
    
    ]
  }
privileged (bool) – 为此容器提供扩展权限。
publish_all_ports (bool) – 将所有端口发布到主机。
read_only (bool) – 以只读方式挂载容器的根文件系统。
read_write_tmpfs (bool) – 在将read_only选项设置为True的情况下，以读写方式挂载临时文件系统。默认值：False。
remove (bool) – 当容器运行完成后删除它。默认值：False。
restart_policy (Dict[str, Union[str, int]]) –
当容器退出时重新启动它。配置为一个字典，其中包含以下键
- Name: on-failure或always之一。
- MaximumRetryCount: 失败时重新启动容器的次数。
例如：{“Name”: “on-failure”, “MaximumRetryCount”: 5}
runtime (str) – 要与此容器一起使用的运行时。
secrets (List[Union[str, Secret, Dict[str, Union[str, int]]]]) –
挂载到此容器的密钥。

例如
- 作为字符串列表，每个字符串表示密钥的 ID 或名称
  [‘my_secret’, ‘my_secret2’]
- 作为 Secret 对象列表，读取相应的 ID
  [Secret, Secret]
- 作为字典列表
  [
  
  {
  
  “source”: “my_secret”, # 表示密钥的 ID 或名称的字符串
  # 密钥
  
  ”target”: “/my_secret”, # 将源挂载到的可选目标，
  # 默认回退到 /run/secrets/source
  
  ”uid”: 1000, # 可选的 UID，如果未给出则回退到 0
  #
  
  ”gid”: 1000, # 可选的 GID，如果未给出则回退到 0
  #
  
  ”mode”: 0o400, # 应用于目标的可选模式，
  # 使用 0o 前缀表示八进制整数
  
  },
  
  ]
secret_env (Dict[str, str]) –
作为环境变量添加到容器中的密钥。

例如：{“VARIABLE1”: “NameOfSecret”, “VARIABLE2”: “NameOfAnotherSecret”}
security_opt (List[str]) – 用于自定义 MLS 系统（如 SELinux）标签的字符串列表。
shm_size (Union[str, int]) – /dev/shm 的大小（例如 1G）。
stdin_open (bool) – 即使未附加，也保持 STDIN 打开。
stdout (bool) – 当 detach=False 时返回 STDOUT 的日志。默认值：True。
stderr (bool) – 当 detach=False 时返回 STDERR 的日志。默认值：False。
stop_signal (str) – 用于停止容器的停止信号（例如 SIGINT）。
storage_opt (Dict[str, str]) – 每个容器的存储驱动程序选项，作为键值映射。
stream (bool) – 如果为真且 detach 为假，则返回日志生成器而不是字符串。如果 detach 为真，则忽略。默认值：False。
sysctls (Dict[str, str]) – 在容器中设置的内核参数。
tmpfs (Dict[str, str]) –
要挂载的临时文件系统，作为字典将容器内的路径映射到该路径的选项。

例如：{‘/mnt/vol2’: ‘’, ‘/mnt/vol1’: ‘size=3G,uid=1000’}
tty (bool) – 分配伪终端。
ulimits (List[Ulimit]) – 在容器内设置的 Ulimit。
use_config_proxy (bool) – 如果为 True，并且如果 docker 客户端配置文件（默认情况下为 ~/.config/containers/config.json）包含代理配置，则相应的环境变量将设置在正在构建的容器中。
user (Union[str, int]) – 在容器内以其运行命令的用户名称或 UID。
userns_mode (str) – 在启用用户命名空间重新映射选项时设置容器的用户命名空间模式。支持的值记录在这里
uts_mode (str) – 设置容器的 UTS 命名空间模式。这些是支持的值。
version (str) – 要使用的 API 版本。设置为 auto 以自动检测服务器的版本。默认值：3.0.0
volume_driver (str) – 卷驱动程序/插件的名称。
volumes (Dict[str, Dict[str, Union[str, list]]]) –
一个字典，用于配置挂载到容器内的卷。键是主机路径或卷名称，值是一个字典，其键为
- bind: 将卷挂载到容器内的路径
- mode: 以 rw 挂载卷进行读写，或以 ro 挂载只读。
  为 docker-py 兼容性保留
- extended_mode: 传递给卷挂载的选项列表。
例如

{

‘test_bind_1’

{‘bind’: ‘/mnt/vol1’, ‘mode’: ‘rw’},

’test_bind_2’

{‘bind’: ‘/mnt/vol2’, ‘extended_mode’: [‘ro’, ‘noexec’]},

’test_bind_3’

{‘bind’: ‘/mnt/vol3’, ‘extended_mode’: [‘noexec’], ‘mode’: ‘rw’}

}
volumes_from (List[str]) – 要从中获取卷的容器名称或 ID 列表。
working_dir (str) – 工作目录的路径。
workdir (str) – working_dir 的别名 - 工作目录的路径。

返回值:

一个 Container 对象。

引发:

ImageNotFound – 当 Podman 服务找不到镜像时
APIError – 当 Podman 服务报告错误时

containers_create¶

Podman Python SDK

导航

相关主题