mirror of
https://github.com/moby/moby.git
synced 2022-11-09 12:21:53 -05:00
Improved "start a container" section in 1.16 & 1.17 docs
It seems it was lost or something Signed-off-by: Kirill Sibirev <l0kix2@gmail.com>
This commit is contained in:
Kirill SIbirev
Kirill Sibirev
parent
a3a45a6ec0
commit
ac12c80537
2 changed files with 111 additions and 0 deletions
|
|
@ -509,12 +509,66 @@ Start the container `id`
|
|||
POST /containers/(id)/start HTTP/1.1
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"Binds": ["/tmp:/tmp"],
|
||||
"Links": ["redis3:redis"],
|
||||
"LxcConf": {"lxc.utsname":"docker"},
|
||||
"PortBindings": { "22/tcp": [{ "HostPort": "11022" }] },
|
||||
"PublishAllPorts": false,
|
||||
"Privileged": false,
|
||||
"Dns": ["8.8.8.8"],
|
||||
"DnsSearch": [""],
|
||||
"VolumesFrom": ["parent", "other:ro"],
|
||||
"CapAdd": ["NET_ADMIN"],
|
||||
"CapDrop": ["MKNOD"],
|
||||
"RestartPolicy": { "Name": "", "MaximumRetryCount": 0 },
|
||||
"NetworkMode": "bridge",
|
||||
"Devices": []
|
||||
}
|
||||
|
||||
**Example response**:
|
||||
|
||||
HTTP/1.1 204 No Content
|
||||
|
||||
Json Parameters:
|
||||
|
||||
- **Binds** – A list of volume bindings for this container. Each volume
|
||||
binding is a string of the form `container_path` (to create a new
|
||||
volume for the container), `host_path:container_path` (to bind-mount
|
||||
a host path into the container), or `host_path:container_path:ro`
|
||||
(to make the bind-mount read-only inside the container).
|
||||
- **Links** - A list of links for the container. Each link entry should be of
|
||||
of the form "container_name:alias".
|
||||
- **LxcConf** - LXC specific configurations. These configurations will only
|
||||
work when using the `lxc` execution driver.
|
||||
- **PortBindings** - A map of exposed container ports and the host port they
|
||||
should map to. It should be specified in the form
|
||||
`{ <port>/<protocol>: [{ "HostPort": "<port>" }] }`
|
||||
Take note that `port` is specified as a string and not an integer value.
|
||||
- **PublishAllPorts** - Allocates a random host port for all of a container's
|
||||
exposed ports. Specified as a boolean value.
|
||||
- **Privileged** - Gives the container full access to the host. Specified as
|
||||
a boolean value.
|
||||
- **Dns** - A list of dns servers for the container to use.
|
||||
- **DnsSearch** - A list of DNS search domains
|
||||
- **VolumesFrom** - A list of volumes to inherit from another container.
|
||||
Specified in the form `<container name>[:<ro|rw>]`
|
||||
- **CapAdd** - A list of kernel capabilties to add to the container.
|
||||
- **Capdrop** - A list of kernel capabilties to drop from the container.
|
||||
- **RestartPolicy** – The behavior to apply when the container exits. The
|
||||
value is an object with a `Name` property of either `"always"` to
|
||||
always restart or `"on-failure"` to restart only when the container
|
||||
exit code is non-zero. If `on-failure` is used, `MaximumRetryCount`
|
||||
controls the number of times to retry before giving up.
|
||||
The default is not to restart. (optional)
|
||||
An ever increasing delay (double the previous delay, starting at 100mS)
|
||||
is added before each restart to prevent flooding the server.
|
||||
- **NetworkMode** - Sets the networking mode for the container. Supported
|
||||
values are: `bridge`, `host`, and `container:<name|id>`
|
||||
- **Devices** - A list of devices to add to the container specified in the
|
||||
form
|
||||
`{ "PathOnHost": "/dev/deviceName", "PathInContainer": "/dev/deviceName", "CgroupPermissions": "mrw"}`
|
||||
|
||||
Status Codes:
|
||||
|
||||
- **204** – no error
|
||||
|
|
|
|||
|
|
@ -639,12 +639,69 @@ Start the container `id`
|
|||
POST /containers/(id)/start HTTP/1.1
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"Binds": ["/tmp:/tmp"],
|
||||
"Links": ["redis3:redis"],
|
||||
"LxcConf": {"lxc.utsname":"docker"},
|
||||
"PortBindings": { "22/tcp": [{ "HostPort": "11022" }] },
|
||||
"PublishAllPorts": false,
|
||||
"Privileged": false,
|
||||
"ReadonlyRootfs": false,
|
||||
"Dns": ["8.8.8.8"],
|
||||
"DnsSearch": [""],
|
||||
"VolumesFrom": ["parent", "other:ro"],
|
||||
"CapAdd": ["NET_ADMIN"],
|
||||
"CapDrop": ["MKNOD"],
|
||||
"RestartPolicy": { "Name": "", "MaximumRetryCount": 0 },
|
||||
"NetworkMode": "bridge",
|
||||
"Devices": []
|
||||
}
|
||||
|
||||
**Example response**:
|
||||
|
||||
HTTP/1.1 204 No Content
|
||||
|
||||
Json Parameters:
|
||||
|
||||
- **Binds** – A list of volume bindings for this container. Each volume
|
||||
binding is a string of the form `container_path` (to create a new
|
||||
volume for the container), `host_path:container_path` (to bind-mount
|
||||
a host path into the container), or `host_path:container_path:ro`
|
||||
(to make the bind-mount read-only inside the container).
|
||||
- **Links** - A list of links for the container. Each link entry should be of
|
||||
of the form "container_name:alias".
|
||||
- **LxcConf** - LXC specific configurations. These configurations will only
|
||||
work when using the `lxc` execution driver.
|
||||
- **PortBindings** - A map of exposed container ports and the host port they
|
||||
should map to. It should be specified in the form
|
||||
`{ <port>/<protocol>: [{ "HostPort": "<port>" }] }`
|
||||
Take note that `port` is specified as a string and not an integer value.
|
||||
- **PublishAllPorts** - Allocates a random host port for all of a container's
|
||||
exposed ports. Specified as a boolean value.
|
||||
- **Privileged** - Gives the container full access to the host. Specified as
|
||||
a boolean value.
|
||||
- **ReadonlyRootfs** - Mount the container's root filesystem as read only.
|
||||
Specified as a boolean value.
|
||||
- **Dns** - A list of dns servers for the container to use.
|
||||
- **DnsSearch** - A list of DNS search domains
|
||||
- **VolumesFrom** - A list of volumes to inherit from another container.
|
||||
Specified in the form `<container name>[:<ro|rw>]`
|
||||
- **CapAdd** - A list of kernel capabilties to add to the container.
|
||||
- **Capdrop** - A list of kernel capabilties to drop from the container.
|
||||
- **RestartPolicy** – The behavior to apply when the container exits. The
|
||||
value is an object with a `Name` property of either `"always"` to
|
||||
always restart or `"on-failure"` to restart only when the container
|
||||
exit code is non-zero. If `on-failure` is used, `MaximumRetryCount`
|
||||
controls the number of times to retry before giving up.
|
||||
The default is not to restart. (optional)
|
||||
An ever increasing delay (double the previous delay, starting at 100mS)
|
||||
is added before each restart to prevent flooding the server.
|
||||
- **NetworkMode** - Sets the networking mode for the container. Supported
|
||||
values are: `bridge`, `host`, and `container:<name|id>`
|
||||
- **Devices** - A list of devices to add to the container specified in the
|
||||
form
|
||||
`{ "PathOnHost": "/dev/deviceName", "PathInContainer": "/dev/deviceName", "CgroupPermissions": "mrw"}`
|
||||
|
||||
Status Codes:
|
||||
|
||||
- **204** – no error
|
||||
|
|
|
|||
Loading…
Reference in a new issue