Skip to content

Commit

Permalink
doc: document jailer caveat when using --parent-cgroup
Browse files Browse the repository at this point in the history
Document the issue in firecracker-microvm#4287 so customers are aware of it.

We will continue working on providing a resolution for it.

Signed-off-by: Pablo Barbáchano <pablob@amazon.com>
  • Loading branch information
pb8o committed Dec 4, 2023
1 parent a6f32d4 commit 9e24d4c
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 0 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@

## [Unreleased]

### Added

- [#4287](https://github.com/firecracker-microvm/firecracker/issues/4287)
Document a caveat to the jailer docs when using the `--parent-cgroup` option,
which results in it being ignored by the jailer. Refer to the [jailer
documentation](./docs/jailer.md#caveats) for a workaround.

### Changed

- [#4191](https://github.com/firecracker-microvm/firecracker/pull/4191):
Expand Down
5 changes: 5 additions & 0 deletions docs/jailer.md
Original file line number Diff line number Diff line change
Expand Up @@ -286,3 +286,8 @@ Note: default value for `<api-sock>` is `/run/firecracker.socket`.
- If all the cgroup controllers are bunched up on a single mount point using
the "all" option, our current program logic will complain it cannot detect
individual controller mount points.
- [#4287](https://github.com/firecracker-microvm/firecracker/issues/4287) When
starting a jailer with `--parent-cgroup` specified but no cgroup flags
specified, then the rules in the parent cgroup folder are ignored. To
workaround, use a dummy cgroup parameter like `--cgroup=memory.max=max`.

0 comments on commit 9e24d4c

Please sign in to comment.