界面:ContainerCreateOptions
定义于: packages/extension-api/src/extension-api.d.ts:3250
属性
ArgsEscaped?
可选
ArgsEscaped:boolean
定义于: packages/extension-api/src/extension-api.d.ts:3381
默认值: false
命令已转义(仅限 Windows)
AttachStderr?
可选
AttachStderr:boolean
定义于: packages/extension-api/src/extension-api.d.ts:3349
是否附加到 stderr
(默认 false)
AttachStdin?
可选
AttachStdin:boolean
定义于: packages/extension-api/src/extension-api.d.ts:3339
是否附加到 stdin
(默认 false)
AttachStdout?
可选
AttachStdout:boolean
定义于: packages/extension-api/src/extension-api.d.ts:3344
是否附加到 stdout
(默认 false)
Cmd?
可选
Cmd:string
[]
定义于: packages/extension-api/src/extension-api.d.ts:3327
要运行的命令,表示为字符串数组
Detach?
可选
Detach:boolean
定义于: packages/extension-api/src/extension-api.d.ts:3364
在后台运行容器
Domainname?
可选
Domainname:string
定义于: packages/extension-api/src/extension-api.d.ts:3281
要用于容器的域名。
Entrypoint?
optional
Entrypoint:string
|string
[]
定义于: packages/extension-api/src/extension-api.d.ts:3334
容器的入口点,可以是字符串或字符串数组。
如果数组恰好包含一个空字符串([""]
),则入口点会重置为系统默认值(即,当 Containerfile 中没有 ENTRYPOINT 指令时 docker 使用的入口点)。
Env?
可选
Env:string
[]
定义于: packages/extension-api/src/extension-api.d.ts:3291
要在容器内设置的环境变量列表,格式为 ["VAR=value", ...]
。不带 =
的变量将从环境中移除,而不是赋空值。
EnvFiles?
可选
EnvFiles:string
[]
定义于: packages/extension-api/src/extension-api.d.ts:3296
要使用的环境变量文件
ExposedPorts?
可选
ExposedPorts:object
定义于: packages/extension-api/src/extension-api.d.ts:3307
映射端口到空对象的对象,格式为: {"<port>/<tcp|udp|sctp>": {}}
索引签名
[port
: string
]: object
HealthCheck?
可选
HealthCheck:HealthConfig
定义于: packages/extension-api/src/extension-api.d.ts:3374
用于检查容器是否健康的测试。有关使用详情,请参阅 HealthConfig。
HostConfig?
可选
HostConfig:HostConfig
定义于: packages/extension-api/src/extension-api.d.ts:3312
依赖于运行容器的主机的容器配置
Hostname?
可选
Hostname:string
定义于: packages/extension-api/src/extension-api.d.ts:3276
要在容器中使用的主机名,必须是有效的 RFC 1123 主机名。
Image?
可选
Image:string
定义于: packages/extension-api/src/extension-api.d.ts:3317
创建容器时要使用的镜像的名称(或引用)。
Labels?
可选
Labels:object
定义于: packages/extension-api/src/extension-api.d.ts:3301
用户定义的键/值元数据
索引签名
[label
: string
]: string
MacAddress?
可选
MacAddress:string
定义于: packages/extension-api/src/extension-api.d.ts:3401
容器的 MAC 地址。
name?
可选
name:string
定义于: packages/extension-api/src/extension-api.d.ts:3254
为容器分配指定名称。必须符合正则表达式/?[a-zA-Z0-9][a-zA-Z0-9_.-]+
。如果未指定,平台将为容器分配一个唯一名称。
NetworkConfig?
可选
NetworkConfig:NetworkingConfig
定义于: packages/extension-api/src/extension-api.d.ts:3425
NetworkDisabled?
可选
NetworkDisabled:boolean
定义于: packages/extension-api/src/extension-api.d.ts:3396
禁用容器的网络连接。
OnBuild?
可选
OnBuild:string
[]
定义于: packages/extension-api/src/extension-api.d.ts:3406
在镜像的 Dockerfile
中定义的 ONBUILD
元数据。
OpenStdin?
可选
OpenStdin:boolean
定义于: packages/extension-api/src/extension-api.d.ts:3354
是否打开 stdin
(默认 false)
platform?
可选
platform:string
定义于: packages/extension-api/src/extension-api.d.ts:3271
默认值:""
用于镜像查找的平台,格式为 os[/arch[/variant]]
。
当指定此选项时,守护进程会检查本地镜像缓存中是否存在具有指定操作系统和架构的请求镜像,否则返回 404
状态。
如果未设置该选项,则使用主机的本地操作系统和架构在镜像缓存中查找镜像。但是,如果未传递平台且在本地镜像缓存中找到了给定的镜像,但其操作系统或架构不匹配,则容器将使用可用镜像创建,并在响应的 Warnings
字段中添加一个警告,例如;
WARNING: The requested image's platform (linux/arm64/v8) does not
match the detected host platform (linux/amd64) and no
specific platform was requested
pod?
可选
pod:string
定义于: packages/extension-api/src/extension-api.d.ts:3430
要在其中创建容器的 Pod
Shell?
可选
Shell:string
[]
定义于: packages/extension-api/src/extension-api.d.ts:3423
当 RUN
、CMD
和 ENTRYPOINT
使用 shell 时使用的 shell。
start?
可选
start:boolean
定义于: packages/extension-api/src/extension-api.d.ts:3369
立即启动容器(默认 true)
StdinOnce?
可选
StdinOnce:boolean
定义于: packages/extension-api/src/extension-api.d.ts:3359
当一个附加客户端断开连接后关闭 stdin
(默认 false)。
StopSignal?
可选
StopSignal:string
定义于: packages/extension-api/src/extension-api.d.ts:3411
用于停止容器的信号,可以是字符串或无符号整数。
StopTimeout?
可选
StopTimeout:number
定义于: packages/extension-api/src/extension-api.d.ts:3418
默认值: 10
停止容器的超时时间(秒)。
Tty?
可选
Tty:boolean
定义于: packages/extension-api/src/extension-api.d.ts:3322
将标准流附加到 TTY,包括 stdin(如果未关闭)(默认 false)。
User?
可选
User:string
定义于: packages/extension-api/src/extension-api.d.ts:3286
在容器内运行命令的用户。
Volumes?
可选
Volumes:object
定义于: packages/extension-api/src/extension-api.d.ts:3386
映射容器内挂载点路径到空对象的对象。
索引签名
[volume
: string
]: object
WorkingDir?
可选
WorkingDir:string
定义于: packages/extension-api/src/extension-api.d.ts:3391
命令要运行的工作目录。