docker
/
docs
mirror of https://github.com/docker/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix incorrectly named API options 

This renames `MaximumIOps` to `IOMaximumBandwidth`,
and `MaximumIOBps` to `IOMaximumIOps` to match
the actual code.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit 36a25bdbe4d973aef308fa11b450264dae1bc0b4)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This commit is contained in:
Sebastiaan van Stijn 2016-09-20 13:51:55 +02:00
parent d4288a3212
commit 121cd6f9e6
No known key found for this signature in database
GPG Key ID: 76698F39D527CE8C
3 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/reference/api/docker_remote_api.md
View File

@ -121,7 +121,7 @@ This section lists each version from latest to oldest. Each listing includes a
with ContainerD in Docker 1.11. with ContainerD in Docker 1.11.
* `GET /networks` now supports filtering by `label` and `driver`. * `GET /networks` now supports filtering by `label` and `driver`.
* `GET /containers/json` now supports filtering containers by `network` name or id. * `GET /containers/json` now supports filtering containers by `network` name or id.
* `POST /containers/create` now takes `MaximumIOps` and `MaximumIOBps` fields. Windows daemon only. * `POST /containers/create` now takes `IOMaximumBandwidth` and `IOMaximumIOps` fields. Windows daemon only.
* `POST /containers/create` now returns an HTTP 400 "bad parameter" message * `POST /containers/create` now returns an HTTP 400 "bad parameter" message
if no command is specified (instead of an HTTP 500 "server error") if no command is specified (instead of an HTTP 500 "server error")
* `GET /images/search` now takes a `filters` query parameter. * `GET /images/search` now takes a `filters` query parameter.

12
docs/reference/api/docker_remote_api_v1.24.md
View File

@ -299,8 +299,8 @@ Create a container
"CpuQuota": 50000, "CpuQuota": 50000,
"CpusetCpus": "0,1", "CpusetCpus": "0,1",
"CpusetMems": "0,1", "CpusetMems": "0,1",
"MaximumIOps": 0, "IOMaximumBandwidth": 0,
"MaximumIOBps": 0, "IOMaximumIOps": 0,
"BlkioWeight": 300, "BlkioWeight": 300,
"BlkioWeightDevice": [{}], "BlkioWeightDevice": [{}],
"BlkioDeviceReadBps": [{}], "BlkioDeviceReadBps": [{}],
@ -416,8 +416,8 @@ Create a container
- **CpuQuota** - Microseconds of CPU time that the container can get in a CPU period. - **CpuQuota** - Microseconds of CPU time that the container can get in a CPU period.
- **CpusetCpus** - String value containing the `cgroups CpusetCpus` to use. - **CpusetCpus** - String value containing the `cgroups CpusetCpus` to use.
- **CpusetMems** - Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems. - **CpusetMems** - Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems.
- **MaximumIOps** - Maximum IO absolute rate in terms of IOps. - **IOMaximumBandwidth** - Maximum IO absolute rate in terms of IOps.
- **MaximumIOBps** - Maximum IO absolute rate in terms of bytes per second. - **IOMaximumIOps** - Maximum IO absolute rate in terms of bytes per second.
- **BlkioWeight** - Block IO weight (relative weight) accepts a weight value between 10 and 1000. - **BlkioWeight** - Block IO weight (relative weight) accepts a weight value between 10 and 1000.
- **BlkioWeightDevice** - Block IO weight (relative device weight) in the form of: `"BlkioWeightDevice": [{"Path": "device_path", "Weight": weight}]` - **BlkioWeightDevice** - Block IO weight (relative device weight) in the form of: `"BlkioWeightDevice": [{"Path": "device_path", "Weight": weight}]`
- **BlkioDeviceReadBps** - Limit read rate (bytes per second) from a device in the form of: `"BlkioDeviceReadBps": [{"Path": "device_path", "Rate": rate}]`, for example: - **BlkioDeviceReadBps** - Limit read rate (bytes per second) from a device in the form of: `"BlkioDeviceReadBps": [{"Path": "device_path", "Rate": rate}]`, for example:
@ -565,8 +565,8 @@ Return low-level information on the container `id`
"ExecIDs": null, "ExecIDs": null,
"HostConfig": { "HostConfig": {
"Binds": null, "Binds": null,
"MaximumIOps": 0, "IOMaximumBandwidth": 0,
"MaximumIOBps": 0, "IOMaximumIOps": 0,
"BlkioWeight": 0, "BlkioWeight": 0,
"BlkioWeightDevice": [{}], "BlkioWeightDevice": [{}],
"BlkioDeviceReadBps": [{}], "BlkioDeviceReadBps": [{}],

12
docs/reference/api/docker_remote_api_v1.25.md
View File

@ -300,8 +300,8 @@ Create a container
"CpuQuota": 50000, "CpuQuota": 50000,
"CpusetCpus": "0,1", "CpusetCpus": "0,1",
"CpusetMems": "0,1", "CpusetMems": "0,1",
"MaximumIOps": 0, "IOMaximumBandwidth": 0,
"MaximumIOBps": 0, "IOMaximumIOps": 0,
"BlkioWeight": 300, "BlkioWeight": 300,
"BlkioWeightDevice": [{}], "BlkioWeightDevice": [{}],
"BlkioDeviceReadBps": [{}], "BlkioDeviceReadBps": [{}],
@ -420,8 +420,8 @@ Create a container
- **CpuQuota** - Microseconds of CPU time that the container can get in a CPU period. - **CpuQuota** - Microseconds of CPU time that the container can get in a CPU period.
- **CpusetCpus** - String value containing the `cgroups CpusetCpus` to use. - **CpusetCpus** - String value containing the `cgroups CpusetCpus` to use.
- **CpusetMems** - Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems. - **CpusetMems** - Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems.
- **MaximumIOps** - Maximum IO absolute rate in terms of IOps. - **IOMaximumBandwidth** - Maximum IO absolute rate in terms of IOps.
- **MaximumIOBps** - Maximum IO absolute rate in terms of bytes per second. - **IOMaximumIOps** - Maximum IO absolute rate in terms of bytes per second.
- **BlkioWeight** - Block IO weight (relative weight) accepts a weight value between 10 and 1000. - **BlkioWeight** - Block IO weight (relative weight) accepts a weight value between 10 and 1000.
- **BlkioWeightDevice** - Block IO weight (relative device weight) in the form of: `"BlkioWeightDevice": [{"Path": "device_path", "Weight": weight}]` - **BlkioWeightDevice** - Block IO weight (relative device weight) in the form of: `"BlkioWeightDevice": [{"Path": "device_path", "Weight": weight}]`
- **BlkioDeviceReadBps** - Limit read rate (bytes per second) from a device in the form of: `"BlkioDeviceReadBps": [{"Path": "device_path", "Rate": rate}]`, for example: - **BlkioDeviceReadBps** - Limit read rate (bytes per second) from a device in the form of: `"BlkioDeviceReadBps": [{"Path": "device_path", "Rate": rate}]`, for example:
@ -571,8 +571,8 @@ Return low-level information on the container `id`
"ExecIDs": null, "ExecIDs": null,
"HostConfig": { "HostConfig": {
"Binds": null, "Binds": null,
"MaximumIOps": 0, "IOMaximumBandwidth": 0,
"MaximumIOBps": 0, "IOMaximumIOps": 0,
"BlkioWeight": 0, "BlkioWeight": 0,
"BlkioWeightDevice": [{}], "BlkioWeightDevice": [{}],
"BlkioDeviceReadBps": [{}], "BlkioDeviceReadBps": [{}],