Move sidekiq-cluster to Core (bin)

The decision of moving the script back to Core
has the goal of making sidekiq-cluster the new
default (instead sidekiq). A series of steps
will be required for doing so, and these can
be seen at:

https://gitlab.com/groups/gitlab-com/gl-infra/-/epics/181

ee/bin/sidekiq-cluster → bin/sidekiq-cluster

@@ -2,9 +2,9 @@
 # frozen_string_literal: true
 
 require 'optparse'
-require_relative '../../lib/gitlab'
-require_relative '../../lib/gitlab/utils'
-require_relative '../../lib/gitlab/sidekiq_config/cli_methods'
+require_relative '../lib/gitlab'
+require_relative '../lib/gitlab/utils'
+require_relative '../lib/gitlab/sidekiq_config/cli_methods'
 require_relative '../lib/gitlab/sidekiq_cluster'
 require_relative '../lib/gitlab/sidekiq_cluster/cli'
 

changelogs/unreleased/osw-move-sidekiq-cluster-to-core.yml

+---
+title: Move sidekiq-cluster script to Core
+merge_request: 26703
+author:
+type: other

doc/administration/operations/extra_sidekiq_processes.md

@@ -311,11 +311,11 @@ If you experience a problem, you should contact GitLab support. Use the command
 line at your own risk.
 
 For debugging purposes, you can start extra Sidekiq processes by using the command
-`/opt/gitlab/embedded/service/gitlab-rails/ee/bin/sidekiq-cluster`. This command
+`/opt/gitlab/embedded/service/gitlab-rails/bin/sidekiq-cluster`. This command
 takes arguments using the following syntax:
 
 ```shell
-/opt/gitlab/embedded/service/gitlab-rails/ee/bin/sidekiq-cluster [QUEUE,QUEUE,...] [QUEUE, ...]
+/opt/gitlab/embedded/service/gitlab-rails/bin/sidekiq-cluster [QUEUE,QUEUE,...] [QUEUE, ...]
 ```
 
 Each separate argument denotes a group of queues that have to be processed by a
@@ -333,14 +333,14 @@ For example, say you want to start 2 extra processes: one to process the
 done as follows:
 
 ```shell
-/opt/gitlab/embedded/service/gitlab-rails/ee/bin/sidekiq-cluster process_commit post_receive
+/opt/gitlab/embedded/service/gitlab-rails/bin/sidekiq-cluster process_commit post_receive
 ```
 
 If you instead want to start one process processing both queues, you'd use the
 following syntax:
 
 ```shell
-/opt/gitlab/embedded/service/gitlab-rails/ee/bin/sidekiq-cluster process_commit,post_receive
+/opt/gitlab/embedded/service/gitlab-rails/bin/sidekiq-cluster process_commit,post_receive
 ```
 
 If you want to have one Sidekiq process dealing with the `process_commit` and
@@ -348,7 +348,7 @@ If you want to have one Sidekiq process dealing with the `process_commit` and
 you'd use the following:
 
 ```shell
-/opt/gitlab/embedded/service/gitlab-rails/ee/bin/sidekiq-cluster process_commit,post_receive gitlab_shell
+/opt/gitlab/embedded/service/gitlab-rails/bin/sidekiq-cluster process_commit,post_receive gitlab_shell
 ```
 
 ### Monitoring the `sidekiq-cluster` command
@@ -380,7 +380,7 @@ file is written, but this can be changed by passing the `--pidfile` option to
 `sidekiq-cluster`. For example:
 
 ```shell
-/opt/gitlab/embedded/service/gitlab-rails/ee/bin/sidekiq-cluster --pidfile /var/run/gitlab/sidekiq_cluster.pid process_commit
+/opt/gitlab/embedded/service/gitlab-rails/bin/sidekiq-cluster --pidfile /var/run/gitlab/sidekiq_cluster.pid process_commit
 ```
 
 Keep in mind that the PID file will contain the PID of the `sidekiq-cluster`

ee/lib/gitlab/sidekiq_cluster.rb → lib/gitlab/sidekiq_cluster.rb

@@ -83,7 +83,7 @@ module Gitlab
       end
 
       if dryrun
-        puts "Sidekiq command: #{cmd}"
+        puts "Sidekiq command: #{cmd}" # rubocop:disable Rails/Output
         return
       end
 

ee/lib/gitlab/sidekiq_cluster/cli.rb → lib/gitlab/sidekiq_cluster/cli.rb

@@ -15,7 +15,7 @@ module Gitlab
       CommandError = Class.new(StandardError)
 
       def initialize(log_output = STDERR)
-        require_relative '../../../../lib/gitlab/sidekiq_logging/json_formatter'
+        require_relative '../../../lib/gitlab/sidekiq_logging/json_formatter'
 
         # As recommended by https://github.com/mperham/sidekiq/wiki/Advanced-Options#concurrency
         @max_concurrency = 50

ee/spec/bin/sidekiq_cluster_spec.rb → spec/bin/sidekiq_cluster_spec.rb

@@ -2,7 +2,7 @@
 
 require 'spec_helper'
 
-describe 'ee/bin/sidekiq-cluster' do
+describe 'bin/sidekiq-cluster' do
   using RSpec::Parameterized::TableSyntax
 
   context 'when selecting some queues and excluding others' do
@@ -13,7 +13,7 @@ describe 'ee/bin/sidekiq-cluster' do
 
     with_them do
       it 'runs successfully', :aggregate_failures do
-        cmd = %w[ee/bin/sidekiq-cluster --dryrun] + args
+        cmd = %w[bin/sidekiq-cluster --dryrun] + args
 
         output, status = Gitlab::Popen.popen(cmd, Rails.root.to_s)
 
@@ -31,14 +31,14 @@ describe 'ee/bin/sidekiq-cluster' do
       %w[--experimental-queue-selector *]
     ].each do |args|
       it "runs successfully with `#{args}`", :aggregate_failures do
-        cmd = %w[ee/bin/sidekiq-cluster --dryrun] + args
+        cmd = %w[bin/sidekiq-cluster --dryrun] + args
 
         output, status = Gitlab::Popen.popen(cmd, Rails.root.to_s)
 
         expect(status).to be(0)
         expect(output).to include('"bundle", "exec", "sidekiq"')
         expect(output).to include('-qdefault,1')
-        expect(output).to include('-qcronjob:update_all_mirrors,1')
+        expect(output).to include('-qcronjob:ci_archive_traces_cron,1')
       end
     end
   end