Skip to content

Commit 1b0056c

Browse files
committed
config-linux: Update links to cgroups documentation
With 34a9304a (Merge branch 'for-4.5' of git://git.kernel.org/pub/scm/linux/kernel/git/tj/cgroup, 2016-01-13, [1]), Linux restructured their cgroups documentation. This updated all of our Documentation/cgroups references to match the new layout, using reference-style links [2] which let us collect link label definitions at the bottom of the file. That makes the spec source easier to read (no distracting URLs in the middle of a sentence) and makes the URLs easier to update (only one place to check / fix). [1]: https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/commit/?id=34a9304a96d6351c2d35dcdc9293258378fc0bd8 [2]: http://daringfireball.net/projects/markdown/syntax#link Signed-off-by: W. Trevor King <[email protected]>
1 parent 608cb7b commit 1b0056c

File tree

1 file changed

+22
-14
lines changed

1 file changed

+22
-14
lines changed

config-linux.md

Lines changed: 22 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -164,14 +164,14 @@ In addition to any devices configured with this setting, the runtime MUST also s
164164

165165
Also known as cgroups, they are used to restrict resource usage for a container and handle device access.
166166
cgroups provide controls to restrict cpu, memory, IO, pids and network for the container.
167-
For more information, see the [kernel cgroups documentation](https://www.kernel.org/doc/Documentation/cgroups/cgroups.txt).
167+
For more information, see the [kernel cgroups documentation][cgroup-v1].
168168

169169
The path to the cgroups can be specified in the Spec via `cgroupsPath`.
170170
`cgroupsPath` is expected to be relative to the cgroups mount point.
171171
If `cgroupsPath` is not specified, implementations can define the default cgroup path.
172172
Implementations of the Spec can choose to name cgroups in any manner.
173173
The Spec does not include naming schema for cgroups.
174-
The Spec does not support [split hierarchy](https://www.kernel.org/doc/Documentation/cgroups/unified-hierarchy.txt).
174+
The Spec does not support [split hierarchy][cgroup-v2].
175175
The cgroups will be created if they don't exist.
176176

177177
###### Example
@@ -188,7 +188,7 @@ For example, to run a new process in an existing container without updating limi
188188

189189
#### Device whitelist
190190

191-
`devices` is an array of entries to control the [device whitelist][cgroups-devices].
191+
`devices` is an array of entries to control the [device whitelist][cgroup-v1-devices].
192192
The runtime MUST apply entries in the listed order.
193193

194194
The following parameters can be specified:
@@ -197,7 +197,7 @@ The following parameters can be specified:
197197
* **`type`** *(char, optional)* - type of device: `a` (all), `c` (char), or `b` (block).
198198
`null` or unset values mean "all", mapping to `a`.
199199
* **`major, minor`** *(int64, optional)* - [major, minor numbers][devices] for the device.
200-
`null` or unset values mean "all", mapping to [`*` in the filesystem API][cgroups-devices].
200+
`null` or unset values mean "all", mapping to [`*` in the filesystem API][cgroup-v1-devices].
201201
* **`access`** *(string, optional)* - cgroup permissions for device.
202202
A composition of `r` (read), `w` (write), and `m` (mknod).
203203

@@ -232,7 +232,7 @@ The following parameters can be specified:
232232
If enabled (`false`), tasks that attempt to consume more memory than they are allowed are immediately killed by the OOM killer.
233233
The OOM killer is enabled by default in every cgroup using the `memory` subsystem.
234234
To disable it, specify a value of `true`.
235-
For more information, see [the memory cgroup man page](https://www.kernel.org/doc/Documentation/cgroups/memory.txt).
235+
For more information, see [the memory cgroup man page][cgroup-v1-memory].
236236

237237
* **`disableOOMKiller`** *(bool, optional)* - enables or disables the OOM killer
238238

@@ -247,7 +247,7 @@ For more information, see [the memory cgroup man page](https://www.kernel.org/do
247247
`oomScoreAdj` sets heuristic regarding how the process is evaluated by the kernel during memory pressure.
248248
For more information, see [the proc filesystem documentation section 3.1](https://www.kernel.org/doc/Documentation/filesystems/proc.txt).
249249
This is a kernel/system level setting, where as `disableOOMKiller` is scoped for a memory cgroup.
250-
For more information on how these two settings work together, see [the memory cgroup documentation section 10. OOM Contol](https://www.kernel.org/doc/Documentation/cgroups/memory.txt).
250+
For more information on how these two settings work together, see [the memory cgroup documentation section 10. OOM Contol][cgroup-v1-memory].
251251

252252
* **`oomScoreAdj`** *(int, optional)* - adjust the oom-killer score
253253

@@ -260,7 +260,7 @@ For more information on how these two settings work together, see [the memory cg
260260
#### Memory
261261

262262
`memory` represents the cgroup subsystem `memory` and it's used to set limits on the container's memory usage.
263-
For more information, see [the memory cgroup man page](https://www.kernel.org/doc/Documentation/cgroups/memory.txt).
263+
For more information, see [the memory cgroup man page][cgroup-v1-memory].
264264

265265
The following parameters can be specified to setup the controller:
266266

@@ -292,7 +292,7 @@ The following parameters can be specified to setup the controller:
292292
#### CPU
293293

294294
`cpu` represents the cgroup subsystems `cpu` and `cpusets`.
295-
For more information, see [the cpusets cgroup man page](https://www.kernel.org/doc/Documentation/cgroups/cpusets.txt).
295+
For more information, see [the cpusets cgroup man page][cgroup-v1-cpusets].
296296

297297
The following parameters can be specified to setup the controller:
298298

@@ -327,7 +327,7 @@ The following parameters can be specified to setup the controller:
327327
#### Block IO Controller
328328

329329
`blockIO` represents the cgroup subsystem `blkio` which implements the block io controller.
330-
For more information, see [the kernel cgroups documentation about blkio](https://www.kernel.org/doc/Documentation/cgroups/blkio-controller.txt).
330+
For more information, see [the kernel cgroups documentation about blkio][cgroup-v1-blkio].
331331

332332
The following parameters can be specified to setup the controller:
333333

@@ -386,7 +386,7 @@ The following parameters can be specified to setup the controller:
386386

387387
`hugepageLimits` represents the `hugetlb` controller which allows to limit the
388388
HugeTLB usage per control group and enforces the controller limit during page fault.
389-
For more information, see the [kernel cgroups documentation about HugeTLB](https://www.kernel.org/doc/Documentation/cgroups/hugetlb.txt).
389+
For more information, see the [kernel cgroups documentation about HugeTLB][cgroup-v1-hugetlb].
390390

391391
`hugepageLimits` is an array of entries, each having the following structure:
392392

@@ -408,7 +408,7 @@ For more information, see the [kernel cgroups documentation about HugeTLB](https
408408
#### Network
409409

410410
`network` represents the cgroup subsystems `net_cls` and `net_prio`.
411-
For more information, see [the net\_cls cgroup man page](https://www.kernel.org/doc/Documentation/cgroups/net_cls.txt) and [the net\_prio cgroup man page](https://www.kernel.org/doc/Documentation/cgroups/net_prio.txt).
411+
For more information, see [the net\_cls cgroup man page][cgroup-v1-net-cls] and [the net\_prio cgroup man page][cgroup-v1-net-prio].
412412

413413
The following parameters can be specified to setup these cgroup controllers:
414414

@@ -440,8 +440,7 @@ processes in the group and egressing the system on various interfaces. The follo
440440
#### PIDs
441441

442442
`pids` represents the cgroup subsystem `pids`.
443-
For more information, see [the pids cgroup man page](https://www.kernel.org/doc/Documentation/cgroups/pids.txt
444-
).
443+
For more information, see [the pids cgroup man page][cgroup-v1-pids].
445444

446445
The following paramters can be specified to setup the controller:
447446

@@ -586,7 +585,16 @@ Setting `noNewPrivileges` to true prevents the processes in the container from g
586585
"noNewPrivileges": true,
587586
```
588587

589-
[cgroups-devices]: https://www.kernel.org/doc/Documentation/cgroup-v1/devices.txt
588+
[cgroup-v1]: https://www.kernel.org/doc/Documentation/cgroup-v1/cgroups.txt
589+
[cgroup-v1-blkio]: https://www.kernel.org/doc/Documentation/cgroup-v1/blkio-controller.txt
590+
[cgroup-v1-cpusets]: https://www.kernel.org/doc/Documentation/cgroup-v1/cpusets.txt
591+
[cgroup-v1-devices]: https://www.kernel.org/doc/Documentation/cgroup-v1/devices.txt
592+
[cgroup-v1-hugetlb]: https://www.kernel.org/doc/Documentation/cgroup-v1/hugetlb.txt
593+
[cgroup-v1-memory]: https://www.kernel.org/doc/Documentation/cgroup-v1/memory.txt
594+
[cgroup-v1-net-cls]: https://www.kernel.org/doc/Documentation/cgroup-v1/net_cls.txt
595+
[cgroup-v1-net-prio]: https://www.kernel.org/doc/Documentation/cgroup-v1/net_prio.txt
596+
[cgroup-v1-pids]: https://www.kernel.org/doc/Documentation/cgroup-v1/pids.txt
597+
[cgroup-v2]: https://www.kernel.org/doc/Documentation/cgroup-v2.txt
590598
[devices]: https://www.kernel.org/doc/Documentation/devices.txt
591599
[devpts]: https://www.kernel.org/doc/Documentation/filesystems/devpts.txt
592600

0 commit comments

Comments
 (0)