Skip to content

Commit 78ee988

Browse files
Add causal_clustering.load_balancing.config.server_policies to the ref page (neo4j#2459)
Based on the PR neo4j#2414
1 parent 56e1a02 commit 78ee988

File tree

1 file changed

+28
-1
lines changed

1 file changed

+28
-1
lines changed

modules/ROOT/pages/configuration/configuration-settings.adoc

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,38 @@
66
:page-styles: hide-table-captions
77

88
This page provides a complete reference to the Neo4j configuration settings, which can be set in xref::/configuration/file-locations.adoc[_neo4j.conf_].
9-
Refer to xref::/configuration/neo4j-conf.adoc[The neo4j.conf file] for details on how to use configuration settings.
9+
Refer to xref::/configuration/neo4j-conf.adoc[The _neo4j.conf_ file] for details on how to use configuration settings.
1010

1111
Some of the settings are labeled **_Dynamic_**, which means that they can be changed at runtime, without restarting the service.
1212
For more information on how to update dynamic configuration settings, see xref:configuration/dynamic-settings.adoc[Update dynamic settings].
1313

14+
[role=label--enterprise]
15+
== Configuration setting group for the load balancing framework
16+
17+
When deploying a multi-data cluster in Neo4j, you can configure the load balancing framework.
18+
19+
In Neo4j, the load balancing system is based on a plugin architecture.
20+
The primary built-in plugin is `server_policies`, which is set up by the following property:
21+
22+
[source, shell]
23+
----
24+
causal_clustering.load_balancing.plugin=server_policies
25+
----
26+
27+
`server_policies` plugin determines which servers are eligible to serve client requests based on predefined routing policies.
28+
If a client does not specify a routing policy, the system defaults to using all available servers.
29+
30+
You can define routing policies by using the following property format:
31+
32+
[source, shell]
33+
----
34+
causal_clustering.load_balancing.config.server_policies.<policy-name>=<policy-definition>
35+
----
36+
37+
Where `<policy-name>` is the name of the routing policy, and `<policy-definition>` specifies the server selection logic.
38+
39+
See xref:clustering-advanced/multi-data-center/load-balancing.adoc#multi-dc-load-balancing-the-load-balancing-framework[Appendix -> Advanced Causal Clustering -> Multi-data center load balancing] for more details.
40+
1441

1542
== Checkpoint settings
1643

0 commit comments

Comments
 (0)