From b43b676e581efd0773a7f83715dcf2e834bd9c85 Mon Sep 17 00:00:00 2001 From: Ken Pepple Date: Mon, 27 Feb 2012 18:59:31 -0800 Subject: [PATCH] updates man page for glance-scrubber. this time with extra pep8 scrubbing powers. Fixes bug 908803 Change-Id: I105cc3157fe839cc35ef5e1fc1a5f032b04d1c9d --- .mailmap | 1 + doc/source/man/glancescrubber.rst | 24 ++++++++++++++++++++---- 2 files changed, 21 insertions(+), 4 deletions(-) diff --git a/.mailmap b/.mailmap index 763494f5a8..0e9b6140bb 100644 --- a/.mailmap +++ b/.mailmap @@ -15,3 +15,4 @@ + diff --git a/doc/source/man/glancescrubber.rst b/doc/source/man/glancescrubber.rst index 9131b6ea5f..178e4d5789 100644 --- a/doc/source/man/glancescrubber.rst +++ b/doc/source/man/glancescrubber.rst @@ -18,6 +18,25 @@ SYNOPSIS glance-scrubber [options] +DESCRIPTION +=========== + +glance-scrubber is an utility that cleans up images that have been deleted. The +mechanics of this differ depending on the backend store and pending_deletion +options chosen. + +Multiple glance-scrubbers can be run in a single deployment, but only one of +them may be designated as the 'cleanup_scrubber' in the glance-scrubber.conf +file. The 'cleanup_scrubber' coordinates other glance-scrubbers by maintaining +the master queue of images that need to be removed. + +The glance-scubber.conf file also specifies important configuration items such +as the time between runs ('wakeup_time' in seconds), length of time images +can be pending before their deletion ('cleanup_scrubber_time' in seconds) as +well as registry connectivity options. + +glance-scrubber can run as a periodic job or long-running daemon. + OPTIONS ======= @@ -84,10 +103,7 @@ OPTIONS wakeup_time interval as specified in the config. **--nodaemon** - Run as a long-running process. When not specified (the - default) run the scrub operation once and then exits. - When specified do not exit and run scrub on - wakeup_time interval as specified in the config. + The inverse of --daemon. Runs the scrub operation once and then exits. SEE ALSO ========