diff --git a/modules/ROOT/pages/configuration/configuration-settings.adoc b/modules/ROOT/pages/configuration/configuration-settings.adoc index a92782ca0..1baa678c1 100644 --- a/modules/ROOT/pages/configuration/configuration-settings.adoc +++ b/modules/ROOT/pages/configuration/configuration-settings.adoc @@ -6,11 +6,38 @@ :page-styles: hide-table-captions This page provides a complete reference to the Neo4j configuration settings, which can be set in xref::/configuration/file-locations.adoc[_neo4j.conf_]. -Refer to xref::/configuration/neo4j-conf.adoc[The neo4j.conf file] for details on how to use configuration settings. +Refer to xref::/configuration/neo4j-conf.adoc[The _neo4j.conf_ file] for details on how to use configuration settings. Some of the settings are labeled **_Dynamic_**, which means that they can be changed at runtime, without restarting the service. For more information on how to update dynamic configuration settings, see xref:configuration/dynamic-settings.adoc[Update dynamic settings]. +[role=label--enterprise] +== Configuration setting group for the load balancing framework + +When deploying a multi-data cluster in Neo4j, you can configure the load balancing framework. + +In Neo4j, the load balancing system is based on a plugin architecture. +The primary built-in plugin is `server_policies`, which is set up by the following property: + +[source, shell] +---- +causal_clustering.load_balancing.plugin=server_policies +---- + +`server_policies` plugin determines which servers are eligible to serve client requests based on predefined routing policies. +If a client does not specify a routing policy, the system defaults to using all available servers. + +You can define routing policies by using the following property format: + +[source, shell] +---- +causal_clustering.load_balancing.config.server_policies.= +---- + +Where `` is the name of the routing policy, and `` specifies the server selection logic. + +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. + == Checkpoint settings