Skip to content

Commit dbcad70

Browse files
zulinx86Manciukic
authored andcommitted
docs(jailer): Reorder cgroup-related parameters
Since the behavior of --parent-cgroup depends on whether --cgroup is provided or not and wether --cgroup-version is 1 or 2, explain the dependencies first and then --parent-cgroup. Signed-off-by: Takahiro Itazuri <[email protected]>
1 parent 48f9844 commit dbcad70

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

docs/jailer.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ jailer --id <id> \
1818
--exec-file <exec_file> \
1919
--uid <uid> \
2020
--gid <gid> \
21-
[--parent-cgroup <parent_cgroup>] \
2221
[--cgroup-version <cgroup_version>] \
2322
[--cgroup <cgroup>] \
23+
[--parent-cgroup <parent_cgroup>] \
2424
[--chroot-base-dir <chroot_base>] \
2525
[--netns <netns>] \
2626
[--resource-limit <resource=value>] \
@@ -38,19 +38,6 @@ jailer --id <id> \
3838
specific.
3939
- `--uid` and `--gid` specify the uid and gid the jailer switches to as it execs
4040
the target binary.
41-
- `--parent-cgroup` is used to allow the placement of microvm cgroups in custom
42-
nested hierarchies. By specifying this parameter, the jailer will create a new
43-
cgroup named `<id>` for the microvm in the `<cgroup_base>/<parent_cgroup>`
44-
subfolder. `<cgroup_base>` is the cgroup controller root for `cgroup v1` (e.g.
45-
`/sys/fs/cgroup/cpu`) or the unified controller hierarchy for `cgroup v2`
46-
(e.g. `/sys/fs/cgroup/unified`). `<parent_cgroup>` is a relative path within
47-
that hierarchy. For example, if `--parent-cgroup all_uvms/external_uvms` is
48-
specified, the jailer will write all cgroup parameters specified through
49-
`--cgroup` in `/sys/fs/cgroup/<controller_name>/all_uvms/external_uvms/<id>`.
50-
By default, the parent cgroup is the filename of `<exec_file>`, which will be
51-
henceforth referred to as `<exec_file_name>`. If there are no `--cgroup`
52-
parameters specified and `--group-version=2` was passed, then the jailer will
53-
move the process to the specified cgroup.
5441
- `--cgroup-version` is used to select which type of cgroup hierarchy to use for
5542
the creation of cgroups. The default value is "1" which means that cgroups
5643
specified with `--cgroup` will be created within a v1 hierarchy. Supported
@@ -64,6 +51,19 @@ jailer --id <id> \
6451
Firecracker process cgroups before the VM starts running, with no need to
6552
create the entire cgroup hierarchy manually (which requires privileged
6653
permissions).
54+
- `--parent-cgroup` is used to allow the placement of microvm cgroups in custom
55+
nested hierarchies. By specifying this parameter, the jailer will create a new
56+
cgroup named `<id>` for the microvm in the `<cgroup_base>/<parent_cgroup>`
57+
subfolder. `<cgroup_base>` is the cgroup controller root for `cgroup v1` (e.g.
58+
`/sys/fs/cgroup/cpu`) or the unified controller hierarchy for `cgroup v2`
59+
(e.g. `/sys/fs/cgroup/unified`). `<parent_cgroup>` is a relative path within
60+
that hierarchy. For example, if `--parent-cgroup all_uvms/external_uvms` is
61+
specified, the jailer will write all cgroup parameters specified through
62+
`--cgroup` in `/sys/fs/cgroup/<controller_name>/all_uvms/external_uvms/<id>`.
63+
By default, the parent cgroup is the filename of `<exec_file>`, which will be
64+
henceforth referred to as `<exec_file_name>`. If there are no `--cgroup`
65+
parameters specified and `--group-version=2` was passed, then the jailer will
66+
move the process to the specified cgroup.
6767
- `--chroot-base-dir` specifies the base folder where chroot jails are built.
6868
The default is `/srv/jailer`.
6969
- `--netns` specifies the path to a network namespace handle. If present, the

0 commit comments

Comments
 (0)