Page MenuHomePhabricator
Differential D17602 Diff 42336 src/docs/user/cluster/cluster_search.diviner

Changeset View

Standalone View

View Options

src/docs/user/cluster/cluster_search.diviner

@title Cluster: Search @title Cluster: Search
@group cluster @group cluster
Overview Overview
======== ========
You can configure phabricator to connect to one or more fulltext search clusters You can configure Phabricator to connect to one or more fulltext search
running either Elasticsearch or MySQL. By default and without further services.
configuration, Phabricator will use MySQL for fulltext search. This will be
adequate for the vast majority of users. Installs with a very large number of By default, Phabricator will use MySQL for fulltext search. This is suitable
objects or specialized search needs can consider enabling Elasticsearch for for most installs. However, alternate engines are supported.
better scalability and potentially better search results.
Configuring Search Services Configuring Search Services
=========================== ===========================
To configure an Elasticsearch service, use the `cluster.search` configuration To configure search services, adjust the `cluster.search` configuration
option. A typical Elasticsearch configuration will probably look similar to option. This option contains a list of one or more fulltext search services,
the following example: like this:
```lang=json ```lang=json
[
{ {
"cluster.search": [ "type": "...",
"hosts": [
...
],
"roles": {
"read": true,
"write": true
}
}
]
```
When a user makes a change to a document, Phabricator writes the updated
document into every configured, writable fulltext service.
When a user issues a query, Phabricator tries configured, readable services
in order until it is able to execute the query successfully.
These options are supported by all service types:
| Key | Description |
|---|---|
| `type` | Constant identifying the service type, like `mysql`.
| `roles` | Dictionary of role settings, for enabling reads and writes.
| `hosts` | List of hosts for this service.
Some service types support additional options.
Available Service Types
=======================
These service types are supported:
| Service | Key | Description |
|---|---|---|
| MySQL | `mysql` | Default MySQL fulltext index.
| Elasticsearch | `elasticsearch` | Use an external Elasticsearch service
Fulltext Service Roles
======================
These roles are supported:
| Role | Key | Description
|---|---|---|
| Read | `read` | Allows the service to be queried when users search.
| Write | `write` | Allows documents to be published to the service.
Specifying Hosts
================
The `hosts` key should contain a list of dictionaries, each specifying the
details of a host. A service should normally have one or more hosts.
When an option is set at the service level, it serves as a default for all
hosts. It may be overridden by changing the value for a particular host.
Service Type: MySQL
==============
The `mysql` service type does not require any configuration, and does not
need to have hosts specified. This service uses the builtin database to
index and search documents.
A typical `mysql` service configuration looks like this:
```lang=json
{
"type": "mysql"
}
```
Service Type: Elasticsearch
======================
The `elasticsearch` sevice type supports these options:
| Key | Description |
|---|---|
| `protocol` | Either `"http"` (default) or `"https"`.
| `port` | Elasticsearch TCP port.
| `version` | Elasticsearch version, either `2` or `5` (default).
| `path` | Path for the index. Defaults to `/phabriator`. Advanced.
A typical `elasticsearch` service configuration looks like this:
```lang=json
{ {
"type": "elasticsearch", "type": "elasticsearch",
"hosts": [ "hosts": [
{ {
"protocol": "http",
"host": "127.0.0.1", "host": "127.0.0.1",
"roles": { "write": true, "read": true } "port": 9200
} }
], ]
"port": 9200,
"protocol": "http",
"path": "/phabricator",
"version": 5
},
],
} }
``` ```
Supported Options
-----------------
| Key | Type |Comments|
|`type` | String |Engine type. Currently, 'elasticsearch' or 'mysql'|
|`protocol`| String |Either 'http' or 'https'|
|`port`| Int |The TCP port that Elasticsearch is bound to|
|`path`| String |The path portion of the url for phabricator's index.|
|`version`| Int |The version of Elasticsearch server. Supports either 2 or 5.|
|`hosts`| List |A list of one or more Elasticsearch host names / addresses.|
Host Configuration
------------------
Each search service must have one or more hosts associated with it. Each host
entry consists of a `host` key, a dictionary of roles and can optionally
override any of the options that are valid at the service level (see above).
Currently supported roles are `read` and `write`. These can be individually
enabled or disabled on a per-host basis. A typical setup might include two
elasticsearch clusters in two separate datacenters. You can configure one
cluster for reads and both for writes. When one cluster is down for maintenance
you can simply swap the read role over to the backup cluster and then proceed
with maintenance without any service interruption.
Monitoring Search Services Monitoring Search Services
========================== ==========================
You can monitor fulltext search in {nav Config > Search Servers}. This interface You can monitor fulltext search in {nav Config > Search Servers}. This
shows you a quick overview of services and their health. interface shows you a quick overview of services and their health.
The table on this page shows some basic stats for each configured service, The table on this page shows some basic stats for each configured service,
followed by the configuration and current status of each host. followed by the configuration and current status of each host.
NOTE: This page runs its diagnostics //from the web server that is serving the
request//. If you are recovering from a disaster, the view this page shows Rebuilding Indexes
may be partial or misleading, and two requests served by different servers may ==================
see different views of the cluster.
After adding new search services, you will need to rebuild document indexes
on them. To do this, first initialize the services:
```
phabricator/ $ ./bin/search init
```
This will perform index setup steps and other one-time configuration.
To populate documents in all indexes, run this command:
```
phabricator/ $ ./bin/search index --force --background --type all
```
This initiates an exhaustive rebuild of the document indexes. To get a more
detailed list of indexing options available, run:
```
phabricator/ $ ./bin/search help index
```
Advanced Example
================
This is a more advanced example which shows a configuration with multiple
different services in different roles. In this example:
- Phabricator is using an Elasticsearch 2 service as its primary fulltext
service.
- An Elasticsearch 5 service is online, but only receiving writes.
- The MySQL service is serving as a backup if Elasticsearch fails.
This particular configuration may not be very useful. It is primarily
intended to show how to configure many different options.
```lang=json
[
{
"type": "elasticsearch",
"version": 2,
"hosts": [
{
"host": "elastic2.mycompany.com",
"port": 9200,
"protocol": "http"
}
]
},
{
"type": "elasticsearch",
"version": 5,
"hosts": [
{
"host": "elastic5.mycompany.com",
"port": 9789,
"protocol": "https"
"roles": {
"read": false,
"write": true
}
}
]
},
{
"type": "mysql"
}
]
```
Phabricator · Built by Phacility