Documentation

TaskSpecContainerSpec

Table of Contents

$args  : array<string|int, string>|null
Arguments to the command.
$command  : array<string|int, string>|null
The command to be run in the image.
$configs  : array<string|int, TaskSpecContainerSpecConfigsItem>|null
Configs contains references to zero or more configs that will be.
$dir  : string|null
The working directory for commands to run in.
$dNSConfig  : TaskSpecContainerSpecDNSConfig|null
Specification for DNS related configurations in resolver configuration.
$env  : array<string|int, string>|null
A list of environment variables in the form `VAR=value`.
$groups  : array<string|int, string>|null
A list of additional groups that the container process will run as.
$healthCheck  : HealthConfig|null
A test to perform to check that the container is healthy.
$hostname  : string|null
The hostname to use for the container, as a valid.
$hosts  : array<string|int, string>|null
A list of hostname/IP mappings to add to the container's `hosts`.
$image  : string|null
The image name to use for the container.
$init  : bool|null
Run an init inside the container that forwards signals and reaps.
$isolation  : string|null
Isolation technology of the containers running the service.
$labels  : array<string|int, string>|null
User-defined key/value data.
$mounts  : array<string|int, Mount>|null
Specification for mounts to be added to containers created as part.
$openStdin  : bool|null
Open `stdin`.
$privileges  : TaskSpecContainerSpecPrivileges|null
Security options for the container.
$readOnly  : bool|null
Mount the container's root filesystem as read only.
$secrets  : array<string|int, TaskSpecContainerSpecSecretsItem>|null
Secrets contains references to zero or more secrets that will be.
$stopGracePeriod  : int|null
Amount of time to wait for the container to terminate before.
$stopSignal  : string|null
Signal to stop the container.
$sysctls  : array<string|int, string>|null
Set kernel namedspaced parameters (sysctls) in the container.
$tTY  : bool|null
Whether a pseudo-TTY should be allocated.
$user  : string|null
The user inside the container.
getArgs()  : array<string|int, string>|null
Arguments to the command.
getCommand()  : array<string|int, string>|null
The command to be run in the image.
getConfigs()  : array<string|int, TaskSpecContainerSpecConfigsItem>|null
Configs contains references to zero or more configs that will be.
getDir()  : string|null
The working directory for commands to run in.
getDNSConfig()  : TaskSpecContainerSpecDNSConfig|null
Specification for DNS related configurations in resolver configuration.
getEnv()  : array<string|int, string>|null
A list of environment variables in the form `VAR=value`.
getGroups()  : array<string|int, string>|null
A list of additional groups that the container process will run as.
getHealthCheck()  : HealthConfig|null
A test to perform to check that the container is healthy.
getHostname()  : string|null
The hostname to use for the container, as a valid.
getHosts()  : array<string|int, string>|null
A list of hostname/IP mappings to add to the container's `hosts`.
getImage()  : string|null
The image name to use for the container.
getInit()  : bool|null
Run an init inside the container that forwards signals and reaps.
getIsolation()  : string|null
Isolation technology of the containers running the service.
getLabels()  : array<string|int, string>|null
User-defined key/value data.
getMounts()  : array<string|int, Mount>|null
Specification for mounts to be added to containers created as part.
getOpenStdin()  : bool|null
Open `stdin`.
getPrivileges()  : TaskSpecContainerSpecPrivileges|null
Security options for the container.
getReadOnly()  : bool|null
Mount the container's root filesystem as read only.
getSecrets()  : array<string|int, TaskSpecContainerSpecSecretsItem>|null
Secrets contains references to zero or more secrets that will be.
getStopGracePeriod()  : int|null
Amount of time to wait for the container to terminate before.
getStopSignal()  : string|null
Signal to stop the container.
getSysctls()  : array<string|int, string>|null
Set kernel namedspaced parameters (sysctls) in the container.
getTTY()  : bool|null
Whether a pseudo-TTY should be allocated.
getUser()  : string|null
The user inside the container.
setArgs()  : self
Arguments to the command.
setCommand()  : self
The command to be run in the image.
setConfigs()  : self
Configs contains references to zero or more configs that will be.
setDir()  : self
The working directory for commands to run in.
setDNSConfig()  : self
Specification for DNS related configurations in resolver configuration.
setEnv()  : self
A list of environment variables in the form `VAR=value`.
setGroups()  : self
A list of additional groups that the container process will run as.
setHealthCheck()  : self
A test to perform to check that the container is healthy.
setHostname()  : self
The hostname to use for the container, as a valid.
setHosts()  : self
A list of hostname/IP mappings to add to the container's `hosts`.
setImage()  : self
The image name to use for the container.
setInit()  : self
Run an init inside the container that forwards signals and reaps.
setIsolation()  : self
Isolation technology of the containers running the service.
setLabels()  : self
User-defined key/value data.
setMounts()  : self
Specification for mounts to be added to containers created as part.
setOpenStdin()  : self
Open `stdin`.
setPrivileges()  : self
Security options for the container.
setReadOnly()  : self
Mount the container's root filesystem as read only.
setSecrets()  : self
Secrets contains references to zero or more secrets that will be.
setStopGracePeriod()  : self
Amount of time to wait for the container to terminate before.
setStopSignal()  : self
Signal to stop the container.
setSysctls()  : self
Set kernel namedspaced parameters (sysctls) in the container.
setTTY()  : self
Whether a pseudo-TTY should be allocated.
setUser()  : self
The user inside the container.

Properties

$command

The command to be run in the image.

protected array<string|int, string>|null $command

$env

A list of environment variables in the form `VAR=value`.

protected array<string|int, string>|null $env

$groups

A list of additional groups that the container process will run as.

protected array<string|int, string>|null $groups

$hostname

The hostname to use for the container, as a valid.

protected string|null $hostname

$hosts

A list of hostname/IP mappings to add to the container's `hosts`.

protected array<string|int, string>|null $hosts

$init

Run an init inside the container that forwards signals and reaps.

protected bool|null $init

$isolation

Isolation technology of the containers running the service.

protected string|null $isolation

$mounts

Specification for mounts to be added to containers created as part.

protected array<string|int, Mount>|null $mounts

$stopGracePeriod

Amount of time to wait for the container to terminate before.

protected int|null $stopGracePeriod

$sysctls

Set kernel namedspaced parameters (sysctls) in the container.

protected array<string|int, string>|null $sysctls

Methods

getArgs()

Arguments to the command.

public getArgs() : array<string|int, string>|null
Return values
array<string|int, string>|null —

getCommand()

The command to be run in the image.

public getCommand() : array<string|int, string>|null
Return values
array<string|int, string>|null —

getDir()

The working directory for commands to run in.

public getDir() : string|null
Return values
string|null —

getEnv()

A list of environment variables in the form `VAR=value`.

public getEnv() : array<string|int, string>|null
Return values
array<string|int, string>|null —

getGroups()

A list of additional groups that the container process will run as.

public getGroups() : array<string|int, string>|null
Return values
array<string|int, string>|null —

getHostname()

The hostname to use for the container, as a valid.

public getHostname() : string|null

RFC 1123 hostname.

Return values
string|null —

getHosts()

A list of hostname/IP mappings to add to the container's `hosts`.

public getHosts() : array<string|int, string>|null
Return values
array<string|int, string>|null —

getImage()

The image name to use for the container.

public getImage() : string|null
Return values
string|null —

getInit()

Run an init inside the container that forwards signals and reaps.

public getInit() : bool|null

configured on the daemon) is used.

Return values
bool|null —

getIsolation()

Isolation technology of the containers running the service.

public getIsolation() : string|null

(Windows only)

Return values
string|null —

getLabels()

User-defined key/value data.

public getLabels() : array<string|int, string>|null
Return values
array<string|int, string>|null —

getMounts()

Specification for mounts to be added to containers created as part.

public getMounts() : array<string|int, Mount>|null
Return values
array<string|int, Mount>|null —

getReadOnly()

Mount the container's root filesystem as read only.

public getReadOnly() : bool|null
Return values
bool|null —

getStopGracePeriod()

Amount of time to wait for the container to terminate before.

public getStopGracePeriod() : int|null

forcefully killing it.

Return values
int|null —

getStopSignal()

Signal to stop the container.

public getStopSignal() : string|null
Return values
string|null —

getSysctls()

Set kernel namedspaced parameters (sysctls) in the container.

public getSysctls() : array<string|int, string>|null
Return values
array<string|int, string>|null —

getTTY()

Whether a pseudo-TTY should be allocated.

public getTTY() : bool|null
Return values
bool|null —

getUser()

The user inside the container.

public getUser() : string|null
Return values
string|null —

setArgs()

Arguments to the command.

public setArgs(array<string|int, string>|null $args) : self
Parameters
$args : array<string|int, string>|null
Return values
self —

setCommand()

The command to be run in the image.

public setCommand(array<string|int, string>|null $command) : self
Parameters
$command : array<string|int, string>|null
Return values
self —

setDir()

The working directory for commands to run in.

public setDir(string|null $dir) : self
Parameters
$dir : string|null
Return values
self —

setEnv()

A list of environment variables in the form `VAR=value`.

public setEnv(array<string|int, string>|null $env) : self
Parameters
$env : array<string|int, string>|null
Return values
self —

setGroups()

A list of additional groups that the container process will run as.

public setGroups(array<string|int, string>|null $groups) : self
Parameters
$groups : array<string|int, string>|null
Return values
self —

setHostname()

The hostname to use for the container, as a valid.

public setHostname(string|null $hostname) : self

RFC 1123 hostname.

Parameters
$hostname : string|null
Return values
self —

setHosts()

A list of hostname/IP mappings to add to the container's `hosts`.

public setHosts(array<string|int, string>|null $hosts) : self
Parameters
$hosts : array<string|int, string>|null
Return values
self —

setImage()

The image name to use for the container.

public setImage(string|null $image) : self
Parameters
$image : string|null
Return values
self —

setInit()

Run an init inside the container that forwards signals and reaps.

public setInit(bool|null $init) : self

configured on the daemon) is used.

Parameters
$init : bool|null
Return values
self —

setIsolation()

Isolation technology of the containers running the service.

public setIsolation(string|null $isolation) : self

(Windows only)

Parameters
$isolation : string|null
Return values
self —

setLabels()

User-defined key/value data.

public setLabels(array<string|int, string>|null $labels) : self
Parameters
$labels : array<string|int, string>|null
Return values
self —

setMounts()

Specification for mounts to be added to containers created as part.

public setMounts(array<string|int, Mount>|null $mounts) : self
Parameters
$mounts : array<string|int, Mount>|null
Return values
self —

setOpenStdin()

Open `stdin`.

public setOpenStdin(bool|null $openStdin) : self
Parameters
$openStdin : bool|null
Return values
self —

setReadOnly()

Mount the container's root filesystem as read only.

public setReadOnly(bool|null $readOnly) : self
Parameters
$readOnly : bool|null
Return values
self —

setStopGracePeriod()

Amount of time to wait for the container to terminate before.

public setStopGracePeriod(int|null $stopGracePeriod) : self

forcefully killing it.

Parameters
$stopGracePeriod : int|null
Return values
self —

setStopSignal()

Signal to stop the container.

public setStopSignal(string|null $stopSignal) : self
Parameters
$stopSignal : string|null
Return values
self —

setSysctls()

Set kernel namedspaced parameters (sysctls) in the container.

public setSysctls(array<string|int, string>|null $sysctls) : self
Parameters
$sysctls : array<string|int, string>|null
Return values
self —

setTTY()

Whether a pseudo-TTY should be allocated.

public setTTY(bool|null $tTY) : self
Parameters
$tTY : bool|null
Return values
self —

setUser()

The user inside the container.

public setUser(string|null $user) : self
Parameters
$user : string|null
Return values
self —

Search results