elasticsearch.md 49,3 КБ
Newer Older
GitLab Bot's avatar
GitLab Bot включено в состав коммита
1
2
3
4
5
6
7
---
type: reference
stage: Enablement
group: Global Search
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers
---

Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
8
# Elasticsearch integration **(STARTER ONLY)**
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
9

GitLab Bot's avatar
GitLab Bot включено в состав коммита
10
11
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/109 "Elasticsearch Merge Request") in GitLab [Starter](https://about.gitlab.com/pricing/) 8.4.
> - Support for [Amazon Elasticsearch](https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-gsg.html) was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/1305) in GitLab [Starter](https://about.gitlab.com/pricing/) 9.0.
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
12

GitLab Bot's avatar
GitLab Bot включено в состав коммита
13
14
This document describes how to enable Advanced Search. After
Advanced Search is enabled, you'll have the benefit of fast search response times
GitLab Bot's avatar
GitLab Bot включено в состав коммита
15
16
17
18
19
20
21
22
and the advantage of the following special searches:

- [Advanced Search](../user/search/advanced_global_search.md)
- [Advanced Search Syntax](../user/search/advanced_search_syntax.md)

## Version requirements

<!-- Remember to update ee/lib/system_check/app/elasticsearch_check.rb if this changes -->
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
23

GitLab Bot's avatar
GitLab Bot включено в состав коммита
24
25
26
27
28
29
| GitLab version                              | Elasticsearch version         |
|---------------------------------------------|-------------------------------|
| GitLab Enterprise Edition 12.7 or greater   | Elasticsearch 6.x through 7.x |
| GitLab Enterprise Edition 11.5 through 12.6 | Elasticsearch 5.6 through 6.x |
| GitLab Enterprise Edition 9.0 through 11.4  | Elasticsearch 5.1 through 5.5 |
| GitLab Enterprise Edition 8.4 through 8.17  | Elasticsearch 2.4 with [Delete By Query Plugin](https://www.elastic.co/guide/en/elasticsearch/plugins/2.4/plugins-delete-by-query.html) installed |
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
30

GitLab Bot's avatar
GitLab Bot включено в состав коммита
31
32
33
34
## System requirements

Elasticsearch requires additional resources in excess of those documented in the
[GitLab system requirements](../install/requirements.md).
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
35

GitLab Bot's avatar
GitLab Bot включено в состав коммита
36
37
38
39
The amount of resources (memory, CPU, storage) will vary greatly, based on the
amount of data being indexed into the Elasticsearch cluster. According to
[Elasticsearch official guidelines](https://www.elastic.co/guide/en/elasticsearch/guide/current/hardware.html#_memory),
each node should have:
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
40

GitLab Bot's avatar
GitLab Bot включено в состав коммита
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
- [Memory](https://www.elastic.co/guide/en/elasticsearch/guide/current/hardware.html#_memory): 8 GiB (minimum).
- [CPU](https://www.elastic.co/guide/en/elasticsearch/guide/current/hardware.html#_cpus): Modern processor with multiple cores.
- [Storage](https://www.elastic.co/guide/en/elasticsearch/guide/current/hardware.html#_disks): Use SSD storage. You will need enough storage for 50% of the total size of your Git repositories.

A few notes on CPU and storage:

- CPU requirements for Elasticsearch tend to be minimal. There are specific
  scenarios where this isn't true, but GitLab.com isn't using Elasticsearch in
  an exceptionally CPU-heavy way. More cores will be more performant than faster
  CPUs. Extra concurrency from multiple cores will far outweigh a slightly
  faster clock speed in Elasticsearch.

- Storage requirements for Elasticsearch are important, especially for
  indexing-heavy clusters. When possible use SSDs, whose speed is far superior
  to any spinning media for Elasticsearch. In testing, nodes that use SSD storage
  see boosts in both query and indexing performance.

Keep in mind, these are **minimum requirements** for Elasticsearch.
Heavily-utilized Elasticsearch clusters will likely require considerably more
resources.
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
61
62
63

## Installing Elasticsearch

GitLab Bot's avatar
GitLab Bot включено в состав коммита
64
65
66
67
Elasticsearch is *not* included in the Omnibus packages or when you install from
source. You must [install it separately](https://www.elastic.co/guide/en/elasticsearch/reference/7.x/install-elasticsearch.html "Elasticsearch 7.x installation documentation").
Be sure to select your version. Providing detailed information on installing
Elasticsearch is out of the scope of this document.
Ronald van Zon's avatar
Ronald van Zon включено в состав коммита
68
69

Elasticsearch should be installed on a separate server, whether you install
GitLab Bot's avatar
GitLab Bot включено в состав коммита
70
71
72
73
it yourself or use a cloud hosted offering like Elastic's [Elasticsearch Service](https://www.elastic.co/elasticsearch/service)
(available on AWS, GCP, or Azure) or the [Amazon Elasticsearch](https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-gsg.html)
service. Running Elasticsearch on the same server as GitLab is not recommended
and can cause a degradation in GitLab instance performance.
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
74

GitLab Bot's avatar
GitLab Bot включено в состав коммита
75
76
77
78
**For a single node Elasticsearch cluster the functional cluster health status
will be yellow** (will never be green) because the primary shard is allocated but
replicas can not be as there is no other node to which Elasticsearch can assign a
replica.
GitLab Bot's avatar
GitLab Bot включено в состав коммита
79

GitLab Bot's avatar
GitLab Bot включено в состав коммита
80
After the data is added to the database or repository and [Elasticsearch is
GitLab Bot's avatar
GitLab Bot включено в состав коммита
81
enabled in the Admin Area](#enabling-advanced-search) the search index will be
Ronald van Zon's avatar
Ronald van Zon включено в состав коммита
82
updated automatically.
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
83

GitLab Bot's avatar
GitLab Bot включено в состав коммита
84
## Elasticsearch repository indexer
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
85

GitLab Bot's avatar
GitLab Bot включено в состав коммита
86
For indexing Git repository data, GitLab uses an [indexer written in Go](https://gitlab.com/gitlab-org/gitlab-elasticsearch-indexer).
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
87

GitLab Bot's avatar
GitLab Bot включено в состав коммита
88
89
The way you install the Go indexer depends on your version of GitLab:

GitLab Bot's avatar
GitLab Bot включено в состав коммита
90
91
92
- For Omnibus GitLab 11.8 or greater, see [Omnibus GitLab](#omnibus-gitlab).
- For installations from source or older versions of Omnibus GitLab,
  [install the indexer from source](#from-source).
GitLab Bot's avatar
GitLab Bot включено в состав коммита
93

GitLab Bot's avatar
GitLab Bot включено в состав коммита
94
### Omnibus GitLab
GitLab Bot's avatar
GitLab Bot включено в состав коммита
95

GitLab Bot's avatar
GitLab Bot включено в состав коммита
96
Starting with GitLab 11.8, the Go indexer is included in Omnibus GitLab.
GitLab Bot's avatar
GitLab Bot включено в состав коммита
97
The former Ruby-based indexer was removed in [GitLab 12.3](https://gitlab.com/gitlab-org/gitlab/-/issues/6481).
Greg Myers's avatar
Greg Myers включено в состав коммита
98

GitLab Bot's avatar
GitLab Bot включено в состав коммита
99
### From source
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
100
101
102
103
104
105
106
107

First, we need to install some dependencies, then we'll build and install
the indexer itself.

This project relies on [ICU](http://site.icu-project.org/) for text encoding,
therefore we need to ensure the development packages for your platform are
installed before running `make`.

GitLab Bot's avatar
GitLab Bot включено в состав коммита
108
#### Debian / Ubuntu
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
109

Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
110
To install on Debian or Ubuntu, run:
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
111

GitLab Bot's avatar
GitLab Bot включено в состав коммита
112
```shell
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
113
114
115
sudo apt install libicu-dev
```

GitLab Bot's avatar
GitLab Bot включено в состав коммита
116
#### CentOS / RHEL
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
117
118
119

To install on CentOS or RHEL, run:

GitLab Bot's avatar
GitLab Bot включено в состав коммита
120
```shell
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
121
122
123
sudo yum install libicu-devel
```

GitLab Bot's avatar
GitLab Bot включено в состав коммита
124
#### Mac OSX
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
125
126
127

To install on macOS, run:

GitLab Bot's avatar
GitLab Bot включено в состав коммита
128
```shell
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
129
130
131
132
brew install icu4c
export PKG_CONFIG_PATH="/usr/local/opt/icu4c/lib/pkgconfig:$PKG_CONFIG_PATH"
```

GitLab Bot's avatar
GitLab Bot включено в состав коммита
133
### Building and installing
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
134
135
136

To build and install the indexer, run:

GitLab Bot's avatar
GitLab Bot включено в состав коммита
137
```shell
Nick Thomas's avatar
Nick Thomas включено в состав коммита
138
139
140
141
142
indexer_path=/home/git/gitlab-elasticsearch-indexer

# Run the installation task for gitlab-elasticsearch-indexer:
sudo -u git -H bundle exec rake gitlab:indexer:install[$indexer_path] RAILS_ENV=production
cd $indexer_path && sudo make install
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
143
144
145
146
147
148
149
150
151
```

The `gitlab-elasticsearch-indexer` will be installed to `/usr/local/bin`.

You can change the installation path with the `PREFIX` env variable.
Please remember to pass the `-E` flag to `sudo` if you do so.

Example:

GitLab Bot's avatar
GitLab Bot включено в состав коммита
152
```shell
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
153
154
155
PREFIX=/usr sudo -E make install
```

GitLab Bot's avatar
GitLab Bot включено в состав коммита
156
After installation, be sure to [enable Elasticsearch](#enabling-advanced-search).
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
157

GitLab Bot's avatar
GitLab Bot включено в состав коммита
158
NOTE: **Note:**
GitLab Bot's avatar
GitLab Bot включено в состав коммита
159
160
161
162
163
164
If you see an error such as `Permission denied - /home/git/gitlab-elasticsearch-indexer/` while indexing, you
may need to set the `production -> elasticsearch -> indexer_path` setting in your `gitlab.yml` file to
`/usr/local/bin/gitlab-elasticsearch-indexer`, which is where the binary is installed.

## Enabling Advanced Search

GitLab Bot's avatar
GitLab Bot включено в состав коммита
165
166
For GitLab instances with more than 50GB repository data you can follow the instructions for [Indexing large
instances](#indexing-large-instances) below.
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
167

GitLab Bot's avatar
GitLab Bot включено в состав коммита
168
To enable Advanced Search, you need to have admin access to GitLab:
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
169

GitLab Bot's avatar
GitLab Bot включено в состав коммита
170
171
1. Navigate to **Admin Area** (wrench icon), then **Settings > General**
   and expand the **Advanced Search** section.
GitLab Bot's avatar
GitLab Bot включено в состав коммита
172

GitLab Bot's avatar
GitLab Bot включено в состав коммита
173
174
175
   NOTE: **Note:**
   To see the Advanced Search section, you need an active Starter
   [license](../user/admin_area/license.md).
GitLab Bot's avatar
GitLab Bot включено в состав коммита
176

GitLab Bot's avatar
GitLab Bot включено в состав коммита
177
178
179
180
181
182
1. Configure the [Advanced Search settings](#advanced-search-configuration) for
   your Elasticsearch cluster. Do not enable **Search with Elasticsearch enabled**
   yet.
1. Now enable **Elasticsearch indexing** in **Admin Area > Settings >
   General > Advanced Search** and click **Save changes**. This will create
   an empty index if one does not already exist.
GitLab Bot's avatar
GitLab Bot включено в состав коммита
183
184
185
186
187
188
189
190
191
192
193
194
1. Click **Index all projects**.
1. Click **Check progress** in the confirmation message to see the status of
   the background jobs.
1. Personal snippets need to be indexed using another Rake task:

   ```shell
   # Omnibus installations
   sudo gitlab-rake gitlab:elastic:index_snippets

   # Installations from source
   bundle exec rake gitlab:elastic:index_snippets RAILS_ENV=production
   ```
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
195

GitLab Bot's avatar
GitLab Bot включено в состав коммита
196
197
198
1. After the indexing has completed, enable **Search with Elasticsearch enabled** in
   **Admin Area > Settings > General > Advanced Search** and click **Save
   changes**.
Markus Koller's avatar
Markus Koller включено в состав коммита
199

GitLab Bot's avatar
GitLab Bot включено в состав коммита
200
### Advanced Search configuration
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
201
202
203

The following Elasticsearch settings are available:

GitLab Bot's avatar
GitLab Bot включено в состав коммита
204
| Parameter                                             | Description |
GitLab Bot's avatar
GitLab Bot включено в состав коммита
205
|-------------------------------------------------------|-------------|
GitLab Bot's avatar
GitLab Bot включено в состав коммита
206
| `Elasticsearch indexing`                              | Enables or disables Elasticsearch indexing and creates an empty index if one does not already exist. You may want to enable indexing but disable search in order to give the index time to be fully completed, for example. Also, keep in mind that this option doesn't have any impact on existing data, this only enables/disables the background indexer which tracks data changes and ensures new data is indexed. |
GitLab Bot's avatar
GitLab Bot включено в состав коммита
207
208
| `Pause Elasticsearch indexing`                        | Enables or disables temporary indexing pause. This is useful for cluster migration/reindexing. All changes are still tracked, but they are not committed to the Elasticsearch index until unpaused. |
| `Search with Elasticsearch enabled`                   | Enables or disables using Elasticsearch in search. |
GitLab Bot's avatar
GitLab Bot включено в состав коммита
209
| `URL`                                                 | The URL to use for connecting to Elasticsearch. Use a comma-separated list to support clustering (e.g., `http://host1, https://host2:9200`). If your Elasticsearch instance is password protected, pass the `username:password` in the URL (e.g., `http://<username>:<password>@<elastic_host>:9200/`). |
GitLab Bot's avatar
GitLab Bot включено в состав коммита
210
| `Number of Elasticsearch shards`                      | Elasticsearch indexes are split into multiple shards for performance reasons. In general, larger indexes need to have more shards. Changes to this value do not take effect until the index is recreated. You can read more about tradeoffs in the [Elasticsearch documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/scalability.html). |
GitLab Bot's avatar
GitLab Bot включено в состав коммита
211
212
| `Number of Elasticsearch replicas`                    | Each Elasticsearch shard can have a number of replicas. These are a complete copy of the shard, and can provide increased query performance or resilience against hardware failure. Increasing this value will greatly increase total disk space required by the index. |
| `Limit namespaces and projects that can be indexed`   | Enabling this will allow you to select namespaces and projects to index. All other namespaces and projects will use database search instead. Please note that if you enable this option but do not select any namespaces or projects, none will be indexed. [Read more below](#limiting-namespaces-and-projects).
GitLab Bot's avatar
GitLab Bot включено в состав коммита
213
214
| `Using AWS hosted Elasticsearch with IAM credentials` | Sign your Elasticsearch requests using [AWS IAM authorization](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html), [AWS EC2 Instance Profile Credentials](https://docs.aws.amazon.com/codedeploy/latest/userguide/getting-started-create-iam-instance-profile.html#getting-started-create-iam-instance-profile-cli), or [AWS ECS Tasks Credentials](https://docs.aws.amazon.com/AmazonECS/latest/userguide/task-iam-roles.html). Please refer to [Identity and Access Management in Amazon Elasticsearch Service](https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-ac.html) for details of AWS hosted Elasticsearch domain access policy configuration. |
| `AWS Region`                                          | The AWS region in which your Elasticsearch service is located. |
GitLab Bot's avatar
GitLab Bot включено в состав коммита
215
216
| `AWS Access Key`                                      | The AWS access key. |
| `AWS Secret Access Key`                               | The AWS secret access key. |
GitLab Bot's avatar
GitLab Bot включено в состав коммита
217
| `Maximum file size indexed`                           | See [the explanation in instance limits.](../administration/instance_limits.md#maximum-file-size-indexed). |
GitLab Bot's avatar
GitLab Bot включено в состав коммита
218
| `Maximum field length`                                | See [the explanation in instance limits.](../administration/instance_limits.md#maximum-field-length). |
GitLab Bot's avatar
GitLab Bot включено в состав коммита
219
| `Maximum bulk request size (MiB)` | The Maximum Bulk Request size is used by GitLab's Golang-based indexer processes and indicates how much data it ought to collect (and store in memory) in a given indexing process before submitting the payload to Elasticsearch’s Bulk API. This setting should be used with the Bulk request concurrency setting (see below) and needs to accommodate the resource constraints of both the Elasticsearch host(s) and the host(s) running GitLab's Golang-based indexer either from the `gitlab-rake` command or the Sidekiq tasks. |
GitLab Bot's avatar
GitLab Bot включено в состав коммита
220
221
| `Bulk request concurrency`                            | The Bulk request concurrency indicates how many of GitLab's Golang-based indexer processes (or threads) can run in parallel to collect data to subsequently submit to Elasticsearch’s Bulk API. This increases indexing performance, but fills the Elasticsearch bulk requests queue faster. This setting should be used together with the Maximum bulk request size setting (see above) and needs to accommodate the resource constraints of both the Elasticsearch host(s) and the host(s) running GitLab's Golang-based indexer either from the `gitlab-rake` command or the Sidekiq tasks. |
| `Client request timeout` | Elasticsearch HTTP client request timeout value in seconds. `0` means using the system default timeout value, which depends on the libraries that GitLab application is built upon. |
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
222
223
224

### Limiting namespaces and projects

GitLab Bot's avatar
GitLab Bot включено в состав коммита
225
226
If you select `Limit namespaces and projects that can be indexed`, more options will become available.

Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
227
228
![limit namespaces and projects options](img/limit_namespaces_projects_options.png)

GitLab Bot's avatar
GitLab Bot включено в состав коммита
229
You can select namespaces and projects to index exclusively. Note that if the namespace is a group it will include
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
230
231
any sub-groups and projects belonging to those sub-groups to be indexed as well.

GitLab Bot's avatar
GitLab Bot включено в состав коммита
232
Advanced Search only provides cross-group code/commit search (global) if all name-spaces are indexed. In this particular scenario where only a subset of namespaces are indexed, a global search will not provide a code or commit scope. This will be possible only in the scope of an indexed namespace. Currently there is no way to code/commit search in multiple indexed namespaces (when only a subset of namespaces has been indexed). For example if two groups are indexed, there is no way to run a single code search on both. You can only run a code search on the first group and then on the second.
GitLab Bot's avatar
GitLab Bot включено в состав коммита
233

Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
234
You can filter the selection dropdown by writing part of the namespace or project name you're interested in.
GitLab Bot's avatar
GitLab Bot включено в состав коммита
235

Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
236
237
![limit namespace filter](img/limit_namespace_filter.png)

GitLab Bot's avatar
GitLab Bot включено в состав коммита
238
NOTE: **Note:**
GitLab Bot's avatar
GitLab Bot включено в состав коммита
239
If no namespaces or projects are selected, no Advanced Search indexing will take place.
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
240

GitLab Bot's avatar
GitLab Bot включено в состав коммита
241
CAUTION: **Warning:**
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
242
If you have already indexed your instance, you will have to regenerate the index in order to delete all existing data
GitLab Bot's avatar
GitLab Bot включено в состав коммита
243
for filtering to work correctly. To do this run the Rake tasks `gitlab:elastic:recreate_index` and
Evan Read's avatar
Evan Read включено в состав коммита
244
`gitlab:elastic:clear_index_status`. Afterwards, removing a namespace or a project from the list will delete the data
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
245
246
from the Elasticsearch index as expected.

GitLab Bot's avatar
GitLab Bot включено в состав коммита
247
## Disabling Advanced Search
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
248
249
250

To disable the Elasticsearch integration:

GitLab Bot's avatar
GitLab Bot включено в состав коммита
251
252
1. Navigate to the **Admin Area** (wrench icon), then **Settings > General**.
1. Expand the **Advanced Search** section and uncheck **Elasticsearch indexing**
Markus Koller's avatar
Markus Koller включено в состав коммита
253
254
   and **Search with Elasticsearch enabled**.
1. Click **Save changes** for the changes to take effect.
GitLab Bot's avatar
GitLab Bot включено в состав коммита
255
1. (Optional) Delete the existing index:
Markus Koller's avatar
Markus Koller включено в состав коммита
256

GitLab Bot's avatar
GitLab Bot включено в состав коммита
257
   ```shell
Markus Koller's avatar
Markus Koller включено в состав коммита
258
259
260
261
262
263
   # Omnibus installations
   sudo gitlab-rake gitlab:elastic:delete_index

   # Installations from source
   bundle exec rake gitlab:elastic:delete_index RAILS_ENV=production
   ```
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
264

GitLab Bot's avatar
GitLab Bot включено в состав коммита
265
266
## Zero downtime reindexing

GitLab Bot's avatar
GitLab Bot включено в состав коммита
267
268
269
270
The idea behind this reindexing method is to leverage Elasticsearch index alias
feature to atomically swap between two indices. We'll refer to each index as
`primary` (online and used by GitLab for read/writes) and `secondary`
(offline, for reindexing purpose).
GitLab Bot's avatar
GitLab Bot включено в состав коммита
271

GitLab Bot's avatar
GitLab Bot включено в состав коммита
272
273
Instead of connecting directly to the `primary` index, we'll setup an index
alias such as we can change the underlying index at will.
GitLab Bot's avatar
GitLab Bot включено в состав коммита
274
275

NOTE: **Note:**
GitLab Bot's avatar
GitLab Bot включено в состав коммита
276
Any index attached to the production alias is deemed a `primary` and will be
GitLab Bot's avatar
GitLab Bot включено в состав коммита
277
used by the GitLab Advanced Search integration.
GitLab Bot's avatar
GitLab Bot включено в состав коммита
278
279
280

### Pause the indexing

GitLab Bot's avatar
GitLab Bot включено в состав коммита
281
282
In the **Admin Area > Settings > General > Advanced Search** section, select the
**Pause Elasticsearch Indexing** setting, and then save your change.
GitLab Bot's avatar
GitLab Bot включено в состав коммита
283

GitLab Bot's avatar
GitLab Bot включено в состав коммита
284
285
With this, all updates that should happen on your Elasticsearch index will be
buffered and caught up once unpaused.
GitLab Bot's avatar
GitLab Bot включено в состав коммита
286
287
288
289

### Setup

TIP: **Tip:**
GitLab Bot's avatar
GitLab Bot включено в состав коммита
290
291
If your index was created with GitLab 13.0 or greater, you can directly
[trigger the reindex](#trigger-the-reindex-via-the-advanced-search-administration).
GitLab Bot's avatar
GitLab Bot включено в состав коммита
292

GitLab Bot's avatar
GitLab Bot включено в состав коммита
293
294
This process involves several shell commands and curl invocations, so a good
initial setup will help for later:
GitLab Bot's avatar
GitLab Bot включено в состав коммита
295
296

```shell
GitLab Bot's avatar
GitLab Bot включено в состав коммита
297
# You can find this value under Admin Area > Settings > General > Advanced Search > URL
GitLab Bot's avatar
GitLab Bot включено в состав коммита
298
299
300
301
302
303
304
305
export CLUSTER_URL="http://localhost:9200"
export PRIMARY_INDEX="gitlab-production"
export SECONDARY_INDEX="gitlab-production-$(date +%s)"
```

### Reclaiming the `gitlab-production` index name

CAUTION: **Caution:**
GitLab Bot's avatar
GitLab Bot включено в состав коммита
306
307
It is highly recommended that you take a snapshot of your cluster to ensure
there is a recovery path if anything goes wrong.
GitLab Bot's avatar
GitLab Bot включено в состав коммита
308

GitLab Bot's avatar
GitLab Bot включено в состав коммита
309
310
Due to a technical limitation, there will be a slight downtime because of the
fact that we need to reclaim the current `primary` index to be used as the alias.
GitLab Bot's avatar
GitLab Bot включено в состав коммита
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327

To reclaim the `gitlab-production` index name, you need to first create a `secondary` index and then trigger the re-index from `primary`.

#### Creating a secondary index

To create a secondary index, run the following Rake task. The `SKIP_ALIAS`
environment variable will disable the automatic creation of the Elasticsearch
alias, which would conflict with the existing index under `$PRIMARY_INDEX`:

```shell
# Omnibus installation
sudo SKIP_ALIAS=1 gitlab-rake "gitlab:elastic:create_empty_index[$SECONDARY_INDEX]"

# Source installation
SKIP_ALIAS=1 bundle exec rake "gitlab:elastic:create_empty_index[$SECONDARY_INDEX]"
```

GitLab Bot's avatar
GitLab Bot включено в состав коммита
328
329
The index should be created successfully, with the latest index options and
mappings.
GitLab Bot's avatar
GitLab Bot включено в состав коммита
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349

#### Trigger the re-index from `primary`

To trigger the re-index from `primary` index:

1. Use the Elasticsearch [Reindex API](https://www.elastic.co/guide/en/elasticsearch/reference/7.6/docs-reindex.html):

    ```shell
    curl --request POST \
          --header 'Content-Type: application/json' \
          --data "{ \"source\": { \"index\": \"$PRIMARY_INDEX\" }, \"dest\": { \"index\": \"$SECONDARY_INDEX\" } }" \
          "$CLUSTER_URL/_reindex?slices=auto&wait_for_completion=false"
    ```

    There will be an output like:

    ```plaintext
    {"task":"3qw_Tr0YQLq7PF16Xek8YA:1012"}
    ```

GitLab Bot's avatar
GitLab Bot включено в состав коммита
350
    Note the `task` value, as it will be useful to follow the reindex progress.
GitLab Bot's avatar
GitLab Bot включено в состав коммита
351

GitLab Bot's avatar
GitLab Bot включено в состав коммита
352
1. Wait for the reindex process to complete by checking the `completed` value.
GitLab Bot's avatar
GitLab Bot включено в состав коммита
353
354
355
356
357
358
359
360
361
362
363
364
365
   Using the `task` value form the previous step:

    ```shell
    export TASK_ID=3qw_Tr0YQLq7PF16Xek8YA:1012
    curl "$CLUSTER_URL/_tasks/$TASK_ID?pretty"
    ```

    The output will be like:

    ```plaintext
    {"completed":false, …}
    ```

GitLab Bot's avatar
GitLab Bot включено в состав коммита
366
    After the returned value is `true`, continue to the next step.
GitLab Bot's avatar
GitLab Bot включено в состав коммита
367

GitLab Bot's avatar
GitLab Bot включено в состав коммита
368
369
1. Ensure that the secondary index has data in it. You can use the
   Elasticsearch API to look for the index size and compare our two indices:
GitLab Bot's avatar
GitLab Bot включено в состав коммита
370
371
372
373
374
375
376
377
378

    ```shell
    curl $CLUSTER_URL/$PRIMARY_INDEX/_count => 123123
    curl $CLUSTER_URL/$SECONDARY_INDEX/_count => 123123
    ```

    TIP: **Tip:**
    Comparing the document count is more accurate than using the index size, as improvements to the storage might cause the new index to be smaller than the original one.

GitLab Bot's avatar
GitLab Bot включено в состав коммита
379
380
1. After you are confident your `secondary` index is valid, you can process to
   the creation of the alias.
GitLab Bot's avatar
GitLab Bot включено в состав коммита
381
382
383
384
385
386
387
388
389
390
391
392

    ```shell
    # Delete the original index
    curl --request DELETE $CLUSTER_URL/$PRIMARY_INDEX

    # Create the alias and add the `secondary` index to it
    curl --request POST \
          --header 'Content-Type: application/json' \
          --data "{\"actions\":[{\"add\":{\"index\":\"$SECONDARY_INDEX\",\"alias\":\"$PRIMARY_INDEX\"}}]}}" \
          $CLUSTER_URL/_aliases
    ```

GitLab Bot's avatar
GitLab Bot включено в состав коммита
393
    The reindexing is now completed. Your GitLab instance is now ready to use the [automated in-cluster reindexing](#trigger-the-reindex-via-the-advanced-search-administration) feature for future reindexing.
GitLab Bot's avatar
GitLab Bot включено в состав коммита
394
395
396

1. Unpause the indexing

GitLab Bot's avatar
GitLab Bot включено в состав коммита
397
    Under **Admin Area > Settings > General > Advanced Search**, uncheck the **Pause Elasticsearch Indexing** setting and save.
GitLab Bot's avatar
GitLab Bot включено в состав коммита
398

GitLab Bot's avatar
GitLab Bot включено в состав коммита
399
### Trigger the reindex via the Advanced Search administration
GitLab Bot's avatar
GitLab Bot включено в состав коммита
400
401
402
403

> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/34069) in [GitLab Starter](https://about.gitlab.com/pricing/) 13.2.
> - A scheduled index deletion and the ability to cancel it was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/38914) in GitLab Starter 13.3.

GitLab Bot's avatar
GitLab Bot включено в состав коммита
404
Under **Admin Area > Settings > General > Advanced Search > Elasticsearch zero-downtime reindexing**, click on **Trigger cluster reindexing**.
GitLab Bot's avatar
GitLab Bot включено в состав коммита
405
406
407
408
409
410
411
412

Reindexing can be a lengthy process depending on the size of your Elasticsearch cluster.

CAUTION: **Caution:**
After the reindexing is completed, the original index will be scheduled to be deleted after 14 days. You can cancel this action by pressing the cancel button.

While the reindexing is running, you will be able to follow its progress under that same section.

GitLab Bot's avatar
GitLab Bot включено в состав коммита
413
## GitLab Advanced Search Rake tasks
GitLab Bot's avatar
GitLab Bot включено в состав коммита
414
415
416
417

Rake tasks are available to:

- [Build and install](#building-and-installing) the indexer.
GitLab Bot's avatar
GitLab Bot включено в состав коммита
418
- Delete indexes when [disabling Elasticsearch](#disabling-advanced-search).
GitLab Bot's avatar
GitLab Bot включено в состав коммита
419
- Add GitLab data to an index.
GitLab Bot's avatar
GitLab Bot включено в состав коммита
420
421
422
423
424

The following are some available Rake tasks:

| Task                                                                                                                                                    | Description                                                                                                                                                                               |
|:--------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
GitLab Bot's avatar
GitLab Bot включено в состав коммита
425
| [`sudo gitlab-rake gitlab:elastic:index`](https://gitlab.com/gitlab-org/gitlab/blob/master/ee/lib/tasks/gitlab/elastic.rake)                            | Enables Elasticsearch indexing and run `gitlab:elastic:create_empty_index`, `gitlab:elastic:clear_index_status`, `gitlab:elastic:index_projects`, and `gitlab:elastic:index_snippets`.                          |
GitLab Bot's avatar
GitLab Bot включено в состав коммита
426
427
| [`sudo gitlab-rake gitlab:elastic:index_projects`](https://gitlab.com/gitlab-org/gitlab/blob/master/ee/lib/tasks/gitlab/elastic.rake)                   | Iterates over all projects and queues Sidekiq jobs to index them in the background.                                                                                                       |
| [`sudo gitlab-rake gitlab:elastic:index_projects_status`](https://gitlab.com/gitlab-org/gitlab/blob/master/ee/lib/tasks/gitlab/elastic.rake)            | Determines the overall status of the indexing. It is done by counting the total number of indexed projects, dividing by a count of the total number of projects, then multiplying by 100. |
GitLab Bot's avatar
GitLab Bot включено в состав коммита
428
| [`sudo gitlab-rake gitlab:elastic:clear_index_status`](https://gitlab.com/gitlab-org/gitlab/blob/master/ee/lib/tasks/gitlab/elastic.rake)               | Deletes all instances of IndexStatus for all projects. Note that this command will result in a complete wipe of the index, and it should be used with caution.                                                                                              |
GitLab Bot's avatar
GitLab Bot включено в состав коммита
429
430
431
| [`sudo gitlab-rake gitlab:elastic:create_empty_index[<TARGET_NAME>]`](https://gitlab.com/gitlab-org/gitlab/blob/master/ee/lib/tasks/gitlab/elastic.rake) | Generates an empty index and assigns an alias for it on the Elasticsearch side only if it doesn't already exist.                                                                                                      |
| [`sudo gitlab-rake gitlab:elastic:delete_index[<TARGET_NAME>]`](https://gitlab.com/gitlab-org/gitlab/blob/master/ee/lib/tasks/gitlab/elastic.rake)       | Removes the GitLab index and alias (if exists) on the Elasticsearch instance.                                                                                                                                   |
| [`sudo gitlab-rake gitlab:elastic:recreate_index[<TARGET_NAME>]`](https://gitlab.com/gitlab-org/gitlab/blob/master/ee/lib/tasks/gitlab/elastic.rake)     | Wrapper task for `gitlab:elastic:delete_index[<TARGET_NAME>]` and `gitlab:elastic:create_empty_index[<TARGET_NAME>]`.                                                                       |
GitLab Bot's avatar
GitLab Bot включено в состав коммита
432
433
| [`sudo gitlab-rake gitlab:elastic:index_snippets`](https://gitlab.com/gitlab-org/gitlab/blob/master/ee/lib/tasks/gitlab/elastic.rake)                   | Performs an Elasticsearch import that indexes the snippets data.                                                                                                                          |
| [`sudo gitlab-rake gitlab:elastic:projects_not_indexed`](https://gitlab.com/gitlab-org/gitlab/blob/master/ee/lib/tasks/gitlab/elastic.rake)             | Displays which projects are not indexed.                                                                                                                                                  |
GitLab Bot's avatar
GitLab Bot включено в состав коммита
434
| [`sudo gitlab-rake gitlab:elastic:reindex_cluster`](https://gitlab.com/gitlab-org/gitlab/blob/master/ee/lib/tasks/gitlab/elastic.rake)             | Schedules a zero-downtime cluster reindexing task. This feature should be used with an index that was created after GitLab 13.0. |
GitLab Bot's avatar
GitLab Bot включено в состав коммита
435
436

NOTE: **Note:**
GitLab Bot's avatar
GitLab Bot включено в состав коммита
437
The `TARGET_NAME` parameter is optional and will use the default index/alias name from the current `RAILS_ENV` if not set.
GitLab Bot's avatar
GitLab Bot включено в состав коммита
438
439

### Environment variables
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
440

GitLab Bot's avatar
GitLab Bot включено в состав коммита
441
In addition to the Rake tasks, there are some environment variables that can be used to modify the process:
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
442
443
444
445
446
447
448
449
450
451
452

| Environment Variable | Data Type | What it does                                                                 |
| -------------------- |:---------:| ---------------------------------------------------------------------------- |
| `UPDATE_INDEX`       | Boolean   | Tells the indexer to overwrite any existing index data (true/false).         |
| `ID_TO`              | Integer   | Tells the indexer to only index projects less than or equal to the value.    |
| `ID_FROM`            | Integer   | Tells the indexer to only index projects greater than or equal to the value. |

### Indexing a specific project

Because the `ID_TO` and `ID_FROM` environment variables use the `or equal to` comparison, you can index only one project by using both these variables with the same project ID number:

GitLab Bot's avatar
GitLab Bot включено в состав коммита
453
```shell
Markus Koller's avatar
Markus Koller включено в состав коммита
454
root@git:~# sudo gitlab-rake gitlab:elastic:index_projects ID_TO=5 ID_FROM=5
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
455
456
457
458
Indexing project repositories...I, [2019-03-04T21:27:03.083410 #3384]  INFO -- : Indexing GitLab User / test (ID=33)...
I, [2019-03-04T21:27:05.215266 #3384]  INFO -- : Indexing GitLab User / test (ID=33) is done!
```

GitLab Bot's avatar
GitLab Bot включено в состав коммита
459
## Advanced Search index scopes
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474

When performing a search, the GitLab index will use the following scopes:

| Scope Name       | What it searches       |
| ---------------- | ---------------------- |
| `commits`        | Commit data            |
| `projects`       | Project data (default) |
| `blobs`          | Code                   |
| `issues`         | Issue data             |
| `merge_requests` | Merge Request data     |
| `milestones`     | Milestone data         |
| `notes`          | Note data              |
| `snippets`       | Snippet data           |
| `wiki_blobs`     | Wiki contents          |

Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
475
476
## Tuning

GitLab Bot's avatar
GitLab Bot включено в состав коммита
477
478
479
480
481
482
483
484
485
486
487
488
489
490
### Guidance on choosing optimal cluster configuration

For basic guidance on choosing a cluster configuration you may refer to [Elastic Cloud Calculator](https://cloud.elastic.co/pricing). You can find more information below.

- Generally, you will want to use at least a 2-node cluster configuration with one replica, which will allow you to have resilience. If your storage usage is growing quickly, you may want to plan horizontal scaling (adding more nodes) beforehand.
- It's not recommended to use HDD storage with the search cluster, because it will take a hit on performance. It's better to use SSD storage (NVMe or SATA SSD drives for example).
- You can use the [GitLab Performance Tool](https://gitlab.com/gitlab-org/quality/performance) to benchmark search performance with different search cluster sizes and configurations.
- `Heap size` should be set to no more than 50% of your physical RAM. Additionally, it shouldn't be set to more than the threshold for zero-based compressed oops. The exact threshold varies, but 26 GB is safe on most systems, but can also be as large as 30 GB on some systems. See [Setting the heap size](https://www.elastic.co/guide/en/elasticsearch/reference/current/heap-size.html#heap-size) for more details.
- Number of CPUs (CPU cores) per node usually corresponds to the `Number of Elasticsearch shards` setting described below.
- A good guideline is to ensure you keep the number of shards per node below 20 per GB heap it has configured. A node with a 30GB heap should therefore have a maximum of 600 shards, but the further below this limit you can keep it the better. This will generally help the cluster stay in good health.
- Small shards result in small segments, which increases overhead. Aim to keep the average shard size between at least a few GB and a few tens of GB. Another consideration is the number of documents, you should aim for this simple formula for the number of shards: `number of expected documents / 5M +1`.
- `refresh_interval` is a per index setting. You may want to adjust that from default `1s` to a bigger value if you don't need data in realtime. This will change how soon you will see fresh results. If that's important for you, you should leave it as close as possible to the default value.
- You might want to raise [`indices.memory.index_buffer_size`](https://www.elastic.co/guide/en/elasticsearch/reference/current/indexing-buffer.html) to 30% or 40% if you have a lot of heavy indexing operations.

GitLab Bot's avatar
GitLab Bot включено в состав коммита
491
### Advanced Search integration settings guidance
GitLab Bot's avatar
GitLab Bot включено в состав коммита
492
493
494
495

- The `Number of Elasticsearch shards` setting usually corresponds with the number of CPUs available in your cluster. For example, if you have a 3-node cluster with 4 cores each, this means you will benefit from having at least 3*4=12 shards in the cluster. Please note, it's only possible to change the shards number by using [Split index API](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-split-index.html) or by reindexing to a different index with a changed number of shards.
- The `Number of Elasticsearch replicas` setting should most of the time be equal to `1` (each shard will have 1 replica). Using `0` is not recommended, because losing one node will corrupt the index.

GitLab Bot's avatar
GitLab Bot включено в состав коммита
496
497
498
### Indexing large instances

This section may be helpful in the event that the other
GitLab Bot's avatar
GitLab Bot включено в состав коммита
499
[basic instructions](#enabling-advanced-search) cause problems
GitLab Bot's avatar
GitLab Bot включено в состав коммита
500
501
502
503
504
505
506
507
due to large volumes of data being indexed.

CAUTION: **Warning:**
Indexing a large instance will generate a lot of Sidekiq jobs.
Make sure to prepare for this task by having a [Scalable and Highly Available
Setup](../administration/reference_architectures/index.md) or creating [extra
Sidekiq processes](../administration/operations/extra_sidekiq_processes.md).

GitLab Bot's avatar
GitLab Bot включено в состав коммита
508
1. [Configure your Elasticsearch host and port](#enabling-advanced-search).
GitLab Bot's avatar
GitLab Bot включено в состав коммита
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
1. Create empty indexes:

   ```shell
   # Omnibus installations
   sudo gitlab-rake gitlab:elastic:create_empty_index

   # Installations from source
   bundle exec rake gitlab:elastic:create_empty_index RAILS_ENV=production
   ```

1. If this is a re-index of your GitLab instance, clear the index status:

   ```shell
   # Omnibus installations
   sudo gitlab-rake gitlab:elastic:clear_index_status

   # Installations from source
   bundle exec rake gitlab:elastic:clear_index_status RAILS_ENV=production
   ```

GitLab Bot's avatar
GitLab Bot включено в состав коммита
529
1. [Enable **Elasticsearch indexing**](#enabling-advanced-search).
GitLab Bot's avatar
GitLab Bot включено в состав коммита
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
1. Indexing large Git repositories can take a while. To speed up the process, you can [tune for indexing speed](https://www.elastic.co/guide/en/elasticsearch/reference/current/tune-for-indexing-speed.html#tune-for-indexing-speed):

   - You can temporarily disable [`refresh`](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-refresh.html), the operation responsible for making changes to an index available to search.

   - You can set the number of replicas to 0. This setting controls the number of copies each primary shard of an index will have. Thus, having 0 replicas effectively disables the replication of shards across nodes, which should increase the indexing performance. This is an important trade-off in terms of reliability and query performance. It is important to remember to set the replicas to a considered value after the initial indexing is complete.

   In our experience, you can expect a 20% decrease in indexing time. After completing indexing in a later step, you can return `refresh` and `number_of_replicas` to their desired settings.

   NOTE: **Note:**
   This step is optional but may help significantly speed up large indexing operations.

   ```shell
   curl --request PUT localhost:9200/gitlab-production/_settings --header 'Content-Type: application/json' --data '{
       "index" : {
           "refresh_interval" : "-1",
           "number_of_replicas" : 0
       } }'
   ```

1. Index projects and their associated data:

   ```shell
   # Omnibus installations
   sudo gitlab-rake gitlab:elastic:index_projects

   # Installations from source
   bundle exec rake gitlab:elastic:index_projects RAILS_ENV=production
   ```

   This enqueues a Sidekiq job for each project that needs to be indexed.
   You can view the jobs in **Admin Area > Monitoring > Background Jobs > Queues Tab**
   and click `elastic_indexer`, or you can query indexing status using a Rake task:

   ```shell
   # Omnibus installations
   sudo gitlab-rake gitlab:elastic:index_projects_status

   # Installations from source
   bundle exec rake gitlab:elastic:index_projects_status RAILS_ENV=production

   Indexing is 65.55% complete (6555/10000 projects)
   ```

   If you want to limit the index to a range of projects you can provide the
   `ID_FROM` and `ID_TO` parameters:

   ```shell
   # Omnibus installations
   sudo gitlab-rake gitlab:elastic:index_projects ID_FROM=1001 ID_TO=2000

   # Installations from source
   bundle exec rake gitlab:elastic:index_projects ID_FROM=1001 ID_TO=2000 RAILS_ENV=production
   ```

   Where `ID_FROM` and `ID_TO` are project IDs. Both parameters are optional.
   The above example will index all projects from ID `1001` up to (and including) ID `2000`.

   TIP: **Troubleshooting:**
   Sometimes the project indexing jobs queued by `gitlab:elastic:index_projects`
   can get interrupted. This may happen for many reasons, but it's always safe
   to run the indexing task again. It will skip repositories that have
   already been indexed.

   As the indexer stores the last commit SHA of every indexed repository in the
   database, you can run the indexer with the special parameter `UPDATE_INDEX` and
   it will check every project repository again to make sure that every commit in
   a repository is indexed, which can be useful in case if your index is outdated:

   ```shell
   # Omnibus installations
   sudo gitlab-rake gitlab:elastic:index_projects UPDATE_INDEX=true ID_TO=1000

   # Installations from source
   bundle exec rake gitlab:elastic:index_projects UPDATE_INDEX=true ID_TO=1000 RAILS_ENV=production
   ```

   You can also use the `gitlab:elastic:clear_index_status` Rake task to force the
   indexer to "forget" all progress, so it will retry the indexing process from the
   start.

1. Personal snippets are not associated with a project and need to be indexed separately:

   ```shell
   # Omnibus installations
   sudo gitlab-rake gitlab:elastic:index_snippets

   # Installations from source
   bundle exec rake gitlab:elastic:index_snippets RAILS_ENV=production
   ```

1. Enable replication and refreshing again after indexing (only if you previously disabled it):

   ```shell
   curl --request PUT localhost:9200/gitlab-production/_settings --header 'Content-Type: application/json' --data '{
       "index" : {
           "number_of_replicas" : 1,
           "refresh_interval" : "1s"
       } }'
   ```

   A force merge should be called after enabling the refreshing above.

   For Elasticsearch 6.x, the index should be in read-only mode before proceeding with the force merge:

   ```shell
   curl --request PUT localhost:9200/gitlab-production/_settings --header 'Content-Type: application/json' --data '{
     "settings": {
       "index.blocks.write": true
     } }'
   ```

   Then, initiate the force merge:

   ```shell
   curl --request POST 'localhost:9200/gitlab-production/_forcemerge?max_num_segments=5'
   ```

   After this, if your index is in read-only mode, switch back to read-write:

   ```shell
   curl --request PUT localhost:9200/gitlab-production/_settings --header 'Content-Type: application/json' --data '{
     "settings": {
       "index.blocks.write": false
     } }'
   ```

GitLab Bot's avatar
GitLab Bot включено в состав коммита
656
1. After the indexing has completed, enable [**Search with Elasticsearch enabled**](#enabling-advanced-search).
GitLab Bot's avatar
GitLab Bot включено в состав коммита
657

Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
658
659
### Deleted documents

GitLab Bot's avatar
GitLab Bot включено в состав коммита
660
Whenever a change or deletion is made to an indexed GitLab object (a merge request description is changed, a file is deleted from the master branch in a repository, a project is deleted, etc), a document in the index is deleted. However, since these are "soft" deletes, the overall number of "deleted documents", and therefore wasted space, increases. Elasticsearch does intelligent merging of segments in order to remove these deleted documents. However, depending on the amount and type of activity in your GitLab installation, it's possible to see as much as 50% wasted space in the index.
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
661

Evan Read's avatar
Evan Read включено в состав коммита
662
In general, we recommend simply letting Elasticsearch merge and reclaim space automatically, with the default settings. From [Lucene's Handling of Deleted Documents](https://www.elastic.co/blog/lucenes-handling-of-deleted-documents "Lucene's Handling of Deleted Documents"), _"Overall, besides perhaps decreasing the maximum segment size, it is best to leave Lucene's defaults as-is and not fret too much about when deletes are reclaimed."_
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
663

Evan Read's avatar
Evan Read включено в состав коммита
664
However, some larger installations may wish to tune the merge policy settings:
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
665

GitLab Bot's avatar
GitLab Bot включено в состав коммита
666
- Consider reducing the `index.merge.policy.max_merged_segment` size from the default 5 GB to maybe 2 GB or 3 GB. Merging only happens when a segment has at least 50% deletions. Smaller segment sizes will allow merging to happen more frequently.
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
667

GitLab Bot's avatar
GitLab Bot включено в состав коммита
668
  ```shell
GitLab Bot's avatar
GitLab Bot включено в состав коммита
669
  curl --request PUT localhost:9200/gitlab-production/_settings ---header 'Content-Type: application/json' --data '{
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
670
671
672
673
674
675
    "index" : {
      "merge.policy.max_merged_segment": "2gb"
    }
  }'
  ```

GitLab Bot's avatar
GitLab Bot включено в состав коммита
676
- You can also adjust `index.merge.policy.reclaim_deletes_weight`, which controls how aggressively deletions are targeted. But this can lead to costly merge decisions, so we recommend not changing this unless you understand the tradeoffs.
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
677

GitLab Bot's avatar
GitLab Bot включено в состав коммита
678
  ```shell
GitLab Bot's avatar
GitLab Bot включено в состав коммита
679
  curl --request PUT localhost:9200/gitlab-production/_settings ---header 'Content-Type: application/json' --data '{
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
680
681
682
683
684
685
    "index" : {
      "merge.policy.reclaim_deletes_weight": "3.0"
    }
  }'
  ```

GitLab Bot's avatar
GitLab Bot включено в состав коммита
686
- Do not do a [force merge](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-forcemerge.html "Force Merge") to remove deleted documents. A warning in the [documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-forcemerge.html "Force Merge") states that this can lead to very large segments that may never get reclaimed, and can also cause significant performance or availability issues.
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
687
688
689

## Troubleshooting

GitLab Bot's avatar
GitLab Bot включено в состав коммита
690
691
692
Here are some common pitfalls and how to overcome them.

### How can I verify that my GitLab instance is using Elasticsearch?
GitLab Bot's avatar
GitLab Bot включено в состав коммита
693

GitLab Bot's avatar
GitLab Bot включено в состав коммита
694
There are a couple of ways to achieve that:
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
695

GitLab Bot's avatar
GitLab Bot включено в состав коммита
696
697
698
699
- Whenever you perform a search there will be a link on the search results page
  in the top right hand corner saying "Advanced search functionality is enabled".
  This is always correctly identifying whether the current project/namespace
  being searched is using Elasticsearch.
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
700

GitLab Bot's avatar
GitLab Bot включено в состав коммита
701
702
703
704
- From the admin area under **Settings > General > Elasticsearch** check that the
  Advanced Search settings are checked.

  Those same settings there can be obtained from the Rails console if necessary:
Evan Read's avatar
Evan Read включено в состав коммита
705

Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
706
  ```ruby
GitLab Bot's avatar
GitLab Bot включено в состав коммита
707
708
709
  ::Gitlab::CurrentSettings.elasticsearch_search?         # Whether or not searches will use Elasticsearch
  ::Gitlab::CurrentSettings.elasticsearch_indexing?       # Whether or not content will be indexed in Elasticsearch
  ::Gitlab::CurrentSettings.elasticsearch_limit_indexing? # Whether or not Elasticsearch is limited only to certain projects/namespaces
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
710
  ```
Evan Read's avatar
Evan Read включено в состав коммита
711

GitLab Bot's avatar
GitLab Bot включено в состав коммита
712
713
714
- If Elasticsearch is limited to specific namespaces and you need to know if
  Elasticsearch is being used for a specific project or namespace, you can use
  the Rails console:
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
715

GitLab Bot's avatar
GitLab Bot включено в состав коммита
716
717
718
719
  ```ruby
  ::Gitlab::CurrentSettings.search_using_elasticsearch?(scope: Namespace.find_by_full_path("/my-namespace"))
  ::Gitlab::CurrentSettings.search_using_elasticsearch?(scope: Project.find_by_full_path("/my-namespace/my-project"))
  ```
GitLab Bot's avatar
GitLab Bot включено в состав коммита
720

GitLab Bot's avatar
GitLab Bot включено в состав коммита
721
### I updated GitLab and now I can't find anything
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
722

GitLab Bot's avatar
GitLab Bot включено в состав коммита
723
724
725
We continuously make updates to our indexing strategies and aim to support
newer versions of Elasticsearch. When indexing changes are made, it may
be necessary for you to [reindex](#zero-downtime-reindexing) after updating GitLab.
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
726

GitLab Bot's avatar
GitLab Bot включено в состав коммита
727
### I indexed all the repositories but I can't get any hits for my search term in the UI
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
728

GitLab Bot's avatar
GitLab Bot включено в состав коммита
729
Make sure you indexed all the database data [as stated above](#enabling-advanced-search).
Evan Read's avatar
Evan Read включено в состав коммита
730

GitLab Bot's avatar
GitLab Bot включено в состав коммита
731
If there aren't any results (hits) in the UI search, check if you are seeing the same results via the rails console (`sudo gitlab-rails console`):
Evan Read's avatar
Evan Read включено в состав коммита
732

GitLab Bot's avatar
GitLab Bot включено в состав коммита
733
734
735
736
737
```ruby
u = User.find_by_username('your-username')
s = SearchService.new(u, {:search => 'search_term', :scope => 'blobs'})
pp s.search_objects.to_a
```
Evan Read's avatar
Evan Read включено в состав коммита
738

GitLab Bot's avatar
GitLab Bot включено в состав коммита
739
Beyond that, check via the [Elasticsearch Search API](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-search.html) to see if the data shows up on the Elasticsearch side:
Evan Read's avatar
Evan Read включено в состав коммита
740

GitLab Bot's avatar
GitLab Bot включено в состав коммита
741
742
743
```shell
curl --request GET <elasticsearch_server_ip>:9200/gitlab-production/_search?q=<search_term>
```
GitLab Bot's avatar
GitLab Bot включено в состав коммита
744

GitLab Bot's avatar
GitLab Bot включено в состав коммита
745
More [complex Elasticsearch API calls](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html) are also possible.
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
746

GitLab Bot's avatar
GitLab Bot включено в состав коммита
747
It is important to understand at which level the problem is manifesting (UI, Rails code, Elasticsearch side) to be able to [troubleshoot further](../administration/troubleshooting/elasticsearch.md#search-results-workflow).
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
748

GitLab Bot's avatar
GitLab Bot включено в состав коммита
749
750
NOTE: **Note:**
The above instructions are not to be used for scenarios that only index a [subset of namespaces](#limiting-namespaces-and-projects).
Evan Read's avatar
Evan Read включено в состав коммита
751

GitLab Bot's avatar
GitLab Bot включено в состав коммита
752
See [Elasticsearch Index Scopes](#advanced-search-index-scopes) for more information on searching for specific types of data.
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
753

GitLab Bot's avatar
GitLab Bot включено в состав коммита
754
### I indexed all the repositories but then switched Elasticsearch servers and now I can't find anything
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
755

GitLab Bot's avatar
GitLab Bot включено в состав коммита
756
You will need to re-run all the Rake tasks to reindex the database, repositories, and wikis.
Blair Lunceford's avatar
Blair Lunceford включено в состав коммита
757

GitLab Bot's avatar
GitLab Bot включено в состав коммита
758
### The indexing process is taking a very long time
Blair Lunceford's avatar
Blair Lunceford включено в состав коммита
759

GitLab Bot's avatar
GitLab Bot включено в состав коммита
760
The more data present in your GitLab instance, the longer the indexing process takes.
GitLab Bot's avatar
GitLab Bot включено в состав коммита
761

GitLab Bot's avatar
GitLab Bot включено в состав коммита
762
### There are some projects that weren't indexed, but I don't know which ones
GitLab Bot's avatar
GitLab Bot включено в состав коммита
763

GitLab Bot's avatar
GitLab Bot включено в состав коммита
764
You can run `sudo gitlab-rake gitlab:elastic:projects_not_indexed` to display projects that aren't indexed.
GitLab Bot's avatar
GitLab Bot включено в состав коммита
765

GitLab Bot's avatar
GitLab Bot включено в состав коммита
766
### No new data is added to the Elasticsearch index when I push code
GitLab Bot's avatar
GitLab Bot включено в состав коммита
767

GitLab Bot's avatar
GitLab Bot включено в состав коммита
768
769
NOTE: **Note:**
This was [fixed in GitLab 13.2](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/35936) and the Rake task is not available for versions greater than that.
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
770

GitLab Bot's avatar
GitLab Bot включено в состав коммита
771
When performing the initial indexing of blobs, we lock all projects until the project finishes indexing. It could happen that an error during the process causes one or multiple projects to remain locked. In order to unlock them, run:
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
772

GitLab Bot's avatar
GitLab Bot включено в состав коммита
773
774
775
```shell
sudo gitlab-rake gitlab:elastic:clear_locked_projects
```
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
776

GitLab Bot's avatar
GitLab Bot включено в состав коммита
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
### `Can't specify parent if no parent field has been configured` error

If you enabled Elasticsearch before GitLab 8.12 and have not rebuilt indexes you will get
exception in lots of different cases:

```plaintext
Elasticsearch::Transport::Transport::Errors::BadRequest([400] {
    "error": {
        "root_cause": [{
            "type": "illegal_argument_exception",
            "reason": "Can't specify parent if no parent field has been configured"
        }],
        "type": "illegal_argument_exception",
        "reason": "Can't specify parent if no parent field has been configured"
    },
    "status": 400
}):
```

This is because we changed the index mapping in GitLab 8.12 and the old indexes should be removed and built from scratch again,
see details in the [update guide](../update/upgrading_from_source.md).
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
798
799
800

- Exception `Elasticsearch::Transport::Transport::Errors::BadRequest`

Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
801
802
  If you have this exception (just like in the case above but the actual message is different) please check if you have the correct Elasticsearch version and you met the other [requirements](#system-requirements).
  There is also an easy way to check it automatically with `sudo gitlab-rake gitlab:check` command.
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
803
804
805

- Exception `Elasticsearch::Transport::Transport::Errors::RequestEntityTooLarge`

GitLab Bot's avatar
GitLab Bot включено в состав коммита
806
  ```plaintext
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
807
808
  [413] {"Message":"Request size exceeded 10485760 bytes"}
  ```
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
809

Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
810
811
812
813
  This exception is seen when your Elasticsearch cluster is configured to reject
  requests above a certain size (10MiB in this case). This corresponds to the
  `http.max_content_length` setting in `elasticsearch.yml`. Increase it to a
  larger size and restart your Elasticsearch cluster.
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
814

GitLab Bot's avatar
GitLab Bot включено в состав коммита
815
  AWS has [fixed limits](https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/aes-limits.html)
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
816
817
  for this setting ("Maximum Size of HTTP Request Payloads"), based on the size of
  the underlying instance.
GitLab Bot's avatar
GitLab Bot включено в состав коммита
818

GitLab Bot's avatar
GitLab Bot включено в состав коммита
819
### My single node Elasticsearch cluster status never goes from `yellow` to `green` even though everything seems to be running properly
GitLab Bot's avatar
GitLab Bot включено в состав коммита
820

GitLab Bot's avatar
GitLab Bot включено в состав коммита
821
**For a single node Elasticsearch cluster the functional cluster health status will be yellow** (never green) because the primary shard is allocated but replicas cannot be as there is no other node to which Elasticsearch can assign a replica. This also applies if you are using the [Amazon Elasticsearch](https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/aes-handling-errors.html#aes-handling-errors-yellow-cluster-status) service.
GitLab Bot's avatar
GitLab Bot включено в состав коммита
822

GitLab Bot's avatar
GitLab Bot включено в состав коммита
823
824
CAUTION: **Warning:**
Setting the number of replicas to `0` is discouraged (this is not allowed in the GitLab Elasticsearch Integration menu). If you are planning to add more Elasticsearch nodes (for a total of more than 1 Elasticsearch) the number of replicas will need to be set to an integer value larger than `0`. Failure to do so will result in lack of redundancy (losing one node will corrupt the index).
GitLab Bot's avatar
GitLab Bot включено в состав коммита
825

GitLab Bot's avatar
GitLab Bot включено в состав коммита
826
If you have a **hard requirement to have a green status for your single node Elasticsearch cluster**, please make sure you understand the risks outlined in the previous paragraph and then run the following query to set the number of replicas to `0`(the cluster will no longer try to create any shard replicas):
GitLab Bot's avatar
GitLab Bot включено в состав коммита
827

GitLab Bot's avatar
GitLab Bot включено в состав коммита
828
829
830
831
832
833
834
```shell
curl --request PUT localhost:9200/gitlab-production/_settings --header 'Content-Type: application/json' --data '{
"index" : {
   "number_of_replicas" : 0
  }
}'
```
GitLab Bot's avatar
GitLab Bot включено в состав коммита
835

GitLab Bot's avatar
GitLab Bot включено в состав коммита
836
### `health check timeout: no Elasticsearch node available` error in Sidekiq
GitLab Bot's avatar
GitLab Bot включено в состав коммита
837

GitLab Bot's avatar
GitLab Bot включено в состав коммита
838
839
840
841
842
If you're getting a `health check timeout: no Elasticsearch node available` error in Sidekiq during the indexing process:

```plaintext
Gitlab::Elastic::Indexer::Error: time="2020-01-23T09:13:00Z" level=fatal msg="health check timeout: no Elasticsearch node available"
```
GitLab Bot's avatar
GitLab Bot включено в состав коммита
843

GitLab Bot's avatar
GitLab Bot включено в состав коммита
844
845
You probably have not used either `http://` or `https://` as part of your value in the **"URL"** field of the Elasticsearch Integration Menu. Please make sure you are using either `http://` or `https://` in this field as the [Elasticsearch client for Go](https://github.com/olivere/elastic) that we are using [needs the prefix for the URL to be accepted as valid](https://github.com/olivere/elastic/commit/a80af35aa41856dc2c986204e2b64eab81ccac3a).
Once you have corrected the formatting of the URL, delete the index (via the [dedicated Rake task](#gitlab-advanced-search-rake-tasks)) and [reindex the content of your instance](#enabling-advanced-search).
GitLab Bot's avatar
GitLab Bot включено в состав коммита
846

GitLab Bot's avatar
GitLab Bot включено в состав коммита
847
### Low-level troubleshooting
GitLab Bot's avatar
GitLab Bot включено в состав коммита
848

GitLab Bot's avatar
GitLab Bot включено в состав коммита
849
There is a [more structured, lower-level troubleshooting document](../administration/troubleshooting/elasticsearch.md) for when you experience other issues, including poor performance.
GitLab Bot's avatar
GitLab Bot включено в состав коммита
850

GitLab Bot's avatar
GitLab Bot включено в состав коммита
851
### Known issues
GitLab Bot's avatar
GitLab Bot включено в состав коммита
852

GitLab Bot's avatar
GitLab Bot включено в состав коммита
853
[Elasticsearch `code_analyzer` doesn't account for all code cases](https://gitlab.com/groups/gitlab-org/-/epics/3621).
GitLab Bot's avatar
GitLab Bot включено в состав коммита
854

GitLab Bot's avatar
GitLab Bot включено в состав коммита
855
The `code_analyzer` pattern and filter configuration is being evaluated for improvement. We have fixed [most edge cases](https://gitlab.com/groups/gitlab-org/-/epics/3621#note_363429094) that were not returning expected search results due to our pattern and filter configuration.
GitLab Bot's avatar
GitLab Bot включено в состав коммита
856

GitLab Bot's avatar
GitLab Bot включено в состав коммита
857
Improvements to the `code_analyzer` pattern and filters are being discussed in [epic 3621](https://gitlab.com/groups/gitlab-org/-/epics/3621).
GitLab Bot's avatar
GitLab Bot включено в состав коммита
858

GitLab Bot's avatar
GitLab Bot включено в состав коммита
859
### Reverting to Basic Search
GitLab Bot's avatar
GitLab Bot включено в состав коммита
860
861
862
863

Sometimes there may be issues with your Elasticsearch index data and as such
GitLab will allow you to revert to "basic search" when there are no search
results and assuming that basic search is supported in that scope. This "basic
GitLab Bot's avatar
GitLab Bot включено в состав коммита
864
search" will behave as though you don't have Advanced Search enabled at all for
GitLab Bot's avatar
GitLab Bot включено в состав коммита
865
your instance and search using other data sources (ie. PostgreSQL data and Git
GitLab Bot's avatar
GitLab Bot включено в состав коммита
866
data).