9526e05b96
Use oslo_config.sphinxext to automatically document the available configuration options in the sphinx documentation. See https://etherpad.openstack.org/p/automating-oslo-config-documentation for work to implement this to each project. Glance is one of the first six projects for a consolidated operators configuration reference. Change-Id: If701f7dfa240075457e6e149bcb12ff713a8c79b
64 lines
1.7 KiB
ReStructuredText
64 lines
1.7 KiB
ReStructuredText
===============
|
|
glance-scrubber
|
|
===============
|
|
|
|
--------------------
|
|
Glance scrub service
|
|
--------------------
|
|
|
|
:Author: glance@lists.launchpad.net
|
|
:Date: 2014-01-16
|
|
:Copyright: OpenStack LLC
|
|
:Version: 2014.1
|
|
: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
|