Skip to content

cgroup: do not create a sub-cgroup by default #1768

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

giuseppe
Copy link
Member

@giuseppe giuseppe commented May 29, 2025

The run.oci.systemd.subgroup annotation previously defaulted to creating a "container" sub-cgroup on cgroup v2 systems if the annotation was not specified. This change alters the behavior so that no sub-cgroup is created by default.

A sub-cgroup will only be created if the
run.oci.systemd.subgroup annotation is explicitly provided with a non-empty value.

Closes: #1766

Summary by Sourcery

Only create a systemd sub-cgroup when the run.oci.systemd.subgroup annotation is explicitly set, removing the previous default of “container” on cgroup v2.

Bug Fixes:

  • Address issue where a default sub-cgroup was created unexpectedly on cgroup v2.

Enhancements:

  • Remove automatic creation of a “container” sub-cgroup on cgroup v2 by returning NULL when the annotation is unset.
  • Update documentation and man pages to clarify that no sub-cgroup is created unless the SUBGROUP value is explicitly provided.

The `run.oci.systemd.subgroup` annotation previously defaulted
to creating a "container" sub-cgroup on cgroup v2 systems if
the annotation was not specified.  This change alters the
behavior so that no sub-cgroup is created by default.

A sub-cgroup will only be created if the
`run.oci.systemd.subgroup` annotation is explicitly provided
with a non-empty value.

Closes: containers#1766

Signed-off-by: Giuseppe Scrivano <[email protected]>
Copy link

sourcery-ai bot commented May 29, 2025

Reviewer's Guide

Change default behavior to no longer create a systemd sub-cgroup unless the run.oci.systemd.subgroup annotation is explicitly set, updating both code and documentation accordingly.

Class diagram for find_systemd_subgroup function change

classDiagram
    class find_systemd_subgroup {
        +string_map *annotations
        +returns: const char *
        - Old: returns "container" if annotation not set
        - New: returns NULL if annotation not set
    }
Loading

Flow diagram for systemd sub-cgroup creation logic

flowchart TD
    A[Container start] --> B{Is run.oci.systemd.subgroup annotation set?}
    B -- No --> C[No sub-cgroup is created]
    B -- Yes, non-empty --> D[Create sub-cgroup with specified name]
    B -- Yes, empty --> C
Loading

File-Level Changes

Change Details Files
Return NULL instead of "container" when no explicit subgroup is configured
  • Modify find_systemd_subgroup to return NULL when annotation is unset
src/libcrun/cgroup-systemd.c
Update man page and Markdown docs to reflect new default behavior
  • Reword option description to describe no default sub-cgroup
  • Remove mentions of defaulting to "container"
  • Explain behavior when annotation is empty or unset
crun.1
crun.1.md

Possibly linked issues


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@giuseppe
Copy link
Member Author

@haircommander FYI

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @giuseppe - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

drop default sub-cgroup with the systemd driver
1 participant