d785e837d0
Partially reverts I6d67e7a40e16468bb7bf4ac742361fb44eec4e28 to restore the source files for the man pages. These are used by some packagers (confirmed that this is the case for Ubuntu) to generate the man pages included in their distributions. Does not add the man pages back to the HTML index, so these will be orphans for now. A follow up patch will either add a man build to tox, or add the HTML generation back so we can review generated content. Long term fix will be to merge the content of the --help text in the cmd files with the content of the man pages and figure out how to generate the man pages from the --help text. Right now, the --help text is better in some regards, and the man pages are better in others. Change-Id: I2aa85b63a196c75224630981b322fecbf36f1b7c
64 lines
1.7 KiB
ReStructuredText
64 lines
1.7 KiB
ReStructuredText
===============
|
|
glance-scrubber
|
|
===============
|
|
|
|
--------------------
|
|
Glance scrub service
|
|
--------------------
|
|
|
|
:Author: glance@lists.launchpad.net
|
|
:Date: 2016-10-6
|
|
:Copyright: OpenStack Foundation
|
|
:Version: 13.0.0
|
|
:Manual section: 1
|
|
:Manual group: cloud computing
|
|
|
|
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.rst
|
|
|
|
**-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.rst
|