Skip to content

Commit 6d2d221

Browse files
drmingdrmerdrmingdrmer
committed
refactor: add databend-meta config
1 parent 407b7dc commit 6d2d221

File tree

2 files changed

+33
-16
lines changed

2 files changed

+33
-16
lines changed

‎docs/en/guides/10-deploy/01-deploy/02-production/30-metasrv-backup-restore.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ To restore a different node, i.e., restore node-2 with the backup data of node-1
7171
## Import data as a new databend-meta cluster
7272

7373
With the `--initial-cluster` argument, the `databend-metactl` import the data and re-initialize the cluster info and node ids.
74-
The `--initial-cluster` value format is: `<node_id>=<raft_advertise_host>:<raft_api_port`,
74+
The `--initial-cluster` value format is: `<node_id>=<raft_advertise_host>:<raft_api_port>`,
7575
`raft_advertise_host`,`raft_api_port` is the same as the fields in the toml config file.
7676

7777
For example, to restore a databend-meta cluster with three nodes:

‎docs/en/guides/10-deploy/04-references/02-node-config/01-metasrv-config.md‎

Lines changed: 32 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -76,18 +76,35 @@ The following is a list of the parameters available within the [log.stderr] sect
7676

7777
The following is a list of the parameters available within the [raft_config] section:
7878

79-
| Parameter | Description |
80-
| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------- |
81-
| id | Unique identifier for the Raft configuration. |
82-
| raft_dir | Directory where Raft data is stored. |
83-
| raft_api_port | Port for the Raft API of Databend. |
84-
| raft_listen_host | IP address for Raft to listen on. |
85-
| raft_advertise_host | IP address used for advertising the Raft API. |
86-
| single | Boolean indicating whether Databend should run in single-node cluster mode (true or false). |
87-
| join | List of addresses (&lt;raft_advertise_host&gt;:&lt;raft_api_port&gt;) of nodes in an existing cluster that a new node is joined to. |
88-
| heartbeat_interval | Heartbeat interval in milliseconds. Default: 1000 |
89-
| install_snapshot_timeout | Install snapshot timeout in milliseconds. Default: 4000 |
90-
| max_applied_log_to_keep | Maximum number of applied Raft logs to keep. Default: 1000 |
91-
| snapshot_chunk_size | The size in bytes of chunk for transmitting snapshot. The default is 4MB |
92-
| snapshot_logs_since_last | Number of Raft logs since the last snapshot. Default: 1024 |
93-
| wait_leader_timeout | Wait leader timeout in milliseconds. Default: 70000 |
79+
Here is the translated `databend-meta` startup configuration table in English:
80+
81+
| Parameter | Description |
82+
|---------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|
83+
| id | Unique identifier for the Raft configuration. |
84+
| raft_dir | Directory to store Raft data. |
85+
| raft_api_port | Port for the Databend Raft API. |
86+
| raft_listen_host | IP address for Raft to listen on. |
87+
| raft_advertise_host | IP address for advertising the Raft API. |
88+
| cluster_name | Node name. If the user specifies a name, the provided name is used; otherwise, the default name is used. |
89+
| wait_leader_timeout | Timeout for waiting for the leader, in milliseconds. Default: 180000. |
90+
| -- **Management** -- | |
91+
| single | Boolean indicating whether Databend should run in single-node cluster mode (`true` or `false`). |
92+
| join | List of addresses of existing cluster nodes (`<raft_advertise_host>:<raft_api_port>`), new node will join this cluster. |
93+
| leave_via | Do not run `databend-meta`, but remove a node from the cluster via the provided endpoints. The node will be removed by `id`. |
94+
| leave_id | ID of the node to leave the cluster. |
95+
| -- **RPC** -- | |
96+
| heartbeat_interval | Heartbeat interval in milliseconds. Default: 500. |
97+
| install_snapshot_timeout | Timeout for installing snapshots, in milliseconds. Default: 4000. |
98+
| -- **Raft Log Storage** -- | |
99+
| log_cache_max_items | Maximum number of log entries cached in Raft logs. Default: 1,000,000. |
100+
| log_cache_capacity | Maximum memory (bytes) for log caching in Raft logs. Default: 1G. |
101+
| log_wal_chunk_max_records | Maximum number of records per file chunk in Raft log WAL. Default: 100,000. |
102+
| log_wal_chunk_max_size | Maximum size (bytes) for a file chunk in Raft log WAL. Default: 256M. |
103+
| -- **Raft Snapshot Storage** -- | |
104+
| snapshot_chunk_size | Chunk size for transmitting snapshots, in bytes. Default: 4MB. |
105+
| snapshot_logs_since_last | Maximum number of logs since the last snapshot. If exceeded, a new snapshot is created. Default: 1024. |
106+
| snapshot_db_debug_check | Whether to check if the keys in the input snapshot are sorted. For debugging only; Default: `true`. |
107+
| snapshot_db_block_keys | Maximum number of keys allowed per block in the snapshot database. Default: 8000. |
108+
| snapshot_db_block_cache_item | Total number of blocks to cache. Default: 1024. |
109+
| snapshot_db_block_cache_size | Total cache size for snapshot blocks. Default: 1GB. |
110+
| max_applied_log_to_keep | Maximum number of applied logs to keep in the snapshot. Default: 1000. |

0 commit comments

Comments
 (0)