Skip to content

Commit 7e118ab

Browse files
committed
region mover args
1 parent 67f3f1b commit 7e118ab

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

docs/modules/hbase/pages/usage-guide/operations/graceful-shutdown.adoc

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,35 @@ spec:
4848
<3>: Enable or disable region confirmation on the present and target servers. Default is `true`.
4949
<4>: Extra options to pass to the region mover tool.
5050

51+
For a list of additional options accepted by the region mover use the `--help` option first:
52+
53+
[source,bash]
54+
----
55+
$ /stackable/hbase/bin/hbase org.apache.hadoop.hbase.util.RegionMover --help
56+
usage: hbase org.apache.hadoop.hbase.util.RegionMover <options>
57+
Options:
58+
-r,--regionserverhost <arg> region server <hostname>|<hostname:port>
59+
-o,--operation <arg> Expected: load/unload/unload_from_rack/isolate_regions
60+
-m,--maxthreads <arg> Define the maximum number of threads to use to unload and reload the regions
61+
-i,--isolateRegionIds <arg> Comma separated list of Region IDs hash to isolate on a RegionServer and put region
62+
server in draining mode. This option should only be used with '-o isolate_regions'. By
63+
putting region server in decommission/draining mode, master can't assign any new region
64+
on this server. If one or more regions are not found OR failed to isolate successfully,
65+
utility will exist without putting RS in draining/decommission mode. Ex.
66+
--isolateRegionIds id1,id2,id3 OR -i id1,id2,id3
67+
-x,--excludefile <arg> File with <hostname:port> per line to exclude as unload targets; default excludes only
68+
target host; useful for rack decommisioning.
69+
-d,--designatedfile <arg> File with <hostname:port> per line as unload targets;default is all online hosts
70+
-f,--filename <arg> File to save regions list into unloading, or read from loading; default
71+
/tmp/<usernamehostname:port>
72+
-n,--noack Turn on No-Ack mode(default: false) which won't check if region is online on target
73+
RegionServer, hence best effort. This is more performant in unloading and loading but
74+
might lead to region being unavailable for some time till master reassigns it in case the
75+
move failed
76+
-t,--timeout <arg> timeout in seconds after which the tool will exit irrespective of whether it finished or
77+
not;default Integer.MAX_VALUE
78+
----
79+
5180
NOTE: There is no need to explicitly specify a timeout for the region movement. The operator will compute an appropriate timeout that cannot exceed the `gracefulShutdownTimeout` for region servers.
5281

5382
IMPORTANT: The ZooKeeper connection must be available during the time the region mover is running for the graceful shutdown process to succeed.

0 commit comments

Comments
 (0)