Skip to content
Snippets Groups Projects

Adds deprecation note for sidekiq delivery method for mailroom

Merged Marc Saleiko requested to merge ms-deprecate-sidekiq-delivery-method-for-mailroom into master
All threads resolved!
1 file
+ 26
3
Compare changes
  • Side-by-side
  • Inline
@@ -9,10 +9,33 @@
@@ -9,10 +9,33 @@
The `sidekiq` delivery method for `incoming_email` and `service_desk_email` is deprecated and is
The `sidekiq` delivery method for `incoming_email` and `service_desk_email` is deprecated and is
scheduled for removal in GitLab 17.0.
scheduled for removal in GitLab 17.0.
GitLab uses a separate process to ingest emails. We introduced the more robust `webhook` delivery method
GitLab uses a separate process called `mail_room` to ingest emails. Currently, GitLab administrators
to transport emails from the separate process to GitLab.
can configure their GitLab instances to use `sidekiq` or `webhook` delivery methods to deliver ingested
 
emails from `mail_room` to GitLab.
 
 
Using the `sidekiq` delivery method, `mail_room` writes the job data directly to the Redis queue,
 
so that process needs to be aware of the Redis configuration and we don't benefit from framework
 
optimizations such as job payload compression.
Use the `webhook` delivery method for `incoming_email` and `service_desk_email` instead of `sidekiq`.
Using the `webhook` delivery method, `mail_room` pushes the ingested email body to the GitLab
 
API. That way `mail_room` does not need to know your Redis configuration and the GitLab application
 
adds the processing job. `mail_room` authenticates with a shared secret key.
 
 
Reconfiguring an Omnibus installation generates this secret file automatically,
 
so no secret file configuration setting is needed.
 
 
You can configure a custom secret key file (32 characters base 64 encoded) by running a command
 
like below and referencing the secret file in `incoming_email_secret_file` and
 
`service_desk_email_secret_file` (always specify the absolute path):
 
 
```
 
echo $( ruby -rsecurerandom -e "puts SecureRandom.base64(32)" ) > ~/.gitlab-mailroom-secret
 
```
 
 
If you run GitLab on more than one machine, you need to provide the secret key file for each machine.
 
 
Use the `webhook` delivery method for `incoming_email_delivery_method` and `service_desk_email_delivery_method`
 
instead of `sidekiq`.
end_of_support_milestone: # (optional) Use "XX.YY" format. The milestone when support for this feature will end.
end_of_support_milestone: # (optional) Use "XX.YY" format. The milestone when support for this feature will end.
tiers: [Free, Silver, Gold, Core, Premium, Ultimate]
tiers: [Free, Silver, Gold, Core, Premium, Ultimate]
documentation_url: https://docs.gitlab.com/ee/user/project/service_desk.html#using-a-custom-email-address
documentation_url: https://docs.gitlab.com/ee/user/project/service_desk.html#using-a-custom-email-address
Loading