Skip to main content

Interface: ContainerCreateOptions

Properties​

ArgsEscaped?​

optional ArgsEscaped: boolean

Default: false

Command is already escaped (Windows only)

Source​

packages/extension-api/src/extension-api.d.ts:2690

AttachStderr?​

optional AttachStderr: boolean

Whether to attach to stderr (default false)

Source​

packages/extension-api/src/extension-api.d.ts:2658

AttachStdin?​

optional AttachStdin: boolean

Whether to attach to stdin (default false)

Source​

packages/extension-api/src/extension-api.d.ts:2648

AttachStdout?​

optional AttachStdout: boolean

Whether to attach to stdout(default false)

Source​

packages/extension-api/src/extension-api.d.ts:2653

Cmd?​

optional Cmd: string[]

Command to run specified as an array of strings

Source​

packages/extension-api/src/extension-api.d.ts:2636

Detach?​

optional Detach: boolean

Run the container in the background

Source​

packages/extension-api/src/extension-api.d.ts:2673

Domainname?​

optional Domainname: string

The domain name to use for the container.

Source​

packages/extension-api/src/extension-api.d.ts:2590

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).

Source​

packages/extension-api/src/extension-api.d.ts:2643

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

Source​

packages/extension-api/src/extension-api.d.ts:2600

EnvFiles?​

optional EnvFiles: string[]

Environment files to use

Source​

packages/extension-api/src/extension-api.d.ts:2605

ExposedPorts?​

optional ExposedPorts: object

An object mapping ports to an empty object in the form: {"<port>/<tcp|udp|sctp>": {}}

Index signature​

[port: string]: object

Source​

packages/extension-api/src/extension-api.d.ts:2616

HealthCheck?​

optional HealthCheck: HealthConfig

A test to perform to check that the container is healthy. See HealthConfig for usage details

Source​

packages/extension-api/src/extension-api.d.ts:2683

HostConfig?​

optional HostConfig: HostConfig

Container configuration that depends on the host we are running on

Source​

packages/extension-api/src/extension-api.d.ts:2621

Hostname?​

optional Hostname: string

The hostname to use for the container, as a valid RFC 1123 hostname

Source​

packages/extension-api/src/extension-api.d.ts:2585

Image?​

optional Image: string

The name (or reference) of the image to use when creating the container

Source​

packages/extension-api/src/extension-api.d.ts:2626

Labels?​

optional Labels: object

User-defined key/value metadata

Index signature​

[label: string]: string

Source​

packages/extension-api/src/extension-api.d.ts:2610

MacAddress?​

optional MacAddress: string

MAC address of the container.

Source​

packages/extension-api/src/extension-api.d.ts:2710

NetworkConfig?​

optional NetworkConfig: NetworkingConfig

Source​

packages/extension-api/src/extension-api.d.ts:2734

NetworkDisabled?​

optional NetworkDisabled: boolean

Disable networking for the container.

Source​

packages/extension-api/src/extension-api.d.ts:2705

OnBuild?​

optional OnBuild: string[]

ONBUILD metadata that were defined in the image's Dockerfile.

Source​

packages/extension-api/src/extension-api.d.ts:2715

OpenStdin?​

optional OpenStdin: boolean

Whether to open stdin (default false)

Source​

packages/extension-api/src/extension-api.d.ts:2663

Shell?​

optional Shell: string[]

Shell for when RUN, CMD, and ENTRYPOINT uses a shell.

Source​

packages/extension-api/src/extension-api.d.ts:2732

StdinOnce?​

optional StdinOnce: boolean

Close stdin after one attached client disconnects (deafult false)

Source​

packages/extension-api/src/extension-api.d.ts:2668

StopSignal?​

optional StopSignal: string

Signal to stop a container as a string or unsigned integer.

Source​

packages/extension-api/src/extension-api.d.ts:2720

StopTimeout?​

optional StopTimeout: number

Default: 10

Timeout to stop a container in seconds.

Source​

packages/extension-api/src/extension-api.d.ts:2727

Tty?​

optional Tty: boolean

Attach standard streams to a TTY, including stdin if it is not closed (default false)

Source​

packages/extension-api/src/extension-api.d.ts:2631

User?​

optional User: string

The user that commands are run as inside the container

Source​

packages/extension-api/src/extension-api.d.ts:2595

Volumes?​

optional Volumes: object

An object mapping mount point paths inside the container to empty objects.

Index signature​

[volume: string]: object

Source​

packages/extension-api/src/extension-api.d.ts:2695

WorkingDir?​

optional WorkingDir: string

The working directory for commands to run in.

Source​

packages/extension-api/src/extension-api.d.ts:2700

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

Source​

packages/extension-api/src/extension-api.d.ts:2563

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

Source​

packages/extension-api/src/extension-api.d.ts:2580

pod?​

optional pod: string

Pod where to create the container in

Source​

packages/extension-api/src/extension-api.d.ts:2739

start?​

optional start: boolean

Start the container immediately (default true)

Source​

packages/extension-api/src/extension-api.d.ts:2678