Commit cc9fbb37 authored by Achilleas Pipinellis's avatar Achilleas Pipinellis

Add section for Advanced Search in reference architectures

Link to the Elasticsearch integration docs
parent 3c49dc64
...@@ -66,6 +66,8 @@ To set up GitLab and its components to accommodate up to 10,000 users: ...@@ -66,6 +66,8 @@ To set up GitLab and its components to accommodate up to 10,000 users:
1. [Configure Prometheus](#configure-prometheus) to monitor your GitLab environment. 1. [Configure Prometheus](#configure-prometheus) to monitor your GitLab environment.
1. [Configure the Object Storage](#configure-the-object-storage) 1. [Configure the Object Storage](#configure-the-object-storage)
used for shared data objects. used for shared data objects.
1. [Configure Advanced Search (optional)](#configure-advanced-search) for faster,
more advanced code search across your entire GitLab instance.
1. [Configure NFS (Optional)](#configure-nfs-optional) 1. [Configure NFS (Optional)](#configure-nfs-optional)
to have shared disk storage service as an alternative to Gitaly and/or Object Storage (although to have shared disk storage service as an alternative to Gitaly and/or Object Storage (although
not recommended). NFS is required for GitLab Pages, you can skip this step if you're not using not recommended). NFS is required for GitLab Pages, you can skip this step if you're not using
...@@ -2025,6 +2027,25 @@ work. ...@@ -2025,6 +2027,25 @@ work.
</a> </a>
</div> </div>
## Configure Advanced Search **(STARTER ONLY)**
NOTE: **Note:**
Elasticsearch cluster design and requirements are dependent on your specific data.
For recommended best practices on how to set up your Elasticsearch cluster
alongside your instance, read how to
[choose the optimal cluster configuration](../../integration/elasticsearch.md#guidance-on-choosing-optimal-cluster-configuration).
You can leverage Elasticsearch and enable Advanced Search for faster, more
advanced code search across your entire GitLab instance.
[Learn how to set it up.](../../integration/elasticsearch.md)
<div align="right">
<a type="button" class="btn btn-default" href="#setup-components">
Back to setup components <i class="fa fa-angle-double-up" aria-hidden="true"></i>
</a>
</div>
## Configure NFS (optional) ## Configure NFS (optional)
[Object storage](#configure-the-object-storage), along with [Gitaly](#configure-gitaly) [Object storage](#configure-the-object-storage), along with [Gitaly](#configure-gitaly)
......
...@@ -47,3 +47,16 @@ You can also optionally configure GitLab to use an ...@@ -47,3 +47,16 @@ You can also optionally configure GitLab to use an
[external PostgreSQL service](../postgresql/external.md) or an [external PostgreSQL service](../postgresql/external.md) or an
[external object storage service](../high_availability/object_storage.md) for [external object storage service](../high_availability/object_storage.md) for
added performance and reliability at a reduced complexity cost. added performance and reliability at a reduced complexity cost.
## Configure Advanced Search **(STARTER ONLY)**
NOTE: **Note:**
Elasticsearch cluster design and requirements are dependent on your specific data.
For recommended best practices on how to set up your Elasticsearch cluster
alongside your instance, read how to
[choose the optimal cluster configuration](../../integration/elasticsearch.md#guidance-on-choosing-optimal-cluster-configuration).
You can leverage Elasticsearch and enable Advanced Search for faster, more
advanced code search across your entire GitLab instance.
[Learn how to set it up.](../../integration/elasticsearch.md)
...@@ -66,6 +66,8 @@ To set up GitLab and its components to accommodate up to 25,000 users: ...@@ -66,6 +66,8 @@ To set up GitLab and its components to accommodate up to 25,000 users:
1. [Configure Prometheus](#configure-prometheus) to monitor your GitLab environment. 1. [Configure Prometheus](#configure-prometheus) to monitor your GitLab environment.
1. [Configure the Object Storage](#configure-the-object-storage) 1. [Configure the Object Storage](#configure-the-object-storage)
used for shared data objects. used for shared data objects.
1. [Configure Advanced Search (optional)](#configure-advanced-search) for faster,
more advanced code search across your entire GitLab instance.
1. [Configure NFS (Optional)](#configure-nfs-optional) 1. [Configure NFS (Optional)](#configure-nfs-optional)
to have shared disk storage service as an alternative to Gitaly and/or Object Storage (although to have shared disk storage service as an alternative to Gitaly and/or Object Storage (although
not recommended). NFS is required for GitLab Pages, you can skip this step if you're not using not recommended). NFS is required for GitLab Pages, you can skip this step if you're not using
...@@ -2025,6 +2027,25 @@ work. ...@@ -2025,6 +2027,25 @@ work.
</a> </a>
</div> </div>
## Configure Advanced Search **(STARTER ONLY)**
NOTE: **Note:**
Elasticsearch cluster design and requirements are dependent on your specific data.
For recommended best practices on how to set up your Elasticsearch cluster
alongside your instance, read how to
[choose the optimal cluster configuration](../../integration/elasticsearch.md#guidance-on-choosing-optimal-cluster-configuration).
You can leverage Elasticsearch and enable Advanced Search for faster, more
advanced code search across your entire GitLab instance.
[Learn how to set it up.](../../integration/elasticsearch.md)
<div align="right">
<a type="button" class="btn btn-default" href="#setup-components">
Back to setup components <i class="fa fa-angle-double-up" aria-hidden="true"></i>
</a>
</div>
## Configure NFS (optional) ## Configure NFS (optional)
[Object storage](#configure-the-object-storage), along with [Gitaly](#configure-gitaly) [Object storage](#configure-the-object-storage), along with [Gitaly](#configure-gitaly)
......
...@@ -55,6 +55,8 @@ To set up GitLab and its components to accommodate up to 2,000 users: ...@@ -55,6 +55,8 @@ To set up GitLab and its components to accommodate up to 2,000 users:
environment. environment.
1. [Configure the object storage](#configure-the-object-storage) used for 1. [Configure the object storage](#configure-the-object-storage) used for
shared data objects. shared data objects.
1. [Configure Advanced Search (optional)](#configure-advanced-search) for faster,
more advanced code search across your entire GitLab instance.
1. [Configure NFS](#configure-nfs-optional) (optional, and not recommended) 1. [Configure NFS](#configure-nfs-optional) (optional, and not recommended)
to have shared disk storage service as an alternative to Gitaly or object to have shared disk storage service as an alternative to Gitaly or object
storage. You can skip this step if you're not using GitLab Pages (which storage. You can skip this step if you're not using GitLab Pages (which
...@@ -843,6 +845,25 @@ functioning backups is encountered. ...@@ -843,6 +845,25 @@ functioning backups is encountered.
</a> </a>
</div> </div>
## Configure Advanced Search **(STARTER ONLY)**
NOTE: **Note:**
Elasticsearch cluster design and requirements are dependent on your specific data.
For recommended best practices on how to set up your Elasticsearch cluster
alongside your instance, read how to
[choose the optimal cluster configuration](../../integration/elasticsearch.md#guidance-on-choosing-optimal-cluster-configuration).
You can leverage Elasticsearch and enable Advanced Search for faster, more
advanced code search across your entire GitLab instance.
[Learn how to set it up.](../../integration/elasticsearch.md)
<div align="right">
<a type="button" class="btn btn-default" href="#setup-components">
Back to setup components <i class="fa fa-angle-double-up" aria-hidden="true"></i>
</a>
</div>
## Configure NFS (optional) ## Configure NFS (optional)
For improved performance, [object storage](#configure-the-object-storage), For improved performance, [object storage](#configure-the-object-storage),
......
...@@ -70,6 +70,8 @@ To set up GitLab and its components to accommodate up to 3,000 users: ...@@ -70,6 +70,8 @@ To set up GitLab and its components to accommodate up to 3,000 users:
1. [Configure Prometheus](#configure-prometheus) to monitor your GitLab environment. 1. [Configure Prometheus](#configure-prometheus) to monitor your GitLab environment.
1. [Configure the Object Storage](#configure-the-object-storage) 1. [Configure the Object Storage](#configure-the-object-storage)
used for shared data objects. used for shared data objects.
1. [Configure Advanced Search (optional)](#configure-advanced-search) for faster,
more advanced code search across your entire GitLab instance.
1. [Configure NFS (Optional)](#configure-nfs-optional) 1. [Configure NFS (Optional)](#configure-nfs-optional)
to have shared disk storage service as an alternative to Gitaly and/or Object Storage (although to have shared disk storage service as an alternative to Gitaly and/or Object Storage (although
not recommended). NFS is required for GitLab Pages, you can skip this step if you're not using not recommended). NFS is required for GitLab Pages, you can skip this step if you're not using
...@@ -1751,6 +1753,25 @@ work. ...@@ -1751,6 +1753,25 @@ work.
</a> </a>
</div> </div>
## Configure Advanced Search **(STARTER ONLY)**
NOTE: **Note:**
Elasticsearch cluster design and requirements are dependent on your specific data.
For recommended best practices on how to set up your Elasticsearch cluster
alongside your instance, read how to
[choose the optimal cluster configuration](../../integration/elasticsearch.md#guidance-on-choosing-optimal-cluster-configuration).
You can leverage Elasticsearch and enable Advanced Search for faster, more
advanced code search across your entire GitLab instance.
[Learn how to set it up.](../../integration/elasticsearch.md)
<div align="right">
<a type="button" class="btn btn-default" href="#setup-components">
Back to setup components <i class="fa fa-angle-double-up" aria-hidden="true"></i>
</a>
</div>
## Configure NFS (optional) ## Configure NFS (optional)
[Object storage](#configure-the-object-storage), along with [Gitaly](#configure-gitaly) [Object storage](#configure-the-object-storage), along with [Gitaly](#configure-gitaly)
......
...@@ -66,6 +66,8 @@ To set up GitLab and its components to accommodate up to 50,000 users: ...@@ -66,6 +66,8 @@ To set up GitLab and its components to accommodate up to 50,000 users:
1. [Configure Prometheus](#configure-prometheus) to monitor your GitLab environment. 1. [Configure Prometheus](#configure-prometheus) to monitor your GitLab environment.
1. [Configure the Object Storage](#configure-the-object-storage) 1. [Configure the Object Storage](#configure-the-object-storage)
used for shared data objects. used for shared data objects.
1. [Configure Advanced Search (optional)](#configure-advanced-search) for faster,
more advanced code search across your entire GitLab instance.
1. [Configure NFS (Optional)](#configure-nfs-optional) 1. [Configure NFS (Optional)](#configure-nfs-optional)
to have shared disk storage service as an alternative to Gitaly and/or Object Storage (although to have shared disk storage service as an alternative to Gitaly and/or Object Storage (although
not recommended). NFS is required for GitLab Pages, you can skip this step if you're not using not recommended). NFS is required for GitLab Pages, you can skip this step if you're not using
...@@ -2025,6 +2027,25 @@ work. ...@@ -2025,6 +2027,25 @@ work.
</a> </a>
</div> </div>
## Configure Advanced Search **(STARTER ONLY)**
NOTE: **Note:**
Elasticsearch cluster design and requirements are dependent on your specific data.
For recommended best practices on how to set up your Elasticsearch cluster
alongside your instance, read how to
[choose the optimal cluster configuration](../../integration/elasticsearch.md#guidance-on-choosing-optimal-cluster-configuration).
You can leverage Elasticsearch and enable Advanced Search for faster, more
advanced code search across your entire GitLab instance.
[Learn how to set it up.](../../integration/elasticsearch.md)
<div align="right">
<a type="button" class="btn btn-default" href="#setup-components">
Back to setup components <i class="fa fa-angle-double-up" aria-hidden="true"></i>
</a>
</div>
## Configure NFS (optional) ## Configure NFS (optional)
[Object storage](#configure-the-object-storage), along with [Gitaly](#configure-gitaly) [Object storage](#configure-the-object-storage), along with [Gitaly](#configure-gitaly)
......
...@@ -70,6 +70,8 @@ To set up GitLab and its components to accommodate up to 5,000 users: ...@@ -70,6 +70,8 @@ To set up GitLab and its components to accommodate up to 5,000 users:
1. [Configure Prometheus](#configure-prometheus) to monitor your GitLab environment. 1. [Configure Prometheus](#configure-prometheus) to monitor your GitLab environment.
1. [Configure the Object Storage](#configure-the-object-storage) 1. [Configure the Object Storage](#configure-the-object-storage)
used for shared data objects. used for shared data objects.
1. [Configure Advanced Search (optional)](#configure-advanced-search) for faster,
more advanced code search across your entire GitLab instance.
1. [Configure NFS (Optional)](#configure-nfs-optional) 1. [Configure NFS (Optional)](#configure-nfs-optional)
to have shared disk storage service as an alternative to Gitaly and/or Object Storage (although to have shared disk storage service as an alternative to Gitaly and/or Object Storage (although
not recommended). NFS is required for GitLab Pages, you can skip this step if you're not using not recommended). NFS is required for GitLab Pages, you can skip this step if you're not using
...@@ -1750,6 +1752,25 @@ work. ...@@ -1750,6 +1752,25 @@ work.
</a> </a>
</div> </div>
## Configure Advanced Search **(STARTER ONLY)**
NOTE: **Note:**
Elasticsearch cluster design and requirements are dependent on your specific data.
For recommended best practices on how to set up your Elasticsearch cluster
alongside your instance, read how to
[choose the optimal cluster configuration](../../integration/elasticsearch.md#guidance-on-choosing-optimal-cluster-configuration).
You can leverage Elasticsearch and enable Advanced Search for faster, more
advanced code search across your entire GitLab instance.
[Learn how to set it up.](../../integration/elasticsearch.md)
<div align="right">
<a type="button" class="btn btn-default" href="#setup-components">
Back to setup components <i class="fa fa-angle-double-up" aria-hidden="true"></i>
</a>
</div>
## Configure NFS (optional) ## Configure NFS (optional)
[Object storage](#configure-the-object-storage), along with [Gitaly](#configure-gitaly) [Object storage](#configure-the-object-storage), along with [Gitaly](#configure-gitaly)
......
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