Skip to content

Commit e211317

Browse files
NataliaIvakinaNataliaIvakina
authored
Update the page on how to deploy an analytics cluster with DS V2 (#1757)
1 parent 50d1d31 commit e211317

File tree

1 file changed

+229
-5
lines changed

1 file changed

+229
-5
lines changed

‎modules/ROOT/pages/clustering/setup/analytics-cluster.adoc‎

Lines changed: 229 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,16 @@ Bear in mind that the GDS library does **not** support fault tolerance and there
1515

1616
=== Deploy the cluster
1717

18+
Starting with Neo4j 5.23, you can select between the discovery services: v1 or v2 -- which allows servers to communicate with each other.
19+
Discovery service v2 is recommended for all new deployments, as v1 has been considered deprecated since Neo4j 5.23.
20+
For more details on the Neo4j discovery services, see xref:clustering/setup/discovery.adoc[].
21+
1822
.Configure a cluster with five servers, two only for read queries
19-
====
23+
24+
[.tabbed-example]
25+
=====
26+
[role=include-with-Discovery-service-v1 label--deprecated-5.23]
27+
======
2028

2129
In this example, three servers named `server01.example.com`, `server02.example.com` and `server03.example.com` are configured as the transactional part of the cluster.
2230
Two more servers names `server04.example.com` and `server05.example.com` are configured for the analytical queries.
@@ -25,8 +33,9 @@ They are configured by preparing xref:configuration/file-locations.adoc[_neo4j.c
2533

2634
Key points:
2735

28-
* All servers include _all_ members in their discovery list
36+
* All servers include _all_ members in their discovery list.
2937
* The servers for analytics have mode constraints configured that restrict their hosting mode to _secondary_ to prevent them from participating in normal write operations.
38+
* In the example below, you set `dbms.cluster.discovery.resolver_type=LIST`.
3039

3140
._neo4j.conf_ on server01.example.com:
3241
[source, properties]
@@ -115,7 +124,122 @@ SHOW SERVERS YIELD *;
115124
| "9207bfd9-aa1b-40c2-b965-edcd3955a20e" | "9207bfd9-aa1b-40c2-b965-edcd3955a20e" | "server05:7687" | "Free" | "Available" | ["system"] | [] | [] | [] | [] | "SECONDARY" | "5.8.0" |
116125
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
117126
----
118-
====
127+
======
128+
[role=include-with-Discovery-service-v2 label--new-5.23]
129+
======
130+
131+
In this example, three servers named `server01.example.com`, `server02.example.com` and `server03.example.com` are configured as the transactional part of the cluster.
132+
Two more servers names `server04.example.com` and `server05.example.com` are configured for the analytical queries.
133+
Neo4j Enterprise Edition is installed on all five servers.
134+
They are configured by preparing xref:configuration/file-locations.adoc[_neo4j.conf_] on each server.
135+
136+
Key points:
137+
138+
* All servers include _all_ members in their discovery list.
139+
* The servers for analytics have mode constraints configured that restrict their hosting mode to _secondary_ to prevent them from participating in normal write operations.
140+
* In the example below, you set `dbms.cluster.discovery.resolver_type=LIST`.
141+
142+
To use the discovery service v2:
143+
144+
* You have to set the configuration of `dbms.cluster.discovery.version` to `V2_ONLY`.
145+
* Instead of `dbms.cluster.discovery.endpoints`, use `dbms.cluster.discovery.v2.endpoints`.
146+
147+
._neo4j.conf_ on server01.example.com:
148+
[source, properties]
149+
----
150+
server.default_listen_address=0.0.0.0
151+
server.default_advertised_address=server01.example.com
152+
dbms.cluster.discovery.v2.endpoints=server01.example.com:6000,server02.example.com:6000,server03.example.com:6000,server04.example.com:6000,server05.example.com:6000
153+
dbms.cluster.discovery.version=V2_ONLY
154+
----
155+
156+
._neo4j.conf_ on server02.example.com:
157+
[source, properties]
158+
----
159+
server.default_listen_address=0.0.0.0
160+
server.default_advertised_address=server02.example.com
161+
dbms.cluster.discovery.v2.endpoints=server01.example.com:6000,server02.example.com:6000,server03.example.com:6000,server04.example.com:6000,server05.example.com:6000
162+
dbms.cluster.discovery.version=V2_ONLY
163+
----
164+
165+
._neo4j.conf_ on server03.example.com:
166+
[source, properties]
167+
----
168+
server.default_listen_address=0.0.0.0
169+
server.default_advertised_address=server03.example.com
170+
dbms.cluster.discovery.v2.endpoints=server01.example.com:6000,server02.example.com:6000,server03.example.com:6000,server04.example.com:6000,server05.example.com:6000
171+
dbms.cluster.discovery.version=V2_ONLY
172+
----
173+
174+
._neo4j.conf_ on server04.example.com - an analytics server:
175+
[source, properties]
176+
----
177+
server.default_listen_address=0.0.0.0
178+
server.default_advertised_address=server04.example.com
179+
dbms.cluster.discovery.v2.endpoints=server01.example.com:6000,server02.example.com:6000,server03.example.com:6000,server04.example.com:6000,server05.example.com:6000
180+
dbms.cluster.discovery.version=V2_ONLY
181+
initial.server.mode_constraint=SECONDARY
182+
server.cluster.system_database_mode=SECONDARY
183+
----
184+
185+
._neo4j.conf_ on server05.example.com - an analytics server:
186+
[source, properties]
187+
----
188+
server.default_listen_address=0.0.0.0
189+
server.default_advertised_address=server05.example.com
190+
dbms.cluster.discovery.v2.endpoints=server01.example.com:6000,server02.example.com:6000,server03.example.com:6000,server04.example.com:6000,server05.example.com:6000
191+
dbms.cluster.discovery.version=V2_ONLY
192+
initial.server.mode_constraint=SECONDARY
193+
server.cluster.system_database_mode=SECONDARY
194+
----
195+
196+
The Neo4j servers are ready to be started.
197+
The startup order does not matter.
198+
199+
After the cluster has started, it is possible to connect to any of the instances and run `SHOW SERVERS` to check the status of the cluster.
200+
This shows information about each member of the cluster:
201+
202+
[source, cypher, role=noplay]
203+
----
204+
SHOW SERVERS;
205+
----
206+
207+
[queryresult]
208+
----
209+
+-----------------------------------------------------------------------------------------------------------+
210+
| name | address | state | health | hosting |
211+
+-----------------------------------------------------------------------------------------------------------+
212+
| "f3bd1199-bc6f-4a38-b25c-5f7588df5182" | "server01:7687" | "Enabled" | "Available" | ["system", "neo4j"] |
213+
| "b331e481-c2ba-4b4e-82f3-bb51fe171483" | "server02:7687" | "Enabled" | "Available" | ["system"] |
214+
| "bd80e8fd-a51b-406a-9ed4-42daf4792aa6" | "server03:7687" | "Enabled" | "Available" | ["system"] |
215+
| "df3758b1-337f-4b8a-a9de-8e745ca96549" | "server04:7687" | "Free" | "Available" | ["system"] |
216+
| "9207bfd9-aa1b-40c2-b965-edcd3955a20e" | "server05:7687" | "Free" | "Available" | ["system"] |
217+
+-----------------------------------------------------------------------------------------------------------+
218+
----
219+
220+
For more extensive information about each server, use the `SHOW SERVERS YIELD *` command:
221+
222+
[source, cypher, role=noplay]
223+
----
224+
SHOW SERVERS YIELD *;
225+
----
226+
227+
[queryresult]
228+
----
229+
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
230+
| serverId | name | address | state | health | hosting | requestedHosting | tags | allowedDatabases | deniedDatabases | modeConstraint | version |
231+
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
232+
| "f3bd1199-bc6f-4a38-b25c-5f7588df5182" | "f3bd1199-bc6f-4a38-b25c-5f7588df5182" | "server01:7687" | "Enabled" | "Available" | ["system", "neo4j"] | ["system", "neo4j"] | [] | [] | [] | "NONE" | "5.8.0" |
233+
| "b331e481-c2ba-4b4e-82f3-bb51fe171483" | "b331e481-c2ba-4b4e-82f3-bb51fe171483" | "server02:7687" | "Enabled" | "Available" | ["system"] | ["system"] | [] | [] | [] | "NONE" | "5.8.0" |
234+
| "bd80e8fd-a51b-406a-9ed4-42daf4792aa6" | "bd80e8fd-a51b-406a-9ed4-42daf4792aa6" | "server03:7687" | "Enabled" | "Available" | ["system"] | ["system"] | [] | [] | [] | "NONE" | "5.8.0" |
235+
| "df3758b1-337f-4b8a-a9de-8e745ca96549" | "df3758b1-337f-4b8a-a9de-8e745ca96549" | "server04:7687" | "Free" | "Available" | ["system"] | [] | [] | [] | [] | "SECONDARY" | "5.8.0" |
236+
| "9207bfd9-aa1b-40c2-b965-edcd3955a20e" | "9207bfd9-aa1b-40c2-b965-edcd3955a20e" | "server05:7687" | "Free" | "Available" | ["system"] | [] | [] | [] | [] | "SECONDARY" | "5.8.0" |
237+
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
238+
----
239+
240+
======
241+
=====
242+
119243

120244
[[cluster-example-create-databases-on-cluster]]
121245
=== Create new databases in the cluster
@@ -153,7 +277,11 @@ The following example shows how to set up a non-fault tolerant analytics cluster
153277
=== Deploy the cluster
154278

155279
.Configure a cluster with three servers
156-
====
280+
281+
[.tabbed-example]
282+
=====
283+
[role=include-with-Discovery-service-v1 label--deprecated-5.23]
284+
======
157285

158286
In this example, three servers named `server01.example.com`, `server02.example.com` and `server03.example.com` are configured.
159287
Neo4j Enterprise Edition is installed on all three servers.
@@ -167,6 +295,7 @@ Key points:
167295
This means it does not seek out the other members when it starts, they have to discover it.
168296
This is required in order to have a cluster with only a single primary for the `system` database.
169297
* The servers for analytics have mode constraints configured that restrict their hosting mode to _secondary_ to prevent them from participating in normal write operations.
298+
* In the example below, you set `dbms.cluster.discovery.resolver_type=LIST`.
170299

171300

172301
._neo4j.conf_ on server01.example.com - the writer:
@@ -237,7 +366,102 @@ SHOW SERVERS YIELD *;
237366
| "73e9a990-0a97-4a09-91e9-622bf0b239a4" | "73e9a990-0a97-4a09-91e9-622bf0b239a4" | "server03:7687" | "Free" | "Available" | ["system"] | ["system"] | [] | [] | [] | "SECONDARY" | "5.8.0" |
238367
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
239368
----
240-
====
369+
370+
======
371+
[role=include-with-Discovery-service-v2 label--new-5.23]
372+
======
373+
In this example, three servers named `server01.example.com`, `server02.example.com` and `server03.example.com` are configured.
374+
Neo4j Enterprise Edition is installed on all three servers.
375+
They are configured by preparing xref:configuration/file-locations.adoc[_neo4j.conf_] on each server.
376+
Note that `server01.example.com` is different from the others, and is the only server where write operations take place.
377+
The other servers are able to execute read queries, and if using GDS, to write results back to the writing server.
378+
379+
Key points:
380+
381+
* The writer server only has itself in the list of discovery.
382+
This means it does not seek out the other members when it starts, they have to discover it.
383+
This is required in order to have a cluster with only a single primary for the `system` database.
384+
* The servers for analytics have mode constraints configured that restrict their hosting mode to _secondary_ to prevent them from participating in normal write operations.
385+
* In the example below, you set `dbms.cluster.discovery.resolver_type=LIST`.
386+
387+
To use the discovery service v2:
388+
389+
* You have to set the configuration of `dbms.cluster.discovery.version` to `V2_ONLY`.
390+
* Instead of `dbms.cluster.discovery.endpoints`, use `dbms.cluster.discovery.v2.endpoints`.
391+
392+
._neo4j.conf_ on server01.example.com - the writer:
393+
[source, properties]
394+
----
395+
server.default_listen_address=0.0.0.0
396+
server.default_advertised_address=server01.example.com
397+
# Only has self in this list
398+
dbms.cluster.discovery.v2.endpoints=server01.example.com:6000
399+
dbms.cluster.discovery.version=V2_ONLY
400+
----
401+
402+
._neo4j.conf_ on server02.example.com - an analytics server:
403+
[source, properties]
404+
----
405+
server.default_listen_address=0.0.0.0
406+
server.default_advertised_address=server02.example.com
407+
dbms.cluster.discovery.v2.endpoints=server01.example.com:6000,server02.example.com:6000,server03.example.com:6000
408+
dbms.cluster.discovery.version=V2_ONLY
409+
initial.server.mode_constraint=SECONDARY
410+
server.cluster.system_database_mode=SECONDARY
411+
----
412+
413+
._neo4j.conf_ on server03.example.com - an analytics server:
414+
[source, properties]
415+
----
416+
server.default_listen_address=0.0.0.0
417+
server.default_advertised_address=server03.example.com
418+
dbms.cluster.discovery.v2.endpoints=server01.example.com:6000,server02.example.com:6000,server03.example.com:6000
419+
dbms.cluster.discovery.version=V2_ONLY
420+
initial.server.mode_constraint=SECONDARY
421+
server.cluster.system_database_mode=SECONDARY
422+
----
423+
424+
The Neo4j servers are ready to be started.
425+
The startup order does not matter.
426+
427+
After the cluster has started, it is possible to connect to any of the instances and run `SHOW SERVERS` to check the status of the cluster.
428+
This shows information about each member of the cluster:
429+
430+
[source, cypher, role=noplay]
431+
----
432+
SHOW SERVERS;
433+
----
434+
435+
[queryresult]
436+
----
437+
+-----------------------------------------------------------------------------------------------------------+
438+
| name | address | state | health | hosting |
439+
+-----------------------------------------------------------------------------------------------------------+
440+
| "d6fbe54b-0c6a-4959-9bcb-dcbbe80262a4" | "server01:7687" | "Enabled" | "Available" | ["system", "neo4j"] |
441+
| "e56b49ea-243f-11ed-861d-0242ac120002" | "server02:7687" | "Free" | "Available" | ["system"] |
442+
| "73e9a990-0a97-4a09-91e9-622bf0b239a4" | "server03:7687" | "Free" | "Available" | ["system"] |
443+
+-----------------------------------------------------------------------------------------------------------+
444+
----
445+
446+
For more extensive information about each server, use the `SHOW SERVERS YIELD *` command:
447+
448+
[source, cypher, role=noplay]
449+
----
450+
SHOW SERVERS YIELD *;
451+
----
452+
453+
[queryresult]
454+
----
455+
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
456+
| serverId | name | address | state | health | hosting | requestedHosting | tags | allowedDatabases | deniedDatabases | modeConstraint | version |
457+
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
458+
| "d6fbe54b-0c6a-4959-9bcb-dcbbe80262a4" | "d6fbe54b-0c6a-4959-9bcb-dcbbe80262a4" | "server01:7687" | "Enabled" | "Available" | ["system", "neo4j"] | ["system", "neo4j"] | [] | [] | [] | "NONE" | "5.8.0" |
459+
| "e56b49ea-243f-11ed-861d-0242ac120002" | "e56b49ea-243f-11ed-861d-0242ac120002" | "server02:7687" | "Free" | "Available" | ["system"] | ["system"] | [] | [] | [] | "SECONDARY" | "5.8.0" |
460+
| "73e9a990-0a97-4a09-91e9-622bf0b239a4" | "73e9a990-0a97-4a09-91e9-622bf0b239a4" | "server03:7687" | "Free" | "Available" | ["system"] | ["system"] | [] | [] | [] | "SECONDARY" | "5.8.0" |
461+
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
462+
----
463+
======
464+
=====
241465

242466
[[cluster-example-create-databases-on-single-primary-cluster]]
243467
=== Create new databases in the cluster

0 commit comments

Comments
 (0)