Skip to content

Commit de22669

Browse files
committed
docs: move sysctls docs to current API version
Signed-off-by: Alexander Morozov <[email protected]>
1 parent 1704914 commit de22669

3 files changed

Lines changed: 7 additions & 8 deletions

File tree

docs/reference/api/docker_remote_api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,7 @@ This section lists each version from latest to oldest. Each listing includes a
132132
* `GET /images/search` now supports maximum returned search results `limit`.
133133
* `POST /containers/{name:.*}/copy` is now removed and errors out starting from this API version.
134134
* API errors are now returned as JSON instead of plain text.
135+
* `POST /containers/create` and `POST /containers/(id)/start` allow you to configure kernel parameters (sysctls) for use in the container.
135136

136137
### v1.23 API changes
137138

@@ -192,7 +193,6 @@ This section lists each version from latest to oldest. Each listing includes a
192193

193194
[Docker Remote API v1.21](docker_remote_api_v1.21.md) documentation
194195

195-
* `POST /containers/create` and `POST /containers/(id)/start` allow you to configure kernel parameters (sysctls) for use in the container.
196196
* `GET /volumes` lists volumes from all volume drivers.
197197
* `POST /volumes/create` to create a volume.
198198
* `GET /volumes/(name)` get low-level information about a volume.

docs/reference/api/docker_remote_api_v1.21.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -306,10 +306,6 @@ Json Parameters:
306306
- **Devices** - A list of devices to add to the container specified as a JSON object in the
307307
form
308308
`{ "PathOnHost": "/dev/deviceName", "PathInContainer": "/dev/deviceName", "CgroupPermissions": "mrw"}`
309-
- **Sysctls** - A list of kernel parameters (sysctls) to set in the container, specified as
310-
`{ <name>: <Value> }`, for example:
311-
`{ "net.ipv4.ip_forward": "1" }`
312-
313309
- **Ulimits** - A list of ulimits to set in the container, specified as
314310
`{ "Name": <name>, "Soft": <soft limit>, "Hard": <hard limit> }`, for example:
315311
`Ulimits: { "Name": "nofile", "Soft": 1024, "Hard": 2048 }`
@@ -431,9 +427,6 @@ Return low-level information on the container `id`
431427
"Type": "json-file"
432428
},
433429
"SecurityOpt": null,
434-
"Sysctls": {
435-
"net.ipv4.ip_forward": "1"
436-
},
437430
"VolumesFrom": null,
438431
"Ulimits": [{}],
439432
"VolumeDriver": ""

docs/reference/api/docker_remote_api_v1.24.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -461,6 +461,9 @@ Create a container
461461
- **Ulimits** - A list of ulimits to set in the container, specified as
462462
`{ "Name": <name>, "Soft": <soft limit>, "Hard": <hard limit> }`, for example:
463463
`Ulimits: { "Name": "nofile", "Soft": 1024, "Hard": 2048 }`
464+
- **Sysctls** - A list of kernel parameters (sysctls) to set in the container, specified as
465+
`{ <name>: <Value> }`, for example:
466+
`{ "net.ipv4.ip_forward": "1" }`
464467
- **SecurityOpt**: A list of string values to customize labels for MLS
465468
systems, such as SELinux.
466469
- **StorageOpt**: Storage driver options per container. Options can be passed in the form
@@ -592,6 +595,9 @@ Return low-level information on the container `id`
592595
"Type": "json-file"
593596
},
594597
"SecurityOpt": null,
598+
"Sysctls": {
599+
"net.ipv4.ip_forward": "1"
600+
},
595601
"StorageOpt": null,
596602
"VolumesFrom": null,
597603
"Ulimits": [{}],

0 commit comments

Comments
 (0)