Skip to content

Commit aa995f7

Browse files
author
Ma Shimiao
committed
config-linux.md: add cgroupsPath entry and smome modifications
Signed-off-by: Ma Shimiao <[email protected]>
1 parent 559acdf commit aa995f7

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

config-linux.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -171,14 +171,15 @@ Also known as cgroups, they are used to restrict resource usage for a container
171171
cgroups provide controls (through controllers) to restrict cpu, memory, IO, pids and network for the container.
172172
For more information, see the [kernel cgroups documentation][cgroup-v1].
173173

174-
The path to the cgroups can be specified in the Spec via `cgroupsPath`.
175-
`cgroupsPath` can be used to either control the cgroup hierarchy for containers or to run a new process in an existing container.
176-
If `cgroupsPath` is:
177-
* ... an absolute path (starting with `/`), the runtime MUST take the path to be relative to the cgroup mount point.
178-
* ... a relative path (not starting with `/`), the runtime MAY interpret the path relative to a runtime-determined location in the cgroup hierarchy.
179-
* ... not specified, the runtime MAY define the default cgroup path.
174+
#### <a name="configLinuxCgroupsPath" />Cgroups Path
175+
176+
**`cgroupsPath`** (string, OPTIONAL) path to the cgroups. It can be used to either control the cgroups hierarchy for containers or to run a new process in an existing container.The value of `cgroupsPath` is either an absolute path or a relative path.
177+
* an absolute path (starting with `/`), the runtime MUST take the path to be relative to the cgroups mount point.
178+
* a relative path (not starting with `/`), the runtime MAY interpret the path relative to a runtime-determined location in the cgroups hierarchy.
179+
180+
If the value is specified, the runtime MUST consistently attach to the same place in the cgroup hierarchy given the same value of `cgroupsPath`.
181+
If the value is not specified, the runtime MAY define the default cgroups path.
180182
Runtimes MAY consider certain `cgroupsPath` values to be invalid, and MUST generate an error if this is the case.
181-
If a `cgroupsPath` value is specified, the runtime MUST consistently attach to the same place in the cgroup hierarchy given the same value of `cgroupsPath`.
182183

183184
Implementations of the Spec can choose to name cgroups in any manner.
184185
The Spec does not include naming schema for cgroups.

0 commit comments

Comments
 (0)