Document pretend_min_part_hours_passed

Added a docstring for the swift-ring-builder CLI command
"pretend_min_part_hours_passed". This is a dangerous operation, and
that's why it hasn't been documented, but it can be useful at times.
It should be made known to those who need it.

Change-Id: I45bdbaacbbdda64c7510453e6d93e6d8563e3ecd
This commit is contained in:
John Dickinson
2015-12-14 10:52:22 -08:00
parent 65684e5699
commit 40476ea079

View File

@@ -1029,6 +1029,19 @@ swift-ring-builder <ring_file> write_builder [min_part_hours]
builder.save(builder_file)
def pretend_min_part_hours_passed():
"""
swift-ring-builder <builder_file> pretend_min_part_hours_passed
Resets the clock on the last time a rebalance happened, thus
circumventing the min_part_hours check.
*****************************
USE THIS WITH EXTREME CAUTION
*****************************
If you run this command and deploy rebalanced rings before a replication
pass completes, you may introduce unavailability in your cluster. This
has an end-user impact.
"""
builder.pretend_min_part_hours_passed()
builder.save(builder_file)
exit(EXIT_SUCCESS)