Skip to content
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

mailserver: ignore vmail user for garbage collection scan #1031

Merged
merged 2 commits into from
Jul 4, 2024

Conversation

ctheune
Copy link
Contributor

@ctheune ctheune commented Jun 14, 2024

This also introduces the ability to exclude specific users from scanning them for automatic garbage collection roots - which can reduce load drastically.

Re PL-132331

@flyingcircusio/release-managers

Release process

Impact:

none

Changelog:

  • Allow to selectively disable the automatic garbage collection protection scan (fc-userscan) by setting the flyingcircus.agent.userscan-ignore-users option. (PL-132331)
  • On mailservers we do not scan the "virtual mailbox" user for automatic NixOS garbage collection roots. This will reduce load from our user scan script on those machines, especially with large and/or many mailboxes. (PL-132331)

PR release workflow (internal)

  • PR has internal ticket
  • internal issue ID (PL-…) part of branch name
  • internal issue ID mentioned in PR description text
  • ticket is on Platform agile board
  • ticket state set to Pull request ready
  • if ticket is more urgent than within the next few days, directly contact a member of the Platform team

Design notes

  • Provide a feature toggle if the change might need to be adjusted/reverted quickly depending on context. Consider whether the default should be on or off. Example: rate limiting.
  • All customer-facing features and (NixOS) options need to be discoverable from documentation. Add or update relevant documentation such that hosted and guided customers can understand it as well.

We're introducing new knobs here: the userscan-ignore-users list can be used to tweak which user are scanned for potential garbage collection roots.

Security implications

Mindful use of system resources.

  • Security requirements tested? (EVIDENCE)

Manually verified on test33.

This also introduces the ability to exclude specific users from
scanning them for automatic garbage collection roots - which can
reduce load drastically.

Re PL-132331
@osnyx osnyx self-requested a review June 20, 2024 15:41
Copy link
Member

@osnyx osnyx left a comment

Choose a reason for hiding this comment

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

As our documentation covers (fc-)userscan, this deserves to be covered in there as well. https://doc.flyingcircus.io/roles/fc-23.11-production/fc_collect_garbage_userscan.html

@dpausp dpausp changed the base branch from fc-23.11-dev to fc-24.05-dev June 28, 2024 12:03
@osnyx
Copy link
Member

osnyx commented Jul 4, 2024

I'm piggy-backing the doc change for this into another PR.

@osnyx osnyx merged commit 9b86eb9 into fc-24.05-dev Jul 4, 2024
2 checks passed
@osnyx osnyx deleted the PL-132331-userscan-dont-scan-maildir branch July 4, 2024 23:55
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.

None yet

3 participants