Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2020-04-01 06:07:57 +0300
committerGitLab Bot <gitlab-bot@gitlab.com>2020-04-01 06:07:57 +0300
commit1dffba3bd853076efc1107b2dd63e221e75a210c (patch)
tree7d95f222bad46bacb4cb7490e44ce7cf51b6e2b7 /doc/administration/operations
parent396ad86100541bed6bc9960541a7dcddfaddd6de (diff)
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/administration/operations')
-rw-r--r--doc/administration/operations/extra_sidekiq_processes.md76
-rw-r--r--doc/administration/operations/index.md2
2 files changed, 69 insertions, 9 deletions
diff --git a/doc/administration/operations/extra_sidekiq_processes.md b/doc/administration/operations/extra_sidekiq_processes.md
index df2e4508eb8..e317297c854 100644
--- a/doc/administration/operations/extra_sidekiq_processes.md
+++ b/doc/administration/operations/extra_sidekiq_processes.md
@@ -1,10 +1,10 @@
-# Extra Sidekiq processes **(STARTER ONLY)**
+# Running multiple Sidekiq processes **(CORE ONLY)**
NOTE: **Note:**
The information in this page applies only to Omnibus GitLab.
-GitLab Starter allows one to start an extra set of Sidekiq processes
-besides the default one. These processes can be used to consume a dedicated set
+GitLab allows you to start multiple Sidekiq processes.
+These processes can be used to consume a dedicated set
of queues. This can be used to ensure certain queues always have dedicated
workers, no matter the number of jobs that need to be processed.
@@ -15,12 +15,12 @@ For a list of the existing Sidekiq queues, check the following files:
- [Queues for both GitLab Community and Enterprise Editions](https://gitlab.com/gitlab-org/gitlab/blob/master/app/workers/all_queues.yml)
- [Queues for GitLab Enterprise Editions only](https://gitlab.com/gitlab-org/gitlab/blob/master/ee/app/workers/all_queues.yml)
-Each entry in the above files represents a queue on which extra Sidekiq processes
+Each entry in the above files represents a queue on which Sidekiq processes
can be started.
-## Starting extra processes
+## Starting multiple processes
-To start extra Sidekiq processes, you must enable `sidekiq-cluster`:
+To start multiple Sidekiq processes, you must enable `sidekiq-cluster`:
1. Edit `/etc/gitlab/gitlab.rb` and add:
@@ -76,14 +76,14 @@ To start extra Sidekiq processes, you must enable `sidekiq-cluster`:
Once the extra Sidekiq processes are added, you can visit the
**Admin Area > Monitoring > Background Jobs** (`/admin/background_jobs`) in GitLab.
-![Extra Sidekiq processes](img/sidekiq-cluster.png)
+![Multiple Sidekiq processes](img/sidekiq-cluster.png)
## Negating settings
To have the additional Sidekiq processes work on every queue **except** the ones
you list:
-1. After you follow the steps for [starting extra processes](#starting-extra-processes),
+1. After you follow the steps for [starting extra processes](#starting-multiple-processes),
edit `/etc/gitlab/gitlab.rb` and add:
```ruby
@@ -189,6 +189,66 @@ sidekiq_cluster['queue_groups'] = [
]
```
+### Using Sidekiq cluster by default (experimental)
+
+> [Introduced](https://gitlab.com/gitlab-org/omnibus-gitlab/-/merge_requests/4006) in GitLab 12.10.
+
+CAUTION: **Warning:**
+This feature is experimental.
+
+We're moving [Sidekiq cluster to
+core](https://gitlab.com/groups/gitlab-com/gl-infra/-/epics/181) and
+plan to make it the default way of starting Sidekiq.
+
+Set the following to start Sidekiq (cluster)
+process for handling for all queues (`/etc/gitlab/gitlab.rb`):
+
+```ruby
+sidekiq['enable'] = true
+sidekiq['cluster'] = true
+```
+
+All of the aforementioned configuration options for `sidekiq_cluster`
+are also available. By default, they will be configured as follows:
+
+```ruby
+sidekiq['experimental_queue_selector'] = false
+sidekiq['interval'] = nil
+sidekiq['max_concurrency'] = nil
+sidekiq['min_concurrency'] = nil
+sidekiq['negate'] = false
+sidekiq['queue_groups'] = ['*']
+```
+
+`sidekiq_cluster` must be disabled if you decide to configure the
+cluster as above.
+
+When disabling `sidekiq_cluster`, you must copy your configuration for
+`sidekiq_cluster`over to `sidekiq`. Anything configured for
+`sidekiq_cluster` will be overridden by the options for `sidekiq` when
+setting `sidekiq['cluster'] = true`.
+
+When using this feature, replace the `sidekiq` service with the
+`sidekiq-cluster`service for `gitlab-ctl` commands.
+
+For example, instead of:
+
+```shell
+sudo gitlab-ctl restart sidekiq
+```
+
+Use:
+
+```shell
+sudo gitlab-ctl restart sidekiq-cluster
+```
+
+The [concurrency](#managing-concurrency) and other options configured
+for Sidekiq will be respected.
+
+By default, logs for `sidekiq-cluster` go to `/var/log/gitlab/sidekiq`
+like regular Sidekiq logs.
+
## Ignore all GitHub import queues
When [importing from GitHub](../../user/project/import/github.md), Sidekiq might
diff --git a/doc/administration/operations/index.md b/doc/administration/operations/index.md
index 1d80e23eecf..c27832e67ef 100644
--- a/doc/administration/operations/index.md
+++ b/doc/administration/operations/index.md
@@ -11,7 +11,7 @@ Keep your GitLab instance up and running smoothly.
by GitLab to another file system or another server.
- [Sidekiq MemoryKiller](sidekiq_memory_killer.md): Configure Sidekiq MemoryKiller
to restart Sidekiq.
-- [Extra Sidekiq operations](extra_sidekiq_processes.md): Configure an extra set of Sidekiq processes to ensure certain queues always have dedicated workers, no matter the amount of jobs that need to be processed. **(STARTER ONLY)**
+- [Multiple Sidekiq processes](extra_sidekiq_processes.md): Configure multiple Sidekiq processes to ensure certain queues always have dedicated workers, no matter the number of jobs that need to be processed. **(CORE ONLY)**
- [Unicorn](unicorn.md): Understand Unicorn and unicorn-worker-killer.
- Speed up SSH operations by [Authorizing SSH users via a fast,
indexed lookup to the GitLab database](fast_ssh_key_lookup.md), and/or