Skip to content

Commit 121cd6f

Browse files
thaJeztahthaJeztah
committed
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 <[email protected]> (cherry picked from commit 36a25bd) Signed-off-by: Sebastiaan van Stijn <[email protected]>
1 parent d4288a3 commit 121cd6f

3 files changed

Lines changed: 13 additions & 13 deletions

File tree

‎docs/reference/api/docker_remote_api.md‎

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

‎docs/reference/api/docker_remote_api_v1.24.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -299,8 +299,8 @@ Create a container
299299
"CpuQuota": 50000,
300300
"CpusetCpus": "0,1",
301301
"CpusetMems": "0,1",
302-
"MaximumIOps": 0,
303-
"MaximumIOBps": 0,
302+
"IOMaximumBandwidth": 0,
303+
"IOMaximumIOps": 0,
304304
"BlkioWeight": 300,
305305
"BlkioWeightDevice": [{}],
306306
"BlkioDeviceReadBps": [{}],
@@ -416,8 +416,8 @@ Create a container
416416
- **CpuQuota** - Microseconds of CPU time that the container can get in a CPU period.
417417
- **CpusetCpus** - String value containing the `cgroups CpusetCpus` to use.
418418
- **CpusetMems** - Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems.
419-
- **MaximumIOps** - Maximum IO absolute rate in terms of IOps.
420-
- **MaximumIOBps** - Maximum IO absolute rate in terms of bytes per second.
419+
- **IOMaximumBandwidth** - Maximum IO absolute rate in terms of IOps.
420+
- **IOMaximumIOps** - Maximum IO absolute rate in terms of bytes per second.
421421
- **BlkioWeight** - Block IO weight (relative weight) accepts a weight value between 10 and 1000.
422422
- **BlkioWeightDevice** - Block IO weight (relative device weight) in the form of: `"BlkioWeightDevice": [{"Path": "device_path", "Weight": weight}]`
423423
- **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`
565565
"ExecIDs": null,
566566
"HostConfig": {
567567
"Binds": null,
568-
"MaximumIOps": 0,
569-
"MaximumIOBps": 0,
568+
"IOMaximumBandwidth": 0,
569+
"IOMaximumIOps": 0,
570570
"BlkioWeight": 0,
571571
"BlkioWeightDevice": [{}],
572572
"BlkioDeviceReadBps": [{}],

‎docs/reference/api/docker_remote_api_v1.25.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -300,8 +300,8 @@ Create a container
300300
"CpuQuota": 50000,
301301
"CpusetCpus": "0,1",
302302
"CpusetMems": "0,1",
303-
"MaximumIOps": 0,
304-
"MaximumIOBps": 0,
303+
"IOMaximumBandwidth": 0,
304+
"IOMaximumIOps": 0,
305305
"BlkioWeight": 300,
306306
"BlkioWeightDevice": [{}],
307307
"BlkioDeviceReadBps": [{}],
@@ -420,8 +420,8 @@ Create a container
420420
- **CpuQuota** - Microseconds of CPU time that the container can get in a CPU period.
421421
- **CpusetCpus** - String value containing the `cgroups CpusetCpus` to use.
422422
- **CpusetMems** - Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems.
423-
- **MaximumIOps** - Maximum IO absolute rate in terms of IOps.
424-
- **MaximumIOBps** - Maximum IO absolute rate in terms of bytes per second.
423+
- **IOMaximumBandwidth** - Maximum IO absolute rate in terms of IOps.
424+
- **IOMaximumIOps** - Maximum IO absolute rate in terms of bytes per second.
425425
- **BlkioWeight** - Block IO weight (relative weight) accepts a weight value between 10 and 1000.
426426
- **BlkioWeightDevice** - Block IO weight (relative device weight) in the form of: `"BlkioWeightDevice": [{"Path": "device_path", "Weight": weight}]`
427427
- **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`
571571
"ExecIDs": null,
572572
"HostConfig": {
573573
"Binds": null,
574-
"MaximumIOps": 0,
575-
"MaximumIOBps": 0,
574+
"IOMaximumBandwidth": 0,
575+
"IOMaximumIOps": 0,
576576
"BlkioWeight": 0,
577577
"BlkioWeightDevice": [{}],
578578
"BlkioDeviceReadBps": [{}],

0 commit comments

Comments
 (0)