Skip to main content
Version: current

container


container

Package: container
Type: Directory

FlagNameDescription
Sstopped
Nstarting
Rrunning
Tstopping
Edownloading/extracting
Ddeleting
Fdownload/extract failed
Cstarting-with-healthcheck
Hhealthy
Uunhealthy
ArgumentTypeDescription
filefile { }
remote-imagestring
check-certificatebool
namestring
interface ( mandatory )multi { iface_enum }
envobject { super { ! , composite { , } { , } } { ! , composite { , } { , } } }
envlistsmulti { enum }
entrypointmulti { string }
cmdmulti { string }
shellmulti { string }
stop-signalenum (1-SIGHUP | 2-SIGINT | 3-SIGQUIT | 4-SIGILL | 5-SIGTRAP | 6-SIGABTR | 7-SIGBUS | 8-SIGFPE | 9-SIGKILL | 10-SIGUSR1 | 11-SIGSEGV | 12-SIGUSR2 | 13-SIGPIPE | 14-SIGALRM | 15-SIGTERM | 16-SIGSTKFLT | 17-SIGCHLD | 18-SIGCONT | 19-SIGSTOP | 20-SIGTSTP | 21-SIGTTIN | 22-SIGTTOU | 23-SIGURG | 24-SIGXCPU | 25-SIGXFSZ | 26-SIGVTALRM | 27-SIGPROF | 28-SIGWINCH | 29-SIGIO | 30-SIGPWR | 31-SIGSYS)
stop-timetime
root-dirfile
layer-dirfile
mountobject { composite { , } { , } }
tmpfsobject { composite { , } { , } }
mountlistsmulti { enum }
shm-sizenum
dnsmulti { address (flags=46) }
default-dnsmulti { address (flags=46) }
hostnamestring
domain-namestring
workdirstring
loggingbool
start-on-bootbool
stop-on-unhealthybool
restart-policyenum (no | on-failure | always)
restart-max-countnum
restart-intervaltime
userstring
cpu-listmulti { enum }
memory-highnum
memory-maxnum
devicesobject { composite { , } { , } }
hostsobject { composite { , } { , } }
healthcheck-cmdmulti { string }
healthcheck-intervaltime
healthcheck-timeouttime
healthcheck-start-periodtime
healthcheck-start-intervaltime
healthcheck-retriesnum
healthcheck-statusstring
Read-only ArgumentTypeDescription
tagstring
osstring
archstring
env-currentobject { composite { , } { , } }
default-entrypointstring
default-cmdstring
default-shellstring
default-stop-signalenum (1-SIGHUP | 2-SIGINT | 3-SIGQUIT | 4-SIGILL | 5-SIGTRAP | 6-SIGABTR | 7-SIGBUS | 8-SIGFPE | 9-SIGKILL | 10-SIGUSR1 | 11-SIGSEGV | 12-SIGUSR2 | 13-SIGPIPE | 14-SIGALRM | 15-SIGTERM | 16-SIGSTKFLT | 17-SIGCHLD | 18-SIGCONT | 19-SIGSTOP | 20-SIGTSTP | 21-SIGTTIN | 22-SIGTTOU | 23-SIGURG | 24-SIGXCPU | 25-SIGXFSZ | 26-SIGVTALRM | 27-SIGPROF | 28-SIGWINCH | 29-SIGIO | 30-SIGPWR | 31-SIGSYS)
default-workdirstring
restart-countnum
default-userstring
memory-currentnum
cpu-usagenum
container-sizenum
data-sizenum
image-idstring
config-jsonstring
layersmulti { enum }
default-healthcheck-cmdmulti { string }
default-healthcheck-intervaltime
default-healthcheck-timeouttime
default-healthcheck-start-periodtime
default-healthcheck-start-intervaltime
default-healthcheck-retriesnum

container/config

Package: container
Type: Settings Directory

ArgumentTypeDescription
registry-urlstring
usernamestring
passwordstring
layer-dirfile
tmpdirfile
memory-highnum
memory-maxnum
Read-only ArgumentTypeDescription
assumed-registry-urlstring
memory-currentnum

container/envs

Package: container
Type: Directory

FlagNameDescription
Xdisabled
ArgumentTypeDescription
list ( mandatory )enum
key ( mandatory )string
value ( mandatory )string

container/kill

Package: container
Type: Command

ArgumentTypeDescription
signalenum (1-SIGHUP | 2-SIGINT | 3-SIGQUIT | 4-SIGILL | 5-SIGTRAP | 6-SIGABTR | 7-SIGBUS | 8-SIGFPE | 9-SIGKILL | 10-SIGUSR1 | 11-SIGSEGV | 12-SIGUSR2 | 13-SIGPIPE | 14-SIGALRM | 15-SIGTERM | 16-SIGSTKFLT | 17-SIGCHLD | 18-SIGCONT | 19-SIGSTOP | 20-SIGTSTP | 21-SIGTTIN | 22-SIGTTOU | 23-SIGURG | 24-SIGXCPU | 25-SIGXFSZ | 26-SIGVTALRM | 27-SIGPROF | 28-SIGWINCH | 29-SIGIO | 30-SIGPWR | 31-SIGSYS)

container/layers

Package: container
Type: Directory

Read-only ArgumentTypeDescription
namestring
layer-dirstring
sizealt { num , enum (unavailable | pending | done) { unavailable:container::LAYER_SIZE_STATE_NONE, pending:container::LAYER_SIZE_STATE_PENDING, done:container::LAYER_SIZE_STATE_DONE } }
typeenum (layer | root-dir)
containersmulti { enum }

container/log

Package: container
Type: Directory

Read-only ArgumentTypeDescription
timedate
containerenum
messagestring

container/mounts

Package: container
Type: Directory

FlagNameDescription
Xdisabled
ArgumentTypeDescription
list ( mandatory )enum
srcfile
dst ( mandatory )string
modeenum (rw | ro | rw,noexec | ro,noexec)

container/repull

Package: container
Type: Command

ArgumentTypeDescription
filefile { }
remote-imagestring

container/restart

Package: container
Type: Command

container/start

Package: container
Type: Command

container/stop

Package: container
Type: Command

container/update

Package: container
Type: Command