Skip to content

Deprecate sidekiq delivery method for email ingestion

For guidance on the overall deprecations, removals and breaking changes workflow, please visit Breaking changes, deprecations, and removing features

Deprecation Summary

Add webhook delivery method to mailroom (omnibus-gitlab!5927 - merged) and https://gitlab.com/gitlab-com/gl-infra/scalability/-/issues/1462/+ add webhook delivery method strategy for email ingestion via mail_room as the sidekiq delivery method has some known flaws and usage has been discouraged by the former/original team that worked on this.

Additionally we are about to draft a blueprint that proposes that we move email ingestion from mail_room to application sidekiq worker jobs in Meta: Replace mail_room email ingestion with sc... (#393157) which will make both delivery_methods obsolete once implemented.

Therefore we should deprecate the sidekiq delivery method for incoming_email and service_desk_email and recommend the webhook delivery method. We should still document that sidekiq is available and might be a last resort in some scenarios.

There is currently no milestone defined, when we will remove the sidekiq delivery method.

Breaking Change

If customers use the sidekiq delivery method right now, that is a breaking change for them, so they should update their configuration and use webhook instead. If that does not work for any reason they would not have an additional alternative yet. So we should wait with the removal until the blueprint Meta: Replace mail_room email ingestion with sc... (#393157) is implemented.

Affected Topology

Self-managed administrators are affected by this change (removal). On SaaS we already use webhook. Users in general are not affected.

Affected Tier

  • Free
  • Premium
  • Ultimate

Checklists

Labels

  • This issue is labeled deprecation, and with the relevant ~devops::, ~group::, and ~Category: labels.
  • This issue is labeled breaking change if the removal of the deprecated item will be a breaking change.

Timeline

Please add links to the relevant merge requests.

  • As soon as possible, but no later than the third milestone preceding the major release (for example, given the following release schedule: 14.8, 14.9, 14.10, 15.0 – 14.8 is the third milestone preceding the major release):
  • On or before the major milestone: A removal entry has been created so the removal will appear on the removals by milestones page and be announced in the release post.
  • On the major milestone:

Mentions

  • Your stage's stable counterparts have been @mentioned on this issue. For example, Customer Support, Customer Success (Technical Account Manager), Product Marketing Manager.
    • To see who the stable counterparts are for a product team visit product categories
      • If there is no stable counterpart listed for Sales/CS please mention @timtams
      • If there is no stable counterpart listed for Support please mention @gitlab-com/support/managers
      • If there is no stable counterpart listed for Marketing please mention @cfoster3
  • Your GPM has been @mentioned so that they are aware of planned deprecations. The goal is to have reviews happen at least two releases before the final removal of the feature or introduction of a breaking change.

Deprecation Milestone

16.0

Planned Removal Milestone

17.0 18.0

Links

Edited by 🤖 GitLab Bot 🤖