From 5b4eaf13c0ba978d6dc6dca60f4c70685f032041 Mon Sep 17 00:00:00 2001 From: Natalia Ivakina Date: Tue, 22 Oct 2024 15:52:06 +0200 Subject: [PATCH] Swap tabs in the examples of v2 discovery --- .../clustering/setup/analytics-cluster.adoc | 80 +++++++++---------- .../ROOT/pages/clustering/setup/deploy.adoc | 54 ++++++------- .../pages/clustering/setup/discovery.adoc | 56 ++++++------- .../clustering/setup/single-to-cluster.adoc | 38 ++++----- 4 files changed, 114 insertions(+), 114 deletions(-) diff --git a/modules/ROOT/pages/clustering/setup/analytics-cluster.adoc b/modules/ROOT/pages/clustering/setup/analytics-cluster.adoc index 06c01ddb3..a40e0c1cb 100644 --- a/modules/ROOT/pages/clustering/setup/analytics-cluster.adoc +++ b/modules/ROOT/pages/clustering/setup/analytics-cluster.adoc @@ -23,7 +23,7 @@ For more details on the Neo4j discovery services, see xref:clustering/setup/disc [.tabbed-example] ===== -[role=include-with-Discovery-service-v1 label--deprecated-5.23] +[role=include-with-Discovery-service-v2 label--new-5.23] ====== 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. @@ -37,12 +37,18 @@ Key points: * The servers for analytics have mode constraints configured that restrict their hosting mode to _secondary_ to prevent them from participating in normal write operations. * In the example below, you set `dbms.cluster.discovery.resolver_type=LIST`. +To use the discovery service v2: + +* You have to set the configuration of `dbms.cluster.discovery.version` to `V2_ONLY`. +* Instead of `dbms.cluster.discovery.endpoints`, use `dbms.cluster.discovery.v2.endpoints`. + ._neo4j.conf_ on server01.example.com: [source, properties] ---- server.default_listen_address=0.0.0.0 server.default_advertised_address=server01.example.com -dbms.cluster.discovery.endpoints=server01.example.com:5000,server02.example.com:5000,server03.example.com:5000,server04.example.com:5000,server05.example.com:5000 +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 +dbms.cluster.discovery.version=V2_ONLY ---- ._neo4j.conf_ on server02.example.com: @@ -50,7 +56,8 @@ dbms.cluster.discovery.endpoints=server01.example.com:5000,server02.example.com: ---- server.default_listen_address=0.0.0.0 server.default_advertised_address=server02.example.com -dbms.cluster.discovery.endpoints=server01.example.com:5000,server02.example.com:5000,server03.example.com:5000,server04.example.com:5000,server05.example.com:5000 +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 +dbms.cluster.discovery.version=V2_ONLY ---- ._neo4j.conf_ on server03.example.com: @@ -58,7 +65,8 @@ dbms.cluster.discovery.endpoints=server01.example.com:5000,server02.example.com: ---- server.default_listen_address=0.0.0.0 server.default_advertised_address=server03.example.com -dbms.cluster.discovery.endpoints=server01.example.com:5000,server02.example.com:5000,server03.example.com:5000,server04.example.com:5000,server05.example.com:5000 +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 +dbms.cluster.discovery.version=V2_ONLY ---- ._neo4j.conf_ on server04.example.com - an analytics server: @@ -66,7 +74,8 @@ dbms.cluster.discovery.endpoints=server01.example.com:5000,server02.example.com: ---- server.default_listen_address=0.0.0.0 server.default_advertised_address=server04.example.com -dbms.cluster.discovery.endpoints=server01.example.com:5000,server02.example.com:5000,server03.example.com:5000,server04.example.com:5000,server05.example.com:5000 +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 +dbms.cluster.discovery.version=V2_ONLY initial.server.mode_constraint=SECONDARY server.cluster.system_database_mode=SECONDARY ---- @@ -76,7 +85,8 @@ server.cluster.system_database_mode=SECONDARY ---- server.default_listen_address=0.0.0.0 server.default_advertised_address=server05.example.com -dbms.cluster.discovery.endpoints=server01.example.com:5000,server02.example.com:5000,server03.example.com:5000,server04.example.com:5000,server05.example.com:5000 +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 +dbms.cluster.discovery.version=V2_ONLY initial.server.mode_constraint=SECONDARY server.cluster.system_database_mode=SECONDARY ---- @@ -124,8 +134,9 @@ SHOW SERVERS YIELD *; | "9207bfd9-aa1b-40c2-b965-edcd3955a20e" | "9207bfd9-aa1b-40c2-b965-edcd3955a20e" | "server05:7687" | "Free" | "Available" | ["system"] | [] | [] | [] | [] | "SECONDARY" | "5.8.0" | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ---- + ====== -[role=include-with-Discovery-service-v2 label--new-5.23] +[role=include-with-Discovery-service-v1 label--deprecated-5.23] ====== 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. @@ -139,18 +150,12 @@ Key points: * The servers for analytics have mode constraints configured that restrict their hosting mode to _secondary_ to prevent them from participating in normal write operations. * In the example below, you set `dbms.cluster.discovery.resolver_type=LIST`. -To use the discovery service v2: - -* You have to set the configuration of `dbms.cluster.discovery.version` to `V2_ONLY`. -* Instead of `dbms.cluster.discovery.endpoints`, use `dbms.cluster.discovery.v2.endpoints`. - ._neo4j.conf_ on server01.example.com: [source, properties] ---- server.default_listen_address=0.0.0.0 server.default_advertised_address=server01.example.com -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 -dbms.cluster.discovery.version=V2_ONLY +dbms.cluster.discovery.endpoints=server01.example.com:5000,server02.example.com:5000,server03.example.com:5000,server04.example.com:5000,server05.example.com:5000 ---- ._neo4j.conf_ on server02.example.com: @@ -158,8 +163,7 @@ dbms.cluster.discovery.version=V2_ONLY ---- server.default_listen_address=0.0.0.0 server.default_advertised_address=server02.example.com -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 -dbms.cluster.discovery.version=V2_ONLY +dbms.cluster.discovery.endpoints=server01.example.com:5000,server02.example.com:5000,server03.example.com:5000,server04.example.com:5000,server05.example.com:5000 ---- ._neo4j.conf_ on server03.example.com: @@ -167,8 +171,7 @@ dbms.cluster.discovery.version=V2_ONLY ---- server.default_listen_address=0.0.0.0 server.default_advertised_address=server03.example.com -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 -dbms.cluster.discovery.version=V2_ONLY +dbms.cluster.discovery.endpoints=server01.example.com:5000,server02.example.com:5000,server03.example.com:5000,server04.example.com:5000,server05.example.com:5000 ---- ._neo4j.conf_ on server04.example.com - an analytics server: @@ -176,8 +179,7 @@ dbms.cluster.discovery.version=V2_ONLY ---- server.default_listen_address=0.0.0.0 server.default_advertised_address=server04.example.com -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 -dbms.cluster.discovery.version=V2_ONLY +dbms.cluster.discovery.endpoints=server01.example.com:5000,server02.example.com:5000,server03.example.com:5000,server04.example.com:5000,server05.example.com:5000 initial.server.mode_constraint=SECONDARY server.cluster.system_database_mode=SECONDARY ---- @@ -187,8 +189,7 @@ server.cluster.system_database_mode=SECONDARY ---- server.default_listen_address=0.0.0.0 server.default_advertised_address=server05.example.com -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 -dbms.cluster.discovery.version=V2_ONLY +dbms.cluster.discovery.endpoints=server01.example.com:5000,server02.example.com:5000,server03.example.com:5000,server04.example.com:5000,server05.example.com:5000 initial.server.mode_constraint=SECONDARY server.cluster.system_database_mode=SECONDARY ---- @@ -236,7 +237,6 @@ SHOW SERVERS YIELD *; | "9207bfd9-aa1b-40c2-b965-edcd3955a20e" | "9207bfd9-aa1b-40c2-b965-edcd3955a20e" | "server05:7687" | "Free" | "Available" | ["system"] | [] | [] | [] | [] | "SECONDARY" | "5.8.0" | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ---- - ====== ===== @@ -280,9 +280,8 @@ The following example shows how to set up a non-fault tolerant analytics cluster [.tabbed-example] ===== -[role=include-with-Discovery-service-v1 label--deprecated-5.23] +[role=include-with-Discovery-service-v2 label--new-5.23] ====== - In this example, three servers named `server01.example.com`, `server02.example.com` and `server03.example.com` are configured. Neo4j Enterprise Edition is installed on all three servers. They are configured by preparing xref:configuration/file-locations.adoc[_neo4j.conf_] on each server. @@ -297,6 +296,10 @@ This is required in order to have a cluster with only a single primary for the ` * The servers for analytics have mode constraints configured that restrict their hosting mode to _secondary_ to prevent them from participating in normal write operations. * In the example below, you set `dbms.cluster.discovery.resolver_type=LIST`. +To use the discovery service v2: + +* You have to set the configuration of `dbms.cluster.discovery.version` to `V2_ONLY`. +* Instead of `dbms.cluster.discovery.endpoints`, use `dbms.cluster.discovery.v2.endpoints`. ._neo4j.conf_ on server01.example.com - the writer: [source, properties] @@ -304,7 +307,8 @@ This is required in order to have a cluster with only a single primary for the ` server.default_listen_address=0.0.0.0 server.default_advertised_address=server01.example.com # Only has self in this list -dbms.cluster.discovery.endpoints=server01.example.com:5000 +dbms.cluster.discovery.v2.endpoints=server01.example.com:6000 +dbms.cluster.discovery.version=V2_ONLY ---- ._neo4j.conf_ on server02.example.com - an analytics server: @@ -312,7 +316,8 @@ dbms.cluster.discovery.endpoints=server01.example.com:5000 ---- server.default_listen_address=0.0.0.0 server.default_advertised_address=server02.example.com -dbms.cluster.discovery.endpoints=server01.example.com:5000,server02.example.com:5000,server03.example.com:5000 +dbms.cluster.discovery.v2.endpoints=server01.example.com:6000,server02.example.com:6000,server03.example.com:6000 +dbms.cluster.discovery.version=V2_ONLY initial.server.mode_constraint=SECONDARY server.cluster.system_database_mode=SECONDARY ---- @@ -322,7 +327,8 @@ server.cluster.system_database_mode=SECONDARY ---- server.default_listen_address=0.0.0.0 server.default_advertised_address=server03.example.com -dbms.cluster.discovery.endpoints=server01.example.com:5000,server02.example.com:5000,server03.example.com:5000 +dbms.cluster.discovery.v2.endpoints=server01.example.com:6000,server02.example.com:6000,server03.example.com:6000 +dbms.cluster.discovery.version=V2_ONLY initial.server.mode_constraint=SECONDARY server.cluster.system_database_mode=SECONDARY ---- @@ -366,10 +372,10 @@ SHOW SERVERS YIELD *; | "73e9a990-0a97-4a09-91e9-622bf0b239a4" | "73e9a990-0a97-4a09-91e9-622bf0b239a4" | "server03:7687" | "Free" | "Available" | ["system"] | ["system"] | [] | [] | [] | "SECONDARY" | "5.8.0" | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ---- - ====== -[role=include-with-Discovery-service-v2 label--new-5.23] +[role=include-with-Discovery-service-v1 label--deprecated-5.23] ====== + In this example, three servers named `server01.example.com`, `server02.example.com` and `server03.example.com` are configured. Neo4j Enterprise Edition is installed on all three servers. They are configured by preparing xref:configuration/file-locations.adoc[_neo4j.conf_] on each server. @@ -384,10 +390,6 @@ This is required in order to have a cluster with only a single primary for the ` * The servers for analytics have mode constraints configured that restrict their hosting mode to _secondary_ to prevent them from participating in normal write operations. * In the example below, you set `dbms.cluster.discovery.resolver_type=LIST`. -To use the discovery service v2: - -* You have to set the configuration of `dbms.cluster.discovery.version` to `V2_ONLY`. -* Instead of `dbms.cluster.discovery.endpoints`, use `dbms.cluster.discovery.v2.endpoints`. ._neo4j.conf_ on server01.example.com - the writer: [source, properties] @@ -395,8 +397,7 @@ To use the discovery service v2: server.default_listen_address=0.0.0.0 server.default_advertised_address=server01.example.com # Only has self in this list -dbms.cluster.discovery.v2.endpoints=server01.example.com:6000 -dbms.cluster.discovery.version=V2_ONLY +dbms.cluster.discovery.endpoints=server01.example.com:5000 ---- ._neo4j.conf_ on server02.example.com - an analytics server: @@ -404,8 +405,7 @@ dbms.cluster.discovery.version=V2_ONLY ---- server.default_listen_address=0.0.0.0 server.default_advertised_address=server02.example.com -dbms.cluster.discovery.v2.endpoints=server01.example.com:6000,server02.example.com:6000,server03.example.com:6000 -dbms.cluster.discovery.version=V2_ONLY +dbms.cluster.discovery.endpoints=server01.example.com:5000,server02.example.com:5000,server03.example.com:5000 initial.server.mode_constraint=SECONDARY server.cluster.system_database_mode=SECONDARY ---- @@ -415,8 +415,7 @@ server.cluster.system_database_mode=SECONDARY ---- server.default_listen_address=0.0.0.0 server.default_advertised_address=server03.example.com -dbms.cluster.discovery.v2.endpoints=server01.example.com:6000,server02.example.com:6000,server03.example.com:6000 -dbms.cluster.discovery.version=V2_ONLY +dbms.cluster.discovery.endpoints=server01.example.com:5000,server02.example.com:5000,server03.example.com:5000 initial.server.mode_constraint=SECONDARY server.cluster.system_database_mode=SECONDARY ---- @@ -460,6 +459,7 @@ SHOW SERVERS YIELD *; | "73e9a990-0a97-4a09-91e9-622bf0b239a4" | "73e9a990-0a97-4a09-91e9-622bf0b239a4" | "server03:7687" | "Free" | "Available" | ["system"] | ["system"] | [] | [] | [] | "SECONDARY" | "5.8.0" | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ---- + ====== ===== diff --git a/modules/ROOT/pages/clustering/setup/deploy.adoc b/modules/ROOT/pages/clustering/setup/deploy.adoc index e1485a756..0b779527f 100644 --- a/modules/ROOT/pages/clustering/setup/deploy.adoc +++ b/modules/ROOT/pages/clustering/setup/deploy.adoc @@ -25,16 +25,16 @@ In the typical case, this should be set to the fully qualified domain name or th | xref:configuration/configuration-settings.adoc#config_server.default_listen_address[`server.default_listen_address`] | The address or network interface this machine uses to listen for incoming messages. Setting this value to `0.0.0.0` makes Neo4j bind to all available network interfaces. -| xref:configuration/configuration-settings.adoc#config_dbms.cluster.discovery.endpoints[`dbms.cluster.discovery.endpoints`] label:deprecated[Deprecated in 5.23] -| The discovery network address for all the members of the cluster, including this server. -The setting must be set to the same value on all cluster members. -The behavior of this setting can be modified by configuring the setting `dbms.cluster.discovery.resolver_type`. -This is described in detail in xref:clustering/setup/discovery.adoc[]. | xref:configuration/configuration-settings.adoc#config_dbms.cluster.discovery.v2.endpoints[`dbms.cluster.discovery.v2.endpoints`] label:new[Introduced in 5.22] | A comma-separated list of endpoints that a server should contact in order to discover other cluster members. Typically, all cluster members, including the current server, must be specified in this list. The setting configures the endpoints for **discovery service v2**. | xref:configuration/configuration-settings.adoc#config_dbms.cluster.discovery.version[`dbms.cluster.discovery.version`] label:new[Introduced in 5.22] | This setting allows you to select which discovery service should be started. +| xref:configuration/configuration-settings.adoc#config_dbms.cluster.discovery.endpoints[`dbms.cluster.discovery.endpoints`] label:deprecated[Deprecated in 5.23] +| The discovery network address for all the members of the cluster, including this server. +The setting must be set to the same value on all cluster members. +The behavior of this setting can be modified by configuring the setting `dbms.cluster.discovery.resolver_type`. +This is described in detail in xref:clustering/setup/discovery.adoc[]. | xref:configuration/configuration-settings.adoc#config_initial.dbms.default_primaries_count[`initial.dbms.default_primaries_count`] | The number of initial database hostings in primary mode. If not specified, it defaults to one hosting in primary mode. @@ -73,20 +73,30 @@ In this case, you set `dbms.cluster.discovery.resolver_type=LIST`. [.tabbed-example] ===== -[role=include-with-Discovery-service-v1 label--deprecated-5.23] +[role=include-with-Discovery-service-v2 label--new-5.23] ====== + In this example, three servers named `server01.example.com`, `server02.example.com` and `server03.example.com` are configured. Neo4j Enterprise Edition is installed on all three servers. They are configured by preparing xref:configuration/file-locations.adoc[_neo4j.conf_] on each server. -Note that they are all identical, except for the configuration of `server.default_advertised_address`: + +Note that they are all identical, except for the configuration of `server.default_advertised_address`. + +To use discovery service v2: + +* You have to set the configuration of `dbms.cluster.discovery.version` to `V2_ONLY`. + +* Instead of `dbms.cluster.discovery.endpoints`, use `dbms.cluster.discovery.v2.endpoints`. + ._neo4j.conf_ on server01.example.com: [source, properties] ---- server.default_listen_address=0.0.0.0 server.default_advertised_address=server01.example.com -dbms.cluster.discovery.endpoints=server01.example.com:5000,server02.example.com:5000,server03.example.com:5000 +dbms.cluster.discovery.v2.endpoints=server01.example.com:6000,server02.example.com:6000,server03.example.com:6000 +dbms.cluster.discovery.version=V2_ONLY initial.dbms.default_primaries_count=3 ---- @@ -95,7 +105,8 @@ initial.dbms.default_primaries_count=3 ---- server.default_listen_address=0.0.0.0 server.default_advertised_address=server02.example.com -dbms.cluster.discovery.endpoints=server01.example.com:5000,server02.example.com:5000,server03.example.com:5000 +dbms.cluster.discovery.v2.endpoints=server01.example.com:6000,server02.example.com:6000,server03.example.com:6000 +dbms.cluster.discovery.version=V2_ONLY initial.dbms.default_primaries_count=3 ---- @@ -104,7 +115,8 @@ initial.dbms.default_primaries_count=3 ---- server.default_listen_address=0.0.0.0 server.default_advertised_address=server03.example.com -dbms.cluster.discovery.endpoints=server01.example.com:5000,server02.example.com:5000,server03.example.com:5000 +dbms.cluster.discovery.v2.endpoints=server01.example.com:6000,server02.example.com:6000,server03.example.com:6000 +dbms.cluster.discovery.version=V2_ONLY initial.dbms.default_primaries_count=3 ---- @@ -156,30 +168,20 @@ If you want to follow along with the startup, you can see the messages in xref:c ==== ====== -[role=include-with-Discovery-service-v2 label--new-5.23] +[role=include-with-Discovery-service-v1 label--deprecated-5.23] ====== - In this example, three servers named `server01.example.com`, `server02.example.com` and `server03.example.com` are configured. Neo4j Enterprise Edition is installed on all three servers. They are configured by preparing xref:configuration/file-locations.adoc[_neo4j.conf_] on each server. - -Note that they are all identical, except for the configuration of `server.default_advertised_address`. - -To use discovery service v2: - -* You have to set the configuration of `dbms.cluster.discovery.version` to `V2_ONLY`. - -* Instead of `dbms.cluster.discovery.endpoints`, use `dbms.cluster.discovery.v2.endpoints`. - +Note that they are all identical, except for the configuration of `server.default_advertised_address`: ._neo4j.conf_ on server01.example.com: [source, properties] ---- server.default_listen_address=0.0.0.0 server.default_advertised_address=server01.example.com -dbms.cluster.discovery.v2.endpoints=server01.example.com:6000,server02.example.com:6000,server03.example.com:6000 -dbms.cluster.discovery.version=V2_ONLY +dbms.cluster.discovery.endpoints=server01.example.com:5000,server02.example.com:5000,server03.example.com:5000 initial.dbms.default_primaries_count=3 ---- @@ -188,8 +190,7 @@ initial.dbms.default_primaries_count=3 ---- server.default_listen_address=0.0.0.0 server.default_advertised_address=server02.example.com -dbms.cluster.discovery.v2.endpoints=server01.example.com:6000,server02.example.com:6000,server03.example.com:6000 -dbms.cluster.discovery.version=V2_ONLY +dbms.cluster.discovery.endpoints=server01.example.com:5000,server02.example.com:5000,server03.example.com:5000 initial.dbms.default_primaries_count=3 ---- @@ -198,8 +199,7 @@ initial.dbms.default_primaries_count=3 ---- server.default_listen_address=0.0.0.0 server.default_advertised_address=server03.example.com -dbms.cluster.discovery.v2.endpoints=server01.example.com:6000,server02.example.com:6000,server03.example.com:6000 -dbms.cluster.discovery.version=V2_ONLY +dbms.cluster.discovery.endpoints=server01.example.com:5000,server02.example.com:5000,server03.example.com:5000 initial.dbms.default_primaries_count=3 ---- diff --git a/modules/ROOT/pages/clustering/setup/discovery.adoc b/modules/ROOT/pages/clustering/setup/discovery.adoc index 2e50cc0e0..d7e066683 100644 --- a/modules/ROOT/pages/clustering/setup/discovery.adoc +++ b/modules/ROOT/pages/clustering/setup/discovery.adoc @@ -48,28 +48,28 @@ For example: [.tabbed-example] ===== -[role=include-with-discovery-service-v1 label--deprecated-5.23] +[role=include-with-discovery-service-v2 label--new-5.23] ====== [source, parameters] ---- dbms.cluster.discovery.resolver_type=LIST -server.discovery.advertised_address=server01.example.com:5000 -dbms.cluster.discovery.endpoints=server01.example.com:5000,server02.example.com:5000,server03.example.com:5000 +server.cluster.advertised_address=server01.example.com:6000 +dbms.cluster.discovery.v2.endpoints=server01.example.com:6000,server02.example.com:6000,server03.example.com:6000 -dbms.cluster.discovery.version=V1_ONLY +dbms.cluster.discovery.version=V2_ONLY ---- ====== -[role=include-with-discovery-service-v2 label--new-5.23] +[role=include-with-discovery-service-v1 label--deprecated-5.23] ====== [source, parameters] ---- dbms.cluster.discovery.resolver_type=LIST -server.cluster.advertised_address=server01.example.com:6000 -dbms.cluster.discovery.v2.endpoints=server01.example.com:6000,server02.example.com:6000,server03.example.com:6000 +server.discovery.advertised_address=server01.example.com:5000 +dbms.cluster.discovery.endpoints=server01.example.com:5000,server02.example.com:5000,server03.example.com:5000 -dbms.cluster.discovery.version=V2_ONLY +dbms.cluster.discovery.version=V1_ONLY ---- ====== ===== @@ -93,29 +93,29 @@ For example: + [.tabbed-example] ===== -[role=include-with-discovery-service-v1 label--deprecated-5.23] +[role=include-with-discovery-service-v2 label--new-5.23] ====== [source, parameters] ---- dbms.cluster.discovery.resolver_type=DNS -server.discovery.advertised_address=server01.example.com:5000 -dbms.cluster.discovery.endpoints=cluster01.example.com:5000 +server.cluster.advertised_address=server01.example.com:6000 +dbms.cluster.discovery.v2.endpoints=cluster01.example.com:6000 + +dbms.cluster.discovery.version=V2_ONLY -dbms.cluster.discovery.version=V1_ONLY ---- ====== -[role=include-with-discovery-service-v2 label--new-5.23] +[role=include-with-discovery-service-v1 label--deprecated-5.23] ====== [source, parameters] ---- dbms.cluster.discovery.resolver_type=DNS -server.cluster.advertised_address=server01.example.com:6000 -dbms.cluster.discovery.v2.endpoints=cluster01.example.com:6000 - -dbms.cluster.discovery.version=V2_ONLY +server.discovery.advertised_address=server01.example.com:5000 +dbms.cluster.discovery.endpoints=cluster01.example.com:5000 +dbms.cluster.discovery.version=V1_ONLY ---- ====== ===== @@ -138,33 +138,33 @@ For example: + [.tabbed-example] ===== -[role=include-with-discovery-service-v1 label--deprecated-5.23] +[role=include-with-discovery-service-v2 label--new-5.23] ====== [source, parameters] ---- dbms.cluster.discovery.resolver_type=SRV -server.discovery.advertised_address=server01.example.com:5000 -dbms.cluster.discovery.endpoints=cluster01.example.com:0 +server.cluster.advertised_address=server01.example.com:6000 +dbms.cluster.discovery.v2.endpoints=cluster01.example.com:0 -dbms.cluster.discovery.version=V1_ONLY +dbms.cluster.discovery.version=V2_ONLY ---- -The SRV record returned by DNS should contain the IP address or hostname, and the *discovery* port for the servers to be discovered. + +The SRV record returned by DNS should contain the IP address or hostname, and the **cluster** port for the servers to be discovered. The configured server uses all the addresses from the SRV record to join or form a cluster. ====== -[role=include-with-discovery-service-v2 label--new-5.23] +[role=include-with-discovery-service-v1 label--deprecated-5.23] ====== [source, parameters] ---- dbms.cluster.discovery.resolver_type=SRV -server.cluster.advertised_address=server01.example.com:6000 -dbms.cluster.discovery.v2.endpoints=cluster01.example.com:0 +server.discovery.advertised_address=server01.example.com:5000 +dbms.cluster.discovery.endpoints=cluster01.example.com:0 -dbms.cluster.discovery.version=V2_ONLY +dbms.cluster.discovery.version=V1_ONLY ---- - -The SRV record returned by DNS should contain the IP address or hostname, and the **cluster** port for the servers to be discovered. +The SRV record returned by DNS should contain the IP address or hostname, and the *discovery* port for the servers to be discovered. The configured server uses all the addresses from the SRV record to join or form a cluster. ====== ===== diff --git a/modules/ROOT/pages/clustering/setup/single-to-cluster.adoc b/modules/ROOT/pages/clustering/setup/single-to-cluster.adoc index 30d132562..47b7508a6 100644 --- a/modules/ROOT/pages/clustering/setup/single-to-cluster.adoc +++ b/modules/ROOT/pages/clustering/setup/single-to-cluster.adoc @@ -18,21 +18,33 @@ See xref:clustering/setup/analytics-cluster.adoc[] for more information on analy [.tabbed-example] ===== -[role=include-with-Discovery-service-v1 label--deprecated-5.23] +[role=include-with-Discovery-service-v2 label--new-5.23] ====== In this example, a standalone server named `server01` is running and two additional servers, `server02` and `server03`, are to be added to form a cluster. The two additional servers are configured according to xref:clustering/setup/deploy.adoc#cluster-example-configure-a-three-primary-cluster[Configure a cluster with three servers] and are _not_ running. Neo4j Enterprise Edition is installed on all three servers. -Start by stopping the standalone server and once it is stopped, edit the xref:configuration/file-locations.adoc[_neo4j.conf_] file to include the discovery endpoints of itself and the servers that will form the cluster. +Start by stopping the standalone server. +Once it is stopped, edit the xref:configuration/file-locations.adoc[_neo4j.conf_] file to include the discovery endpoints of itself and the servers that will form the cluster. + +Starting with Neo4j 5.23, it is recommended to use v2 of the discovery service. +For more details on discovery services, see xref:clustering/setup/discovery.adoc[]. + +To use the discovery service v2: + +* You have to set the configuration of `dbms.cluster.discovery.version` to `V2_ONLY`. +* Instead of `dbms.cluster.discovery.endpoints`, use `dbms.cluster.discovery.v2.endpoints`. + +The example below uses `dbms.cluster.discovery.resolver_type=LIST`. ._neo4j.conf_ on server01.example.com: [source, properties] ---- server.default_listen_address=0.0.0.0 server.default_advertised_address=server01.example.com -dbms.cluster.discovery.endpoints=server01.example.com:5000,server02.example.com:5000,server03.example.com:5000 +dbms.cluster.discovery.v2.endpoints=server01.example.com:6000,server02.example.com:6000,server03.example.com:6000 +dbms.cluster.discovery.version=V2_ONLY initial.dbms.default_primaries_count=3 ---- (The xref:configuration/file-locations.adoc[_neo4j.conf_] file looks identical except for the `server.default_advertised_address` on all three servers. Please refer to xref:clustering/setup/deploy.adoc#cluster-example-configure-a-three-primary-cluster[Configure a cluster with three servers] for more information.) @@ -77,35 +89,22 @@ On `server01` (the previously standalone server) verify that all user databases The last step is to enable the `Free` servers using `ENABLE SERVER` (see xref:clustering/servers.adoc[] for more information on server states). Once all servers are enabled, you can scale up user databases using xref:clustering/databases.adoc#alter-topology[`ALTER DATABASE`], if desired. - ====== -[role=include-with-Discovery-service-v2 label--new-5.23] +[role=include-with-Discovery-service-v1 label--deprecated-5.23] ====== In this example, a standalone server named `server01` is running and two additional servers, `server02` and `server03`, are to be added to form a cluster. The two additional servers are configured according to xref:clustering/setup/deploy.adoc#cluster-example-configure-a-three-primary-cluster[Configure a cluster with three servers] and are _not_ running. Neo4j Enterprise Edition is installed on all three servers. -Start by stopping the standalone server. -Once it is stopped, edit the xref:configuration/file-locations.adoc[_neo4j.conf_] file to include the discovery endpoints of itself and the servers that will form the cluster. - -Starting with Neo4j 5.23, it is recommended to use v2 of the discovery service. -For more details on discovery services, see xref:clustering/setup/discovery.adoc[]. - -To use the discovery service v2: - -* You have to set the configuration of `dbms.cluster.discovery.version` to `V2_ONLY`. -* Instead of `dbms.cluster.discovery.endpoints`, use `dbms.cluster.discovery.v2.endpoints`. - -The example below uses `dbms.cluster.discovery.resolver_type=LIST`. +Start by stopping the standalone server and once it is stopped, edit the xref:configuration/file-locations.adoc[_neo4j.conf_] file to include the discovery endpoints of itself and the servers that will form the cluster. ._neo4j.conf_ on server01.example.com: [source, properties] ---- server.default_listen_address=0.0.0.0 server.default_advertised_address=server01.example.com -dbms.cluster.discovery.v2.endpoints=server01.example.com:6000,server02.example.com:6000,server03.example.com:6000 -dbms.cluster.discovery.version=V2_ONLY +dbms.cluster.discovery.endpoints=server01.example.com:5000,server02.example.com:5000,server03.example.com:5000 initial.dbms.default_primaries_count=3 ---- (The xref:configuration/file-locations.adoc[_neo4j.conf_] file looks identical except for the `server.default_advertised_address` on all three servers. Please refer to xref:clustering/setup/deploy.adoc#cluster-example-configure-a-three-primary-cluster[Configure a cluster with three servers] for more information.) @@ -150,6 +149,7 @@ On `server01` (the previously standalone server) verify that all user databases The last step is to enable the `Free` servers using `ENABLE SERVER` (see xref:clustering/servers.adoc[] for more information on server states). Once all servers are enabled, you can scale up user databases using xref:clustering/databases.adoc#alter-topology[`ALTER DATABASE`], if desired. + ====== =====