1. docker
  2. Commit 36a25bdbe4d973aef308fa11b450264dae1bc0b4
Browse code

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>

Sebastiaan van Stijn authored on 2016/09/20 20:51:55
Showing 3 changed files
docs/reference/api/docker_remote_api.md
History View file @ 36a25bd
... ... 
@@ -134,7 +134,7 @@ This section lists each version from latest to oldest.  Each listing includes a
134 134 
   with ContainerD in Docker 1.11.
135 135 
 * `GET /networks` now supports filtering by `label` and `driver`.
136 136 
 * `GET /containers/json` now supports filtering containers by `network` name or id.
137 
-* `POST /containers/create` now takes `MaximumIOps` and `MaximumIOBps` fields. Windows daemon only.
137 
+* `POST /containers/create` now takes `IOMaximumBandwidth` and `IOMaximumIOps` fields. Windows daemon only.
138 138 
 * `POST /containers/create` now returns an HTTP 400 "bad parameter" message
139 139 
   if no command is specified (instead of an HTTP 500 "server error")
140 140 
 * `GET /images/search` now takes a `filters` query parameter.
docs/reference/api/docker_remote_api_v1.24.md
History View file @ 36a25bd
... ... 
@@ -299,8 +299,8 @@ Create a container
299 299 
              "CpuQuota": 50000,
300 300 
              "CpusetCpus": "0,1",
301 301 
              "CpusetMems": "0,1",
302 
-             "MaximumIOps": 0,
303 
-             "MaximumIOBps": 0,
302 
+             "IOMaximumBandwidth": 0,
303 
+             "IOMaximumIOps": 0,
304 304 
              "BlkioWeight": 300,
305 305 
              "BlkioWeightDevice": [{}],
306 306 
              "BlkioDeviceReadBps": [{}],
... ... 
@@ -409,8 +409,8 @@ Create a container
409 409 
     -   **CpuQuota** - Microseconds of CPU time that the container can get in a CPU period.
410 410 
     -   **CpusetCpus** - String value containing the `cgroups CpusetCpus` to use.
411 411 
     -   **CpusetMems** - Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems.
412 
-    -   **MaximumIOps** - Maximum IO absolute rate in terms of IOps.
413 
-    -   **MaximumIOBps** - Maximum IO absolute rate in terms of bytes per second.
412 
+    -   **IOMaximumBandwidth** - Maximum IO absolute rate in terms of IOps.
413 
+    -   **IOMaximumIOps** - Maximum IO absolute rate in terms of bytes per second.
414 414 
     -   **BlkioWeight** - Block IO weight (relative weight) accepts a weight value between 10 and 1000.
415 415 
     -   **BlkioWeightDevice** - Block IO weight (relative device weight) in the form of:        `"BlkioWeightDevice": [{"Path": "device_path", "Weight": weight}]`
416 416 
     -   **BlkioDeviceReadBps** - Limit read rate (bytes per second) from a device in the form of:	`"BlkioDeviceReadBps": [{"Path": "device_path", "Rate": rate}]`, for example:
... ... 
@@ -558,8 +558,8 @@ Return low-level information on the container `id`
558 558 
 		"ExecIDs": null,
559 559 
 		"HostConfig": {
560 560 
 			"Binds": null,
561 
-			"MaximumIOps": 0,
562 
-			"MaximumIOBps": 0,
561 
+			"IOMaximumBandwidth": 0,
562 
+			"IOMaximumIOps": 0,
563 563 
 			"BlkioWeight": 0,
564 564 
 			"BlkioWeightDevice": [{}],
565 565 
 			"BlkioDeviceReadBps": [{}],
docs/reference/api/docker_remote_api_v1.25.md
History View file @ 36a25bd
... ... 
@@ -299,8 +299,8 @@ Create a container
299 299 
              "CpuQuota": 50000,
300 300 
              "CpusetCpus": "0,1",
301 301 
              "CpusetMems": "0,1",
302 
-             "MaximumIOps": 0,
303 
-             "MaximumIOBps": 0,
302 
+             "IOMaximumBandwidth": 0,
303 
+             "IOMaximumIOps": 0,
304 304 
              "BlkioWeight": 300,
305 305 
              "BlkioWeightDevice": [{}],
306 306 
              "BlkioDeviceReadBps": [{}],
... ... 
@@ -413,8 +413,8 @@ Create a container
413 413 
     -   **CpuQuota** - Microseconds of CPU time that the container can get in a CPU period.
414 414 
     -   **CpusetCpus** - String value containing the `cgroups CpusetCpus` to use.
415 415 
     -   **CpusetMems** - Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems.
416 
-    -   **MaximumIOps** - Maximum IO absolute rate in terms of IOps.
417 
-    -   **MaximumIOBps** - Maximum IO absolute rate in terms of bytes per second.
416 
+    -   **IOMaximumBandwidth** - Maximum IO absolute rate in terms of IOps.
417 
+    -   **IOMaximumIOps** - Maximum IO absolute rate in terms of bytes per second.
418 418 
     -   **BlkioWeight** - Block IO weight (relative weight) accepts a weight value between 10 and 1000.
419 419 
     -   **BlkioWeightDevice** - Block IO weight (relative device weight) in the form of:        `"BlkioWeightDevice": [{"Path": "device_path", "Weight": weight}]`
420 420 
     -   **BlkioDeviceReadBps** - Limit read rate (bytes per second) from a device in the form of:	`"BlkioDeviceReadBps": [{"Path": "device_path", "Rate": rate}]`, for example:
... ... 
@@ -582,8 +582,8 @@ Return low-level information on the container `id`
582 582 
 		"ExecIDs": null,
583 583 
 		"HostConfig": {
584 584 
 			"Binds": null,
585 
-			"MaximumIOps": 0,
586 
-			"MaximumIOBps": 0,
585 
+			"IOMaximumBandwidth": 0,
586 
+			"IOMaximumIOps": 0,
587 587 
 			"BlkioWeight": 0,
588 588 
 			"BlkioWeightDevice": [{}],
589 589 
 			"BlkioDeviceReadBps": [{}],