glance/doc/source/cli/glancescrubber.rst
Doug Hellmann f252af6490 fix include directives
Change-Id: I52720ce1c8c20df246ec8e381bc0da89efd5f0d6
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-06-21 14:15:58 -04:00

59 lines
1.6 KiB
ReStructuredText

===============
glance-scrubber
===============
--------------------
Glance scrub service
--------------------
.. include:: header.txt
SYNOPSIS
========
glance-scrubber [options]
DESCRIPTION
===========
glance-scrubber is a 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
=======
**General options**
.. include:: general_options.txt
**-D, --daemon**
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.
**--nodaemon**
The inverse of --daemon. Runs the scrub operation once and
then exits. This is the default.
FILES
=====
**/etc/glance/glance-scrubber.conf**
Default configuration file for the Glance Scrubber
.. include:: footer.txt