Skip to content

Commit

Permalink
Added split and unload command example (#884)
Browse files Browse the repository at this point in the history

---------

Co-authored-by: Dragos Misca <[email protected]>
  • Loading branch information
heesung-sn and dragosvictor committed Apr 15, 2024
1 parent 280481c commit f569258
Showing 1 changed file with 27 additions and 3 deletions.
30 changes: 27 additions & 3 deletions docs/concepts-broker-load-balancing-concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,17 @@ Based on the broker resource usage (for example, the number of topics or session
Step 3: split bundles at the specific boundaries from step 2.
For how to split bundles manually, see TBD (the docs is WIP, stay tuned!).
For how to split bundles manually, please refer to [`split-bundle`](pathname:///reference/#/@pulsar:version_reference@/pulsar-admin/namespaces?id=split-bundle) admin command.
Examples:
Split the largest bundle at the position that equally divides the topic count, and unload the child bundles immediately.
`pulsar-admin namespaces split-bundle -b LARGEST -san topic_count_equally_divide -u my-tenant/my-namespace`
If you already know the target bundle to split, you can specify it using the `--bundle(-b)` flag:
`pulsar-admin namespaces split-bundle --bundle 0x00000000_0xffffffff my-tenant/my-namespace`
</TabItem>
Expand Down Expand Up @@ -413,7 +423,7 @@ You can unload bundles in the following ways:

- Automatic: enable Pulsar's automatic bundle unloading process when a broker is overloaded.

- Manual: trigger bundle splitting manually, to unload a bundle from one broker to another broker within a Pulsar cluster.
- Manual: trigger bundle unloading manually, to unload a bundle from one broker to another broker within a Pulsar cluster.

Bundle unloading methods | Definition | When to use
|---|---|---
Expand Down Expand Up @@ -448,7 +458,21 @@ The unloaded bundles are assigned to less loaded brokers, and the clients connec
When unloading happens, the client experiences a small latency blip while the topic is reassigned.
For how to unload bundles automatically, see TBD (the docs is WIP, stay tuned!).
For how to unload bundles manually, please refer to [`unload`](pathname:///reference/#/@pulsar:version_reference@/pulsar-admin/namespaces?id=unload) admin command.
Examples:
Unload a specific bundle (future topic lookup will assign the bundle to a new owner broker)
`pulsar-admin namespaces unload my-tenant/my-namespace -b 0x00000000_0xffffffff`
Unload a specific bundle to a destination broker
`pulsar-admin namespaces unload my-tenant/my-namespace -b 0x00000000_0xffffffff -d broker-1`
Unload all bundles in a namespace
`pulsar-admin namespaces unload my-tenant/my-namespace`
</TabItem>
<TabItem value="Manual bundle unloading">
Expand Down

0 comments on commit f569258

Please sign in to comment.