container
Package: container
Type: Directory
| Flag | Name | Description |
|---|
| S | stopped | |
| N | starting | |
| R | running | |
| T | stopping | |
| E | downloading/extracting | |
| D | deleting | |
| F | download/extract failed | |
| C | starting-with-healthcheck | |
| H | healthy | |
| U | unhealthy | |
| Argument | Type | Description |
|---|
| file | file { } | |
| remote-image | string | |
| check-certificate | bool | |
| name | string | |
| interface ( mandatory ) | multi { iface_enum
} | |
| env | object { super { !
, composite { , } { , }
} { !
, composite { , } { , }
}
} | |
| envlists | multi { enum
} | |
| entrypoint | multi { string
} | |
| cmd | multi { string
} | |
| shell | multi { string
} | |
| stop-signal | enum (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-time | time | |
| root-dir | file | |
| layer-dir | file | |
| mount | object { composite { , } { , }
} | |
| tmpfs | object { composite { , } { , }
} | |
| mountlists | multi { enum
} | |
| shm-size | num | |
| dns | multi { address (flags=46)
} | |
| default-dns | multi { address (flags=46)
} | |
| hostname | string | |
| domain-name | string | |
| workdir | string | |
| logging | bool | |
| start-on-boot | bool | |
| stop-on-unhealthy | bool | |
| restart-policy | enum (no | on-failure | always) | |
| restart-max-count | num | |
| restart-interval | time | |
| user | string | |
| cpu-list | multi { enum
} | |
| memory-high | num | |
| memory-max | num | |
| devices | object { composite { , } { , }
} | |
| hosts | object { composite { , } { , }
} | |
| healthcheck-cmd | multi { string
} | |
| healthcheck-interval | time | |
| healthcheck-timeout | time | |
| healthcheck-start-period | time | |
| healthcheck-start-interval | time | |
| healthcheck-retries | num | |
| healthcheck-status | string | |
| Read-only Argument | Type | Description |
|---|
| tag | string | |
| os | string | |
| arch | string | |
| env-current | object { composite { , } { , }
} | |
| default-entrypoint | string | |
| default-cmd | string | |
| default-shell | string | |
| default-stop-signal | enum (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-workdir | string | |
| restart-count | num | |
| default-user | string | |
| memory-current | num | |
| cpu-usage | num | |
| container-size | num | |
| data-size | num | |
| image-id | string | |
| config-json | string | |
| layers | multi { enum
} | |
| default-healthcheck-cmd | multi { string
} | |
| default-healthcheck-interval | time | |
| default-healthcheck-timeout | time | |
| default-healthcheck-start-period | time | |
| default-healthcheck-start-interval | time | |
| default-healthcheck-retries | num | |
container/config
Package: container
Type: Settings Directory
| Argument | Type | Description |
|---|
| registry-url | string | |
| username | string | |
| password | string | |
| layer-dir | file | |
| tmpdir | file | |
| memory-high | num | |
| memory-max | num | |
| Read-only Argument | Type | Description |
|---|
| assumed-registry-url | string | |
| memory-current | num | |
container/envs
Package: container
Type: Directory
| Flag | Name | Description |
|---|
| X | disabled | |
| Argument | Type | Description |
|---|
| list ( mandatory ) | enum | |
| key ( mandatory ) | string | |
| value ( mandatory ) | string | |
container/kill
Package: container
Type: Command
| Argument | Type | Description |
|---|
| signal | enum (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 Argument | Type | Description |
|---|
| name | string | |
| layer-dir | string | |
| size | alt { num
, enum (unavailable | pending | done) { unavailable:container::LAYER_SIZE_STATE_NONE, pending:container::LAYER_SIZE_STATE_PENDING, done:container::LAYER_SIZE_STATE_DONE }
} | |
| type | enum (layer | root-dir) | |
| containers | multi { enum
} | |
container/log
Package: container
Type: Directory
| Read-only Argument | Type | Description |
|---|
| time | date | |
| container | enum | |
| message | string | |
container/mounts
Package: container
Type: Directory
| Flag | Name | Description |
|---|
| X | disabled | |
| Argument | Type | Description |
|---|
| list ( mandatory ) | enum | |
| src | file | |
| dst ( mandatory ) | string | |
| mode | enum (rw | ro | rw,noexec | ro,noexec) | |
container/repull
Package: container
Type: Command
| Argument | Type | Description |
|---|
| file | file { } | |
| remote-image | string | |
container/restart
Package: container
Type: Command
container/start
Package: container
Type: Command
container/stop
Package: container
Type: Command
container/update
Package: container
Type: Command