Skip to content

Commit 9dcbfd4

Browse files
feat: Add user guide for compaction offload (#158)
Co-authored-by: Jiacai Liu <[email protected]>
1 parent 24790a6 commit 9dcbfd4

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

content/en/docs/user-guide/cluster_deployment/with_meta.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -187,9 +187,28 @@ timeout = "5s"
187187
server_addrs = ['http://{HoraeMetaAddr}:2379']
188188
```
189189

190+
### Compaction Offload
191+
192+
Compaction offload is also supported. To enable compaction offload, the corresponding compaction mode with node picker and endpoint should be configured.
193+
194+
- `node_picker`: There are two types of node picker -- `Local` and `Remote`(WIP).
195+
- When the `Local` is setted, the local compaction task would be offloaded to the specific remote compaction server, which decided by `endpoint`.
196+
- `endpoint`: The endpoint, in the form `addr:port`, indicating the _grpc port_ of the remote compaction server.
197+
198+
Here is an example for it:
199+
200+
```toml
201+
[analytic.compaction_mode]
202+
compaction_mode = "Offload"
203+
node_picker = "Local"
204+
endpoint = "{RemoteCompactionServerAddr}:{RemoteCompactionServerGrpcPort}"
205+
```
206+
207+
A Compaction Server, responsible for executing the compaction task, is also needed. Currently `horaedb-server` will act as this role, in the future we can move it to an independent service.
208+
190209
### Complete Config of HoraeDB
191210

192-
With all the parts of the configurations mentioned above, a runnable complete config for HoraeDB can be made. In order to make the HoraeDB cluster runnable, we can decide to adopt RocksDB-based WAL and local-disk-based Object Storage:
211+
With all the parts of the configurations mentioned above, a runnable complete config for HoraeDB can be made. In order to make the HoraeDB cluster runnable, we can decide to adopt RocksDB-based WAL and local-disk-based Object Storage without compaction offload:
193212

194213
```toml
195214
[server]

0 commit comments

Comments
 (0)