Skip to content

Allow Sidekiq workers to be disabled by default by configuration

Lukas Wanko requested to merge lw/488887-allow-disabling-sidekiq-workers-via-configuration into master

What does this MR do and why?

Allow Sidekiq workers to be disabled by default by configuration. Till now, we enabled all workers when a node was connected as a geo node; we now only enable the needed geo workers. With that, we can disable the offline cloud license provision worker for SaaS.

To achieve the desired goal, we changed the behavior of the cron manager in the following way:

Jobs that get disabled

Mode \ State Before After
Primary secondary geo jobs secondary geo jobs
Secondary all jobs except geo jobs and secondary jobs all jobs except geo jobs and secondary jobs
Non-geo all geo jobs all geo jobs

Jobs that get enabled

Mode \ State

 Before After
Primary all jobs expect secondary jobs

all general geo jobs and primary jobs

(this is a change, we don't enable non-geo workers any longer)
Secondary all general geo jobs and secondary jobs all general geo jobs and secondary jobs
Non-geo all jobs except geo jobs

all jobs mentioned in the cron manager

(this is a change, we don't enable non-geo workers any longer)

MR acceptance checklist

Please evaluate this MR against the MR acceptance checklist. It helps you analyze changes to reduce risks in quality, performance, reliability, security, and maintainability.

Screenshots or screen recordings

Screenshots are required for UI changes, and strongly recommended for all other merge requests.

Before After
SaaS image.png image.png
self-managed image.png image.png

How to set up and validate locally

Numbered steps to set up and validate the change are strongly suggested.

  1. You can check the state of the worker here http://localhost:3000/admin/background_jobs

  2. Switch the state of the worker depending the GitLab instance mode

    1. SaaS

      1. Add a file env.runit with the following content to the GDK directory

        export GITLAB_SIMULATE_SAAS=0

      2. Restart GitLab with

        export GITLAB_SIMULATE_SAAS=0; gdk restart
    2. self-managed

      1. Add a file env.runit with the following content to the GDK directory

        export GITLAB_SIMULATE_SAAS=1

      2. Restart GitLab with

        export GITLAB_SIMULATE_SAAS=1; gdk restart

  3. In case the status does not get updated, delete the workers before restarting with the following on a Rails console:

    Sidekiq::Cron::Job.all.each(&:destroy)

Resolves https://gitlab.com/gitlab-org/gitlab/-/issues/488887

Edited by Lukas Wanko

Merge request reports