Commit 408b25e6 authored by Evan Read's avatar Evan Read

Merge branch 'docs-es-omnibus' into 'master'

Make it more clear that ES search indexer is included in Omnibus

See merge request gitlab-org/gitlab!25589
parents a01fb250 21eabf00
...@@ -47,24 +47,26 @@ updated automatically. ...@@ -47,24 +47,26 @@ updated automatically.
For indexing Git repository data, GitLab uses an [indexer written in Go](https://gitlab.com/gitlab-org/gitlab-elasticsearch-indexer). For indexing Git repository data, GitLab uses an [indexer written in Go](https://gitlab.com/gitlab-org/gitlab-elasticsearch-indexer).
The way you install the Go indexer depends on your version of GitLab:
- For GitLab Omnibus 11.8 and above, see [GitLab Omnibus](#gitlab-omnibus).
- For older versions of GitLab, install the indexer [From Source](#from-source).
### GitLab Omnibus
The Go indexer was included in Omnibus GitLab 11.8 as an optional replacement to a The Go indexer was included in Omnibus GitLab 11.8 as an optional replacement to a
Ruby-based indexer. [Since GitLab v12.3](https://gitlab.com/gitlab-org/gitlab/issues/6481), Ruby-based indexer. [Since GitLab v12.3](https://gitlab.com/gitlab-org/gitlab/issues/6481),
all indexing is done by the Go indexer, and the Ruby indexer is removed.
If you would like to use the Elasticsearch Go indexer with a source installation or an older version of GitLab, please follow the instructions below. ### From source
### Installation
First, we need to install some dependencies, then we'll build and install First, we need to install some dependencies, then we'll build and install
the indexer itself. the indexer itself.
#### Dependencies
This project relies on [ICU](http://site.icu-project.org/) for text encoding, 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 therefore we need to ensure the development packages for your platform are
installed before running `make`. installed before running `make`.
##### Debian / Ubuntu #### Debian / Ubuntu
To install on Debian or Ubuntu, run: To install on Debian or Ubuntu, run:
...@@ -72,7 +74,7 @@ To install on Debian or Ubuntu, run: ...@@ -72,7 +74,7 @@ To install on Debian or Ubuntu, run:
sudo apt install libicu-dev sudo apt install libicu-dev
``` ```
##### CentOS / RHEL #### CentOS / RHEL
To install on CentOS or RHEL, run: To install on CentOS or RHEL, run:
...@@ -89,7 +91,7 @@ brew install icu4c ...@@ -89,7 +91,7 @@ brew install icu4c
export PKG_CONFIG_PATH="/usr/local/opt/icu4c/lib/pkgconfig:$PKG_CONFIG_PATH" export PKG_CONFIG_PATH="/usr/local/opt/icu4c/lib/pkgconfig:$PKG_CONFIG_PATH"
``` ```
#### Building and installing ### Building and installing
To build and install the indexer, run: To build and install the indexer, run:
...@@ -622,7 +624,7 @@ Here are some common pitfalls and how to overcome them: ...@@ -622,7 +624,7 @@ Here are some common pitfalls and how to overcome them:
``` ```
You probably have not used either `http://` or `https://` as part of your value in the **"URL"** field of the Elasticseach 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 acceped as valid](https://github.com/olivere/elastic/commit/a80af35aa41856dc2c986204e2b64eab81ccac3a). You probably have not used either `http://` or `https://` as part of your value in the **"URL"** field of the Elasticseach 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 acceped as valid](https://github.com/olivere/elastic/commit/a80af35aa41856dc2c986204e2b64eab81ccac3a).
Once you have corrected the formatting of the URL please delete the index (via the [dedicated rake task](#gitlab-elasticsearch-rake-tasks)) and [index the content of your intance](#adding-gitlabs-data-to-the-elasticsearch-index) once more. Once you have corrected the formatting of the URL, delete the index (via the [dedicated rake task](#gitlab-elasticsearch-rake-tasks)) and [reindex the content of your instance](#adding-gitlabs-data-to-the-elasticsearch-index).
### Reverting to basic search ### Reverting to basic search
......
...@@ -96,7 +96,7 @@ sudo -u git -H make ...@@ -96,7 +96,7 @@ sudo -u git -H make
### 8. Install/Update `gitlab-elasticsearch-indexer` **(STARTER ONLY)** ### 8. Install/Update `gitlab-elasticsearch-indexer` **(STARTER ONLY)**
Please follow the [install instruction](../integration/elasticsearch.md#installation). Please follow the [install instruction](../integration/elasticsearch.md#installing-elasticsearch).
### 9. Start application ### 9. Start application
......
...@@ -79,7 +79,7 @@ sudo -u git -H bundle exec rake cache:clear RAILS_ENV=production ...@@ -79,7 +79,7 @@ sudo -u git -H bundle exec rake cache:clear RAILS_ENV=production
### 4. Install `gitlab-elasticsearch-indexer` **(STARTER ONLY)** ### 4. Install `gitlab-elasticsearch-indexer` **(STARTER ONLY)**
Please follow the [install instruction](../integration/elasticsearch.md#installation). Please follow the [install instruction](../integration/elasticsearch.md#installing-elasticsearch).
### 5. Start application ### 5. Start application
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment