Skip to content

Commit c72015f

Browse files
Update settings related to discovery service v2 (#1749)
1 parent 3d2d967 commit c72015f

File tree

1 file changed

+23
-3
lines changed

1 file changed

+23
-3
lines changed

modules/ROOT/pages/clustering/settings.adoc

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ Detailed information about discovery and discovery configuration options is give
6262

6363
**Example:** `clustering-discovery-dns=DNS` combined with `dbms.cluster.discovery.endpoints=cluster01.example.com:5000` fetch all DNS A records for _cluster01.example.com_ and attempt to reach Neo4j instances listening on port `5000` for each A record's IP address.
6464

65-
| xref:configuration/configuration-settings.adoc#config_dbms.cluster.discovery.endpoints[`dbms.cluster.discovery.endpoints`]
65+
| xref:configuration/configuration-settings.adoc#config_dbms.cluster.discovery.endpoints[`dbms.cluster.discovery.endpoints`] label:deprecated[Deprecated in 5.23]
6666
| One or more network addresses used to discover other servers in the cluster.
6767
The exact method by which endpoints are resolved to other cluster members is determined by the value of `dbms.cluster.discovery.resolver_type`.
6868
In the default case, the initial discovery members are given as a comma-separated list of address/port pairs, and the default port for the discovery service is `:5000`.
@@ -74,7 +74,27 @@ This is described in detail in xref:clustering/setup/discovery.adoc#clustering-d
7474

7575
**Example:** `dbms.cluster.discovery.resolver_type=LIST` combined with `server01.example.com:5000,server02.example.com:5000,server03.example.com:5000` attempt to reach Neo4j instances listening on _server01.example.com_, _server02.example.com_ and _server03.example.com_; all on port `5000`.
7676

77-
| xref:configuration/configuration-settings.adoc#config_server.discovery.advertised_address[`server.discovery.advertised_address`]
77+
|xref:configuration/configuration-settings.adoc#config_dbms.cluster.discovery.v2.endpoints[`dbms.cluster.discovery.v2.endpoints`] label:new[Introduced in 5.22]
78+
|A comma-separated list of endpoints that a server should contact in order to discover other cluster members.
79+
Typically, all cluster members, including the current server, must be specified in this list. The setting configures the endpoints for discovery service v2.
80+
81+
|xref:configuration/configuration-settings.adoc#config_dbms.cluster.discovery.version[`dbms.cluster.discovery.version`] label:new[Introduced in 5.22]
82+
|This setting allows you to select which discovery service should be started.
83+
Possible values are:
84+
85+
* V1_ONLY -— it runs only discovery service v1.
86+
87+
* V1_OVER_V2 -— it runs both discovery service v1 and discovery service v2, where v1 is the main service and v2 runs in the background.
88+
89+
* V2_OVER_V1 -— it runs both discovery service v1 and discovery service v2, where v2 is the main service and v1 runs in the background.
90+
91+
* V2_ONLY -- it runs only discovery service v2.
92+
93+
Discovery services v1 and v2 are designed to run in parallel.
94+
They are completely independent of each other, thus allowing you to keep the cluster functioning while switching over from v1 to v2.
95+
For details on how to move from discovery service v1 to v2, see xref:clustering/setup/discovery.adoc#clustering-discovery-v1-to-v2[Moving from discovery service v1 to v2].
96+
97+
| xref:configuration/configuration-settings.adoc#config_server.discovery.advertised_address[`server.discovery.advertised_address`] label:deprecated[Deprecated in 5.23]
7898
| The address/port setting that specifies where the instance advertises that it listens for discovery protocol messages from other members of the cluster.
7999
If this server is included in the `discovery.endpoints` of other cluster members, the value there must **exactly** match this advertised address.
80100

@@ -90,7 +110,7 @@ If this server is included in the `discovery.endpoints` of other cluster members
90110

91111
**Example:** `causal_clustering.transaction_advertised_address=192.168.33.20:6001` listens for transactions from cluster members on the network interface bound to `192.168.33.20` on port `6001`.
92112

93-
| xref:configuration/configuration-settings.adoc#config_server.discovery.listen_address[`server.discovery.listen_address`]
113+
| xref:configuration/configuration-settings.adoc#config_server.discovery.listen_address[`server.discovery.listen_address`] label:deprecated[Deprecated in 5.23]
94114
| The address/port setting that specifies which network interface and port the Neo4j instance binds to for the cluster discovery protocol.
95115

96116
**Example:** `server.discovery.listen_address=0.0.0.0:5001` listens for cluster membership communication on any network interface at port `5001`.

0 commit comments

Comments
 (0)