Skip to content

doc(server): remove role election config options #502

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
byteayan wants to merge 2 commits into
base: master
Choose a base branch
from
+2 −24
Open

doc(server): remove role election config options #502

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aeac699
doc(server): remove role election config options
byteayan Sep 27, 2026
5ffb6bc
doc(server): note that role election options apply to 1.7.0 only
byteayan Sep 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 1 addition & 12 deletions content/cn/docs/config/config-option.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,6 @@ search_boost: 1.5
| init_store.enabled | true | Whether init-store initializes the local backend stores and the built-in admin account. Set false in distributed deployments (PD/HStore) where the storage side already owns the metadata. |
| server.id | 空字符串 | The optional legacy id of hugegraph-server. |
| server.role | master | The role of nodes in the cluster, available types are [master, worker, computer] |
| server.role_election | false | Whether to enable role election, if enabled, the server will elect a master node in the cluster. |
| server.node_id | node-id1 | The node id of the server. |
| server.node_role | worker | The node role of the server. |
| server.graphspace | DEFAULT | The graph space of the server. |
Expand Down Expand Up @@ -80,17 +79,7 @@ search_boost: 1.5
| log.slow_query_threshold | 1000 | The threshold time(ms) of logging slow query, 0 means logging slow query is disabled. |
| log.slow_query_body_limit | 512 | 慢查询日志记录的请求体最大字节数，0 表示不记录。记录的前缀原样写入，可能包含敏感的 Gremlin 或 Cypher 字面量。 |

> [!DETAILS]- **角色选举配置项 (可选)**
> 对应配置文件`rest-server.properties`，仅在 `server.role_election=true` 时生效。
>
> | config option | default value | description |
> |--------------------------------|-----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
> | server.role.node_external_url | http://127.0.0.1:8080 | The url of external accessibility. |
> | server.role.base_timeout | 500 | The role state machine candidate state base timeout time, in ms. |
> | server.role.random_timeout | 1000 | The random timeout in ms that be used when candidate node request to become master state to reduce competitive voting. |
> | server.role.heartbeat_interval | 2 | The role state machine heartbeat interval second time. |
> | server.role.fail_count | 5 | When the node failed count of update or query heartbeat is reaches this threshold, the node will become abdication state to guardsafe property. |
> | server.role.master_dead_times | 10 | When the worker node detects that the number of times the master node fails to update heartbeat reaches this threshold, the worker node will become to a candidate node. |
角色选举配置项 `server.role_election` 和 `server.role.*` 仅适用于 1.7.0 及更早版本。之后的版本不再读取这些配置项：若仍然设置，服务可以正常启动，并为每个配置项输出一条警告日志。

### PD/Meta 配置项 (分布式模式)

Expand Down
13 changes: 1 addition & 12 deletions content/en/docs/config/config-option.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,6 @@ Corresponding configuration file `rest-server.properties`
| init_store.enabled | true | Whether init-store initializes the local backend stores and the built-in admin account. Set false in distributed deployments (PD/HStore) where the storage side already owns the metadata. |
| server.id | Empty string | The optional legacy id of hugegraph-server. |
| server.role | master | The role of nodes in the cluster, available types are [master, worker, computer] |
| server.role_election | false | Whether to enable role election, if enabled, the server will elect a master node in the cluster. |
| server.node_id | node-id1 | The node id of the server. |
| server.node_role | worker | The node role of the server. |
| server.graphspace | DEFAULT | The graph space of the server. |
Expand Down Expand Up @@ -80,17 +79,7 @@ Corresponding configuration file `rest-server.properties`
| log.slow_query_threshold | 1000 | The threshold time(ms) of logging slow query, 0 means logging slow query is disabled. |
| log.slow_query_body_limit | 512 | The max bytes of request body recorded in the slow query log, 0 means the body is not recorded. The recorded prefix is written as-is and may contain sensitive Gremlin or Cypher literals. |

> [!DETAILS]- **Role Election Config Options (Optional)**
Comment thread
byteayan marked this conversation as resolved.
> Corresponding configuration file `rest-server.properties`, only used when `server.role_election=true`.
>
> | config option | default value | description |
> |--------------------------------|-----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
> | server.role.node_external_url | http://127.0.0.1:8080 | The url of external accessibility. |
> | server.role.base_timeout | 500 | The role state machine candidate state base timeout time, in ms. |
> | server.role.random_timeout | 1000 | The random timeout in ms that be used when candidate node request to become master state to reduce competitive voting. |
> | server.role.heartbeat_interval | 2 | The role state machine heartbeat interval second time. |
> | server.role.fail_count | 5 | When the node failed count of update or query heartbeat is reaches this threshold, the node will become abdication state to guardsafe property. |
> | server.role.master_dead_times | 10 | When the worker node detects that the number of times the master node fails to update heartbeat reaches this threshold, the worker node will become to a candidate node. |
The role election options `server.role_election` and `server.role.*` apply to version 1.7.0 and earlier only. Later versions no longer read them: a server that still sets them starts normally and logs a warning for each key.

### PD/Meta Config Options (Distributed Mode)

Expand Down