> **Deprecated**:This field is deprecated as the kernel 5.4 deprecated
> `kmem.limit_in_bytes`.
type:"integer"
type:"integer"
format:"int64"
format:"int64"
example:209715200
example:209715200
@ -625,6 +631,27 @@ definitions:
type:"integer"
type:"integer"
format:"int64"
format:"int64"
Limit:
description:|
An object describing a limit on resources which can be requested by a task.
type:"object"
properties:
NanoCPUs:
type:"integer"
format:"int64"
example:4000000000
MemoryBytes:
type:"integer"
format:"int64"
example:8272408576
Pids:
description:|
Limits the maximum number of PIDs in the container. Set `0` for unlimited.
type:"integer"
format:"int64"
default:0
example:100
ResourceObject:
ResourceObject:
description:|
description:|
An object describing the resources which can be advertised by a node and
An object describing the resources which can be advertised by a node and
@ -885,15 +912,6 @@ definitions:
$ref:"#/definitions/Mount"
$ref:"#/definitions/Mount"
# Applicable to UNIX platforms
# Applicable to UNIX platforms
Capabilities:
type:"array"
description:|
A list of kernel capabilities to be available for container (this
overrides the default set).
Conflicts with options 'CapAdd' and 'CapDrop'"
items:
type:"string"
CapAdd:
CapAdd:
type:"array"
type:"array"
description:|
description:|
@ -1215,6 +1233,42 @@ definitions:
items:
items:
type:"string"
type:"string"
NetworkingConfig:
description:|
NetworkingConfig represents the container's networking configuration for
each of its interfaces.
It is used for the networking configs specified in the `docker create`
and `docker network connect` commands.
type:"object"
properties:
EndpointsConfig:
description:|
A mapping of network name to endpoint configuration for that network.
type:"object"
additionalProperties:
$ref:"#/definitions/EndpointSettings"
example:
# putting an example here, instead of using the example values from
# /definitions/EndpointSettings, because containers/create currently
# does not support attaching to multiple networks, so the example request
# would be confusing if it showed that multiple networks can be contained
# in the EndpointsConfig.
# TODO remove once we support multiple networks on container create (see https://github.com/moby/moby/blob/07e6b843594e061f82baa5fa23c2ff7d536c2a05/daemon/create.go#L323)
EndpointsConfig:
isolated_nw:
IPAMConfig:
IPv4Address:"172.20.30.33"
IPv6Address:"2001:db8:abcd::3033"
LinkLocalIPs:
- "169.254.34.68"
- "fe80::3468"
Links:
- "container_1"
- "container_2"
Aliases:
- "server_x"
- "server_y"
NetworkSettings:
NetworkSettings:
description:"NetworkSettings exposes the network settings in the API"
description:"NetworkSettings exposes the network settings in the API"
type:"object"
type:"object"
@ -1851,12 +1905,24 @@ definitions:
Shared:
Shared:
type:"boolean"
type:"boolean"
Size:
Size:
description:|
Amount of disk space used by the build cache (in bytes).
type:"integer"
type:"integer"
CreatedAt:
CreatedAt:
type:"integer"
description:|
Date and time at which the build cache was created in
[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.
type:"string"
format:"dateTime"
example:"2016-08-18T10:44:24.496525531Z"
LastUsedAt:
LastUsedAt:
type:"integer"
description:|
Date and time at which the build cache was last used in
[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.
type:"string"
format:"dateTime"
x-nullable:true
x-nullable:true
example:"2017-08-09T07:09:37.632105588Z"
UsageCount:
UsageCount:
type:"integer"
type:"integer"
@ -3206,13 +3272,6 @@ definitions:
configured on the daemon) is used.
configured on the daemon) is used.
type:"boolean"
type:"boolean"
x-nullable:true
x-nullable:true
PidsLimit:
description:|
Tune a container's PIDs limit. Set `0` for unlimited.
type:"integer"
format:"int64"
default:0
example:100
Sysctls:
Sysctls:
description:|
description:|
Set kernel namedspaced parameters (sysctls) in the container.
Set kernel namedspaced parameters (sysctls) in the container.
@ -3226,11 +3285,11 @@ definitions:
additionalProperties:
additionalProperties:
type:"string"
type:"string"
# This option is not used by Windows containers
# This option is not used by Windows containers
Capabilities:
CapabilityAdd:
type:"array"
type:"array"
description:|
description:|
A list of kernel capabilities to be available for container (this
A list of kernel capabilities to add to the default set
overrides the default set).
for the container.
items:
items:
type:"string"
type:"string"
example:
example:
@ -3238,6 +3297,31 @@ definitions:
- "CAP_SYS_ADMIN"
- "CAP_SYS_ADMIN"
- "CAP_SYS_CHROOT"
- "CAP_SYS_CHROOT"
- "CAP_SYSLOG"
- "CAP_SYSLOG"
CapabilityDrop:
type:"array"
description:|
A list of kernel capabilities to drop from the default set
for the container.
items:
type:"string"
example:
- "CAP_NET_RAW"
Ulimits:
description:|
A list of resource limits to set in the container. For example:`{"Name": "nofile", "Soft": 1024, "Hard": 2048}`"
type:"array"
items:
type:"object"
properties:
Name:
description:"Name of ulimit"
type:"string"
Soft:
description:"Soft limit"
type:"integer"
Hard:
description:"Hard limit"
type:"integer"
NetworkAttachmentSpec:
NetworkAttachmentSpec:
description:|
description:|
Read-only spec type for non-swarm containers attached to swarm overlay
Read-only spec type for non-swarm containers attached to swarm overlay
@ -3262,7 +3346,7 @@ definitions:
properties:
properties:
Limits:
Limits:
description:"Define resources limits."
description:"Define resources limits."
$ref:"#/definitions/ResourceObject"
$ref:"#/definitions/Limit"
Reservation:
Reservation:
description:"Define resources reservation."
description:"Define resources reservation."
$ref:"#/definitions/ResourceObject"
$ref:"#/definitions/ResourceObject"
@ -4186,6 +4270,103 @@ definitions:
x-nullable:true
x-nullable:true
$ref:"#/definitions/Health"
$ref:"#/definitions/Health"
SystemVersion:
type:"object"
description:|
Response of Engine API:GET "/version"
properties:
Platform:
type:"object"
required:[Name]
properties:
Name:
type:"string"
Components:
type:"array"
description:|
Information about system components
items:
type:"object"
x-go-name:ComponentVersion
required:[Name, Version]
properties:
Name:
description:|
Name of the component
type:"string"
example:"Engine"
Version:
description:|
Version of the component
type:"string"
x-nullable:false
example:"19.03.12"
Details:
description:|
Key/value pairs of strings with additional information about the
component. These values are intended for informational purposes
only, and their content is not defined, and not part of the API
specification.
These messages can be printed by the client as information to the user.
type:"object"
x-nullable:true
Version:
description:"The version of the daemon"
type:"string"
example:"19.03.12"
ApiVersion:
description:|
The default (and highest) API version that is supported by the daemon
type:"string"
example:"1.40"
MinAPIVersion:
description:|
The minimum API version that is supported by the daemon
type:"string"
example:"1.12"
GitCommit:
description:|
The Git commit of the source code that was used to build the daemon
type:"string"
example:"48a66213fe"
GoVersion:
description:|
The version Go used to compile the daemon, and the version of the Go
runtime in use.
type:"string"
example:"go1.13.14"
Os:
description:|
The operating system that the daemon is running on ("linux" or "windows")
type:"string"
example:"linux"
Arch:
description:|
The architecture that the daemon is running on
type:"string"
example:"amd64"
KernelVersion:
description:|
The kernel version (`uname -r`) that the daemon is running on.
This field is omitted when empty.
type:"string"
example:"4.19.76-linuxkit"
Experimental:
description:|
Indicates if the daemon is started with experimental features enabled.
This field is omitted when empty / false.
type:"boolean"
example:true
BuildTime:
description:|
The date and time that the daemon was compiled.
type:"string"
example:"2020-06-22T15:49:27.000000000+00:00"
SystemInfo:
SystemInfo:
type:"object"
type:"object"
properties:
properties:
@ -4271,7 +4452,13 @@ definitions:
type:"boolean"
type:"boolean"
example:true
example:true
KernelMemory:
KernelMemory:
description:"Indicates if the host has kernel memory limit support enabled."
description:|
Indicates if the host has kernel memory limit support enabled.
<p><br /></p>
> **Deprecated**:This field is deprecated as the kernel 5.4 deprecated
> `kmem.limit_in_bytes`.
type:"boolean"
type:"boolean"
example:true
example:true
CpuCfsPeriod:
CpuCfsPeriod:
@ -4419,7 +4606,7 @@ definitions:
example:4
example:4
MemTotal:
MemTotal:
description:|
description:|
Total amount of physical memory available on the host, in kilobytes (kB).
Total amount of physical memory available on the host, in bytes.
type:"integer"
type:"integer"
format:"int64"
format:"int64"
example:2095882240
example:2095882240
@ -4626,6 +4813,25 @@ definitions:
such as number of nodes, and expiration are included.
such as number of nodes, and expiration are included.
type:"string"
type:"string"
example:"Community Engine"
example:"Community Engine"
DefaultAddressPools:
description:|
List of custom default address pools for local networks, which can be
specified in the daemon.json file or dockerd option.
Example:a Base "10.10.0.0/16" with Size 24 will define the set of 256
10.10.[0-255].0/24 address pools.
type:"array"
items:
type:"object"
properties:
Base:
description:"The network address in CIDR format"
type:"string"
example:"10.10.0.0/16"
Size:
description:"The network pool size"
type:"integer"
example:"24"
Warnings:
Warnings:
description:|
description:|
List of warnings / informational messages about missing features, or
List of warnings / informational messages about missing features, or
iwilltry42
4 years ago