[HBASE-22760] Stop/Resume Snapshot Auto-Cleanup activity with shell command - ASF JIRA

XML

Word

Printable

JSON

Details

Type: Improvement
Status: Resolved
Priority: Major
Resolution: Fixed
Affects Version/s: 3.0.0-alpha-1, 1.5.0, 2.3.0
Fix Version/s: 3.0.0-alpha-1, 1.5.0, 2.3.0
Component/s: Admin, shell, snapshots
Labels:
None

Release Note:

Hide
By default, snapshot auto cleanup based on TTL would be enabled for any new cluster. At any point in time, if snapshot cleanup is supposed to be stopped due to some snapshot restore activity or any other reason, it is advisable to disable it using shell command:
hbase> snapshot_cleanup_switch false

We can re-enable it using:
hbase> snapshot_cleanup_switch true

We can query whether snapshot auto cleanup is enabled for cluster using:
hbase> snapshot_cleanup_enabled

Show
By default, snapshot auto cleanup based on TTL would be enabled for any new cluster. At any point in time, if snapshot cleanup is supposed to be stopped due to some snapshot restore activity or any other reason, it is advisable to disable it using shell command: hbase> snapshot_cleanup_switch false We can re-enable it using: hbase> snapshot_cleanup_switch true We can query whether snapshot auto cleanup is enabled for cluster using: hbase> snapshot_cleanup_enabled

Description

For any scheduled snapshot backup activity, we would like to disable auto-cleaner for snapshot based on TTL. However, as per ~~HBASE-22648~~ we have a config to disable snapshot auto-cleaner: hbase.master.cleaner.snapshot.disable, which would take effect only upon HMaster restart just similar to any other hbase-site configs.

For any running cluster, we should be able to stop/resume auto-cleanup activity for snapshot based on shell command. Something similar to below command should be able to stop/start cleanup chore:

hbase(main):001:0> snapshot_auto_cleanup_switch false (disable auto-cleaner)

hbase(main):001:0> snapshot_auto_cleanup_switch true (enable auto-cleaner)