Skip to content

Commit c3f7a99

Browse files
Clarify when and how to enable new servers (neo4j#2623) (neo4j#2646)
- To document a missing step in the guide on how to deploy an analytics cluster: you have to enable servers that are in the free state. - To clarify the use and meaning of the initial settings when you deploy a cluster for the first time. - To add information about the setting, allowing automatic enabling of free servers, to the section on the `ENABLED` state of servers. --------- --------- Co-authored-by: Nick Giles <[email protected]>
1 parent b1b5af7 commit c3f7a99

File tree

5 files changed

+252
-79
lines changed

5 files changed

+252
-79
lines changed

modules/ROOT/pages/clustering/multi-region-deployment/multi-data-center-routing.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ Applying the same tag to multiple servers logically groups them together.
5858
Note that servers can have mulitple tags.
5959

6060
Server tags are defined as a key that maps onto a set of servers in a cluster.
61-
Server tags are defined on each server using the xref:configuration/configuration-settings.adoc#config_server.tags[`initial.server.tags`] parameter in _neo4j.conf_.
61+
Server tags are defined on each server using the xref:configuration/configuration-settings.adoc#config_initial.server.tags[`initial.server.tags`] parameter in _neo4j.conf_.
6262
Each server in a cluster can be tagged with to zero or more server tags.
6363
Server tags can be altered at runtime via the `ALTER SERVER` command,
6464
see xref:clustering/servers.adoc#alter-server-options[Altering server options] for more details.

modules/ROOT/pages/clustering/servers.adoc

Lines changed: 33 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,19 @@ When first discovered, a server's name defaults to the value of its generated se
3535
[[server-enabled-state]]
3636
=== Enabled state
3737

38-
A server in the free state needs to be explicitly enabled in order to be considered an active member of the cluster.
39-
The command `ENABLE SERVER server name` is used to transition a server into this _Enabled_ state.
38+
When you deploy a cluster for the first time, at least the minimum number of servers included in the initial deployment are automatically enabled.
39+
For details, refer to the example on how to xref:clustering/setup/deploy.adoc#cluster-example-configure-a-three-primary-cluster[Configure a cluster with three servers].
40+
41+
If you add a new server after the cluster is already running, the server is added in the `FREE` state.
42+
A server in the `FREE` state needs to be explicitly enabled in order to be considered an active member of the cluster.
43+
44+
To transition a server into the _Enabled_ state, use the command `ENABLE SERVER`:
45+
46+
[source, syntax, role=noheader]
47+
----
48+
ENABLE SERVER 'serverId' [OPTIONS "{" option: value[,...] "}"]
49+
----
50+
4051
The server's initial name is its ID.
4152
If the server is already enabled and the command is executed with the same options, nothing is changed.
4253

@@ -71,11 +82,30 @@ label:new[Introduced in 5.6]
7182

7283
[NOTE]
7384
====
74-
When a server is enabled, if no `OPTIONS` are not provided, the default server values are taken from the settings `initial.server.mode_constraint`, `initial.server.allowed_databases`, `initial.server.denied_databases`, and/or `initial.server.tags`.
85+
When a server is enabled, if no `OPTIONS` are provided, the default server's values are taken from the settings:
86+
87+
* xref:configuration/configuration-settings.adoc#config_initial.server.mode_constraint[`initial.server.mode_constraint`]
88+
* xref:configuration/configuration-settings.adoc#config_initial.server.allowed_databases[`initial.server.allowed_databases`]
89+
* xref:configuration/configuration-settings.adoc#config_initial.server.denied_databases[`initial.server.denied_databases`]
90+
* and/or xref:configuration/configuration-settings.adoc#config_initial.server.tags[`initial.server.tags`]
91+
92+
All these settings are only effective when enabling the relevant server.
7593
====
7694

95+
Another way to enable servers is to configure the DBMS automatically enable free servers.
96+
You can do this in one of two ways:
97+
98+
* By setting xref:configuration/configuration-settings.adoc#config_initial.dbms.automatically_enable_free_servers[`initial.dbms.automatically_enable_free_servers`] to `true` before starting the deployment for the first time.
99+
* By running the following procedure after deployment:
100+
+
101+
----
102+
CALL dbms.cluster.setAutomaticallyEnableFreeServers(true);
103+
----
104+
77105
Once enabled, the server may be allocated databases to host.
78106

107+
If you need to change some of the server's values, use the <<alter-server-options, `ALTER SERVER`>> command.
108+
79109

80110

81111
[[deallocating-state]]

0 commit comments

Comments
 (0)