Interface: ContainerCreateOptions
Properties
ArgsEscaped?
optional
ArgsEscaped:boolean
Default: false
Command is already escaped (Windows only)
Defined in
packages/extension-api/src/extension-api.d.ts:2996
AttachStderr?
optional
AttachStderr:boolean
Whether to attach to stderr
(default false)
Defined in
packages/extension-api/src/extension-api.d.ts:2964
AttachStdin?
optional
AttachStdin:boolean
Whether to attach to stdin
(default false)
Defined in
packages/extension-api/src/extension-api.d.ts:2954
AttachStdout?
optional
AttachStdout:boolean
Whether to attach to stdout
(default false)
Defined in
packages/extension-api/src/extension-api.d.ts:2959
Cmd?
optional
Cmd:string
[]
Command to run specified as an array of strings
Defined in
packages/extension-api/src/extension-api.d.ts:2942
Detach?
optional
Detach:boolean
Run the container in the background
Defined in
packages/extension-api/src/extension-api.d.ts:2979
Domainname?
optional
Domainname:string
The domain name to use for the container.
Defined in
packages/extension-api/src/extension-api.d.ts:2896
Entrypoint?
optional
Entrypoint:string
|string
[]
The entry point for the container as a string or an array of strings.
If the array consists of exactly one empty string ([""]
) then the entry point is reset to system default (i.e., the entry point used by docker when there is no ENTRYPOINT instruction in the Containerfile).
Defined in
packages/extension-api/src/extension-api.d.ts:2949
Env?
optional
Env:string
[]
A list of environment variables to set inside the container in the form ["VAR=value", ...]
. A variable without =
is removed from the environment, rather than to have an empty value
Defined in
packages/extension-api/src/extension-api.d.ts:2906
EnvFiles?
optional
EnvFiles:string
[]
Environment files to use
Defined in
packages/extension-api/src/extension-api.d.ts:2911
ExposedPorts?
optional
ExposedPorts:object
An object mapping ports to an empty object in the form: {"<port>/<tcp|udp|sctp>": {}}
Index Signature
[port
: string
]: object
Defined in
packages/extension-api/src/extension-api.d.ts:2922
HealthCheck?
optional
HealthCheck:HealthConfig
A test to perform to check that the container is healthy. See HealthConfig for usage details
Defined in
packages/extension-api/src/extension-api.d.ts:2989
HostConfig?
optional
HostConfig:HostConfig
Container configuration that depends on the host we are running on
Defined in
packages/extension-api/src/extension-api.d.ts:2927
Hostname?
optional
Hostname:string
The hostname to use for the container, as a valid RFC 1123 hostname
Defined in
packages/extension-api/src/extension-api.d.ts:2891
Image?
optional
Image:string
The name (or reference) of the image to use when creating the container
Defined in
packages/extension-api/src/extension-api.d.ts:2932
Labels?
optional
Labels:object
User-defined key/value metadata
Index Signature
[label
: string
]: string
Defined in
packages/extension-api/src/extension-api.d.ts:2916
MacAddress?
optional
MacAddress:string
MAC address of the container.
Defined in
packages/extension-api/src/extension-api.d.ts:3016
NetworkConfig?
optional
NetworkConfig:NetworkingConfig
Defined in
packages/extension-api/src/extension-api.d.ts:3040
NetworkDisabled?
optional
NetworkDisabled:boolean
Disable networking for the container.
Defined in
packages/extension-api/src/extension-api.d.ts:3011
OnBuild?
optional
OnBuild:string
[]
ONBUILD
metadata that were defined in the image's Dockerfile
.
Defined in
packages/extension-api/src/extension-api.d.ts:3021
OpenStdin?
optional
OpenStdin:boolean
Whether to open stdin
(default false)
Defined in
packages/extension-api/src/extension-api.d.ts:2969
Shell?
optional
Shell:string
[]
Shell for when RUN
, CMD
, and ENTRYPOINT
uses a shell.
Defined in
packages/extension-api/src/extension-api.d.ts:3038
StdinOnce?
optional
StdinOnce:boolean
Close stdin
after one attached client disconnects (deafult false)
Defined in
packages/extension-api/src/extension-api.d.ts:2974
StopSignal?
optional
StopSignal:string
Signal to stop a container as a string or unsigned integer.
Defined in
packages/extension-api/src/extension-api.d.ts:3026
StopTimeout?
optional
StopTimeout:number
Default: 10
Timeout to stop a container in seconds.
Defined in
packages/extension-api/src/extension-api.d.ts:3033
Tty?
optional
Tty:boolean
Attach standard streams to a TTY, including stdin if it is not closed (default false)
Defined in
packages/extension-api/src/extension-api.d.ts:2937
User?
optional
User:string
The user that commands are run as inside the container
Defined in
packages/extension-api/src/extension-api.d.ts:2901
Volumes?
optional
Volumes:object
An object mapping mount point paths inside the container to empty objects.
Index Signature
[volume
: string
]: object
Defined in
packages/extension-api/src/extension-api.d.ts:3001
WorkingDir?
optional
WorkingDir:string
The working directory for commands to run in.
Defined in
packages/extension-api/src/extension-api.d.ts:3006
name?
optional
name:string
Assign the specified name to the container. Must match the regular expression/?[a-zA-Z0-9][a-zA-Z0-9_.-]+
. If not speficied, the platform assigns a unique name to the container
Defined in
packages/extension-api/src/extension-api.d.ts:2869
platform?
optional
platform:string
Default: ""
Platform in the format os[/arch[/variant]]
used for image lookup.
When specified, the daemon checks if the requested image is present in the local image cache with the given OS and Architecture, and otherwise returns a 404
status.
If the option is not set, the host's native OS and Architecture are used to look up the image in the image cache. However, if no platform is passed and the given image does exist in the local image cache, but its OS or architecture does not match, the container is created with the available image, and a warning is added to the Warnings
field in the response, for example;
WARNING: The requested image's platform (linux/arm64/v8) does not
match the detected host platform (linux/amd64) and no
specific platform was requested
Defined in
packages/extension-api/src/extension-api.d.ts:2886
pod?
optional
pod:string
Pod where to create the container in
Defined in
packages/extension-api/src/extension-api.d.ts:3045
start?
optional
start:boolean
Start the container immediately (default true)