Skip to content

Commit 5014f21

Browse files
authored
Add instructions for setting up remote clusters needed for CCS and CCR (#52796)
* Add instructions for setting up remote clusters needed for CCS and CCR * clean up
1 parent 6187643 commit 5014f21

File tree

1 file changed

+37
-1
lines changed

1 file changed

+37
-1
lines changed

CONTRIBUTING.md

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -218,6 +218,7 @@ node scripts/makelogs --auth <username>:<password>
218218
> The default username and password combination are `elastic:changeme`
219219
220220
> Make sure to execute `node scripts/makelogs` *after* elasticsearch is up and running!
221+
221222
### Running Elasticsearch Remotely
222223

223224
You can save some system resources, and the effort of generating sample data, if you have a remote Elasticsearch cluster to connect to. (**Elasticians: you do! Check with your team about where to find credentials**)
@@ -239,6 +240,41 @@ kibana.index: '.{YourGitHubHandle}-kibana'
239240
xpack.task_manager.index: '.{YourGitHubHandle}-task-manager-kibana'
240241
```
241242

243+
### Running remote clusters
244+
Setup remote clusters for cross cluster search (CCS) and cross cluster replication (CCR).
245+
246+
Start your primary cluster by running:
247+
```bash
248+
yarn es snapshot -E path.data=../data_prod1
249+
```
250+
251+
Start your remote cluster by running:
252+
```bash
253+
yarn es snapshot -E transport.port=9500 -E http.port=9201 -E path.data=../data_prod2
254+
```
255+
256+
Once both clusters are running, start kibana. Kibana will connect to the primary cluster.
257+
258+
Setup the remote cluster in Kibana from either `Management` -> `Elasticsearch` -> `Remote Clusters` UI or by running the following script in `Console`.
259+
```
260+
PUT _cluster/settings
261+
{
262+
"persistent": {
263+
"cluster": {
264+
"remote": {
265+
"cluster_one": {
266+
"seeds": [
267+
"localhost:9500"
268+
]
269+
}
270+
}
271+
}
272+
}
273+
}
274+
```
275+
276+
Follow the [cross-cluster search](https://www.elastic.co/guide/en/kibana/current/management-cross-cluster-search.html) instructions for setting up index patterns to search across clusters.
277+
242278
### Running Kibana
243279

244280
Start the development server.
@@ -506,7 +542,7 @@ yarn test:browser --dev # remove the --dev flag to run them once and close
506542
* In System Preferences > Sharing, change your computer name to be something simple, e.g. "computer".
507543
* Run Kibana with `yarn start --host=computer.local` (substituting your computer name).
508544
* Now you can run your VM, open the browser, and navigate to `http://computer.local:5601` to test Kibana.
509-
* Alternatively you can use browserstack
545+
* Alternatively you can use browserstack
510546

511547
#### Running Browser Automation Tests
512548

0 commit comments

Comments
 (0)