diff --git a/doc/source/artifact-types.rst b/doc/source/artifact-types.rst deleted file mode 100644 index 8806d227a3..0000000000 --- a/doc/source/artifact-types.rst +++ /dev/null @@ -1,21 +0,0 @@ -.. - Copyright 2015 OpenStack Foundation - All Rights Reserved. - - Licensed under the Apache License, Version 2.0 (the "License"); you may - not use this file except in compliance with the License. You may obtain - a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - License for the specific language governing permissions and limitations - under the License. - -Glance Artifact Types -===================== - -.. list-plugins:: glance.artifacts.types - :detailed: diff --git a/doc/source/conf.py b/doc/source/conf.py index 29ae4bb4a4..c5b373a978 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -148,30 +148,6 @@ modindex_common_prefix = ['glance.'] # Grouping the document tree for man pages. # List of tuples 'sourcefile', 'target', u'title', u'Authors name', 'manual' -man_pages = [ - ('man/glanceapi', 'glance-api', u'Glance API Server', - [u'OpenStack'], 1), - ('man/glancecachecleaner', 'glance-cache-cleaner', u'Glance Cache Cleaner', - [u'OpenStack'], 1), - ('man/glancecachemanage', 'glance-cache-manage', u'Glance Cache Manager', - [u'OpenStack'], 1), - ('man/glancecacheprefetcher', 'glance-cache-prefetcher', - u'Glance Cache Pre-fetcher', [u'OpenStack'], 1), - ('man/glancecachepruner', 'glance-cache-pruner', u'Glance Cache Pruner', - [u'OpenStack'], 1), - ('man/glancecontrol', 'glance-control', u'Glance Daemon Control Helper ', - [u'OpenStack'], 1), - ('man/glancemanage', 'glance-manage', u'Glance Management Utility', - [u'OpenStack'], 1), - ('man/glanceregistry', 'glance-registry', u'Glance Registry Server', - [u'OpenStack'], 1), - ('man/glancereplicator', 'glance-replicator', u'Glance Replicator', - [u'OpenStack'], 1), - ('man/glancescrubber', 'glance-scrubber', u'Glance Scrubber Service', - [u'OpenStack'], 1) -] - - # -- Options for HTML output ------------------------------------------------- # The theme to use for HTML and HTML Help pages. Major themes that come with diff --git a/doc/source/contributing/index.rst b/doc/source/contributing/index.rst index 3e4ab5abe3..a68e3e8182 100644 --- a/doc/source/contributing/index.rst +++ b/doc/source/contributing/index.rst @@ -6,6 +6,19 @@ developing with Glance. This includes the processes we use for blueprints and specs, bugs, contributor onboarding, core reviewer memberships, and other procedural items. +Glance, as with all OpenStack projects, is written with the following design +guidelines in mind: + +* **Component based architecture**: Quickly add new behaviors +* **Highly available**: Scale to very serious workloads +* **Fault tolerant**: Isolated processes avoid cascading failures +* **Recoverable**: Failures should be easy to diagnose, debug, and rectify +* **Open standards**: Be a reference implementation for a community-driven api + +This documentation is generated by the Sphinx toolkit and lives in the source +tree. Additional documentation on Glance and other components of OpenStack can +be found on the `OpenStack wiki `_. + Policies -------- .. toctree:: diff --git a/doc/source/db-sqlalchemy-migrate.rst b/doc/source/db-sqlalchemy-migrate.rst deleted file mode 100644 index 6a511123a6..0000000000 --- a/doc/source/db-sqlalchemy-migrate.rst +++ /dev/null @@ -1,65 +0,0 @@ -.. - Copyright 2012 OpenStack Foundation - All Rights Reserved. - - Licensed under the Apache License, Version 2.0 (the "License"); you may - not use this file except in compliance with the License. You may obtain - a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - License for the specific language governing permissions and limitations - under the License. - -Legacy Database Management -========================== - -.. note:: - This page applies only to Glance releases prior to Ocata. From Ocata - onward, please see :doc:`db`. - -The default metadata driver for Glance uses sqlalchemy, which implies there -exists a backend database which must be managed. The ``glance-manage`` binary -provides a set of commands for making this easier. - -The commands should be executed as a subcommand of 'db': - - glance-manage db - - -Sync the Database ------------------ - - glance-manage db sync - -Place a database under migration control and upgrade, creating it first if necessary. - - -Determining the Database Version --------------------------------- - - glance-manage db version - -This will print the current migration level of a Glance database. - - -Upgrading an Existing Database ------------------------------- - - glance-manage db upgrade - -This will take an existing database and upgrade it to the specified VERSION. - - -Downgrading an Existing Database --------------------------------- - -Upgrades involve complex operations and can fail. Before attempting any -upgrade, you should make a full database backup of your production data. As of -Kilo, database downgrades are not supported, and the only method available to -get back to a prior database version is to restore from backup[1]. - -[1]: http://docs.openstack.org/ops-guide/ops-upgrades.html#perform-a-backup diff --git a/doc/source/image-location-strategy-modules.rst b/doc/source/image-location-strategy-modules.rst deleted file mode 100644 index 9725e67fd5..0000000000 --- a/doc/source/image-location-strategy-modules.rst +++ /dev/null @@ -1,21 +0,0 @@ -.. - Copyright 2015 OpenStack Foundation - All Rights Reserved. - - Licensed under the Apache License, Version 2.0 (the "License"); you may - not use this file except in compliance with the License. You may obtain - a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - License for the specific language governing permissions and limitations - under the License. - -Image Location Strategy Modules -=============================== - -.. list-plugins:: glance.common.image_location_strategy.modules - :detailed: diff --git a/doc/source/index.rst b/doc/source/index.rst index b62053a4e1..58cd813161 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -14,15 +14,16 @@ License for the specific language governing permissions and limitations under the License. +================================== Welcome to Glance's documentation! ================================== -The Glance project provides a service where users can upload and discover -data assets that are meant to be used with other services. This currently -includes images and metadata definitions. +The Image service (glance) project provides a service where users can upload +and discover data assets that are meant to be used with other services. +This currently includes images and metadata definitions. Glance image services include discovering, registering, and -retrieving virtual machine images. Glance has a RESTful API that allows +retrieving virtual machine (VM) images. Glance has a RESTful API that allows querying of VM image metadata as well as retrieval of the actual image. .. include:: deprecation-note.inc @@ -31,58 +32,83 @@ VM images made available through Glance can be stored in a variety of locations from simple filesystems to object-storage systems like the OpenStack Swift project. -Glance, as with all OpenStack projects, is written with the following design -guidelines in mind: - -* **Component based architecture**: Quickly add new behaviors -* **Highly available**: Scale to very serious workloads -* **Fault tolerant**: Isolated processes avoid cascading failures -* **Recoverable**: Failures should be easy to diagnose, debug, and rectify -* **Open standards**: Be a reference implementation for a community-driven api - -This documentation is generated by the Sphinx toolkit and lives in the source -tree. Additional documentation on Glance and other components of OpenStack can -be found on the `OpenStack wiki`_. - -.. _`OpenStack wiki`: http://wiki.openstack.org - -Glance Background Concepts -========================== +To learn how to contribute to Glance, see: .. toctree:: - :maxdepth: 1 + :maxdepth: 2 + + contributing/index + +Ocata +~~~~~ + +To install Glance, see the Ocata Image service install guide for each distribution: + +- `Ubuntu `_ +- `CentOS and RHEL `_ +- `openSUSE and SUSE Linux Enterprise `_ + +Newton +~~~~~~ + +To install Glance, see the Ocata Image service install guide for each distribution: + +- `Ubuntu `_ +- `CentOS and RHEL `_ +- `openSUSE and SUSE Linux Enterprise `_ + +Developer reference +~~~~~~~~~~~~~~~~~~~ + +.. toctree:: + :maxdepth: 2 architecture database_architecture domain_model domain_implementation + +User guide +~~~~~~~~~~ + +.. TODO - move this content to docs.o.o + +.. toctree:: + :maxdepth: 2 + identifiers statuses - tasks formats common-image-properties metadefs-concepts + glanceapi + glanceclient + glancemetadefcatalogapi + signature + api/modules -Installing/Configuring Glance -============================= +Administration guide +~~~~~~~~~~~~~~~~~~~~ + +.. TODO - move this content to docs.o.o .. toctree:: - :maxdepth: 1 + :maxdepth: 2 - installing + tasks configuring sample-configuration authentication policies - image-location-strategy-modules - artifact-types flows property-protections opts/index requirements Operating Glance -================ +~~~~~~~~~~~~~~~~ + +.. TODO - move this content to docs.o.o .. toctree:: :maxdepth: 1 @@ -93,38 +119,4 @@ Operating Glance cache notifications -Using Glance -============ -.. toctree:: - :maxdepth: 1 - - glanceapi - glanceclient - glancemetadefcatalogapi - signature - -Glance Manual Pages -=================== - -.. toctree:: - :glob: - :maxdepth: 1 - - man/* - api/modules - -Contributing to Glance -====================== - -.. toctree:: - :maxdepth: 1 - - contributing/index - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` diff --git a/doc/source/man/footer.rst b/doc/source/man/footer.rst deleted file mode 100644 index 4e9f9aaf5b..0000000000 --- a/doc/source/man/footer.rst +++ /dev/null @@ -1,9 +0,0 @@ -SEE ALSO -======== - -* `OpenStack Glance `__ - -BUGS -==== - -* Glance bugs are tracked in Launchpad so you can view current bugs at `OpenStack Glance `__ diff --git a/doc/source/man/general_options.rst b/doc/source/man/general_options.rst deleted file mode 100644 index bc5976e3de..0000000000 --- a/doc/source/man/general_options.rst +++ /dev/null @@ -1,66 +0,0 @@ - **-h, --help** - Show the help message and exit - - **--version** - Print the version number and exit - - **-v, --verbose** - Print more verbose output - - **--noverbose** - Disable verbose output - - **-d, --debug** - Print debugging output (set logging level to DEBUG instead of - default WARNING level) - - **--nodebug** - Disable debugging output - - **--use-syslog** - Use syslog for logging - - **--nouse-syslog** - Disable the use of syslog for logging - - **--syslog-log-facility SYSLOG_LOG_FACILITY** - syslog facility to receive log lines - - **--config-dir DIR** - Path to a config directory to pull \*.conf files from. This - file set is sorted, to provide a predictable parse order - if individual options are over-ridden. The set is parsed after - the file(s) specified via previous --config-file, arguments hence - over-ridden options in the directory take precedence. This means - that configuration from files in a specified config-dir will - always take precedence over configuration from files specified - by --config-file, regardless to argument order. - - **--config-file PATH** - Path to a config file to use. Multiple config files can be - specified by using this flag multiple times, for example, - --config-file --config-file . Values in latter - files take precedence. - - **--log-config-append PATH** **--log-config PATH** - The name of logging configuration file. It does not - disable existing loggers, but just appends specified - logging configuration to any other existing logging - options. Please see the Python logging module documentation - for details on logging configuration files. The log-config - name for this option is deprecated. - - **--log-format FORMAT** - A logging.Formatter log message format string which may use any - of the available logging.LogRecord attributes. Default: None - - **--log-date-format DATE_FORMAT** - Format string for %(asctime)s in log records. Default: None - - **--log-file PATH, --logfile PATH** - (Optional) Name of log file to output to. If not set, logging - will go to stdout. - - **--log-dir LOG_DIR, --logdir LOG_DIR** - (Optional) The directory to keep log files in (will be prepended - to --log-file) diff --git a/doc/source/man/glanceapi.rst b/doc/source/man/glanceapi.rst deleted file mode 100644 index 63e1091d08..0000000000 --- a/doc/source/man/glanceapi.rst +++ /dev/null @@ -1,39 +0,0 @@ -========== -glance-api -========== - ---------------------------------------- -Server for the Glance Image Service API ---------------------------------------- - -: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-api [options] - -DESCRIPTION -=========== - -glance-api is a server daemon that serves the Glance API - -OPTIONS -======= - - **General options** - - .. include:: general_options.rst - -FILES -===== - - **/etc/glance/glance-api.conf** - Default configuration file for Glance API - -.. include:: footer.rst diff --git a/doc/source/man/glancecachecleaner.rst b/doc/source/man/glancecachecleaner.rst deleted file mode 100644 index 341a22e7b3..0000000000 --- a/doc/source/man/glancecachecleaner.rst +++ /dev/null @@ -1,47 +0,0 @@ -==================== -glance-cache-cleaner -==================== - ----------------------------------------------------------------- -Glance Image Cache Invalid Cache Entry and Stalled Image cleaner ----------------------------------------------------------------- - -: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-cache-cleaner [options] - -DESCRIPTION -=========== - -This is meant to be run as a periodic task from cron. - -If something goes wrong while we're caching an image (for example the fetch -times out, or an exception is raised), we create an 'invalid' entry. These -entries are left around for debugging purposes. However, after some period of -time, we want to clean these up. - -Also, if an incomplete image hangs around past the image_cache_stall_time -period, we automatically sweep it up. - -OPTIONS -======= - - **General options** - - .. include:: general_options.rst - -FILES -===== - - **/etc/glance/glance-cache.conf** - Default configuration file for the Glance Cache - -.. include:: footer.rst diff --git a/doc/source/man/glancecachemanage.rst b/doc/source/man/glancecachemanage.rst deleted file mode 100644 index e68123900e..0000000000 --- a/doc/source/man/glancecachemanage.rst +++ /dev/null @@ -1,88 +0,0 @@ -=================== -glance-cache-manage -=================== - ------------------------- -Cache management utility ------------------------- - -: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-cache-manage [options] [args] - -COMMANDS -======== - - **help ** - Output help for one of the commands below - - **list-cached** - List all images currently cached - - **list-queued** - List all images currently queued for caching - - **queue-image** - Queue an image for caching - - **delete-cached-image** - Purges an image from the cache - - **delete-all-cached-images** - Removes all images from the cache - - **delete-queued-image** - Deletes an image from the cache queue - - **delete-all-queued-images** - Deletes all images from the cache queue - -OPTIONS -======= - - **--version** - show program's version number and exit - - **-h, --help** - show this help message and exit - - **-v, --verbose** - Print more verbose output - - **-d, --debug** - Print more verbose output - - **-H ADDRESS, --host=ADDRESS** - Address of Glance API host. - Default: 0.0.0.0 - - **-p PORT, --port=PORT** - Port the Glance API host listens on. - Default: 9292 - - **-k, --insecure** - Explicitly allow glance to perform "insecure" SSL - (https) requests. The server's certificate will not be - verified against any certificate authorities. This - option should be used with caution. - - **-A TOKEN, --auth_token=TOKEN** - Authentication token to use to identify the client to the glance server - - **-f, --force** - Prevent select actions from requesting user confirmation - - **-S STRATEGY, --os-auth-strategy=STRATEGY** - Authentication strategy (keystone or noauth) - - .. include:: openstack_options.rst - -.. include:: footer.rst diff --git a/doc/source/man/glancecacheprefetcher.rst b/doc/source/man/glancecacheprefetcher.rst deleted file mode 100644 index 1bd5cff925..0000000000 --- a/doc/source/man/glancecacheprefetcher.rst +++ /dev/null @@ -1,40 +0,0 @@ -======================= -glance-cache-prefetcher -======================= - ------------------------------- -Glance Image Cache Pre-fetcher ------------------------------- - -: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-cache-prefetcher [options] - -DESCRIPTION -=========== - -This is meant to be run from the command line after queueing -images to be pretched. - -OPTIONS -======= - - **General options** - - .. include:: general_options.rst - -FILES -===== - - **/etc/glance/glance-cache.conf** - Default configuration file for the Glance Cache - -.. include:: footer.rst diff --git a/doc/source/man/glancecachepruner.rst b/doc/source/man/glancecachepruner.rst deleted file mode 100644 index c388550ceb..0000000000 --- a/doc/source/man/glancecachepruner.rst +++ /dev/null @@ -1,41 +0,0 @@ -=================== -glance-cache-pruner -=================== - -------------------- -Glance cache pruner -------------------- - -: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-cache-pruner [options] - -DESCRIPTION -=========== - -Prunes images from the Glance cache when the space exceeds the value -set in the image_cache_max_size configuration option. This is meant -to be run as a periodic task, perhaps every half-hour. - -OPTIONS -======= - - **General options** - - .. include:: general_options.rst - -FILES -===== - - **/etc/glance/glance-cache.conf** - Default configuration file for the Glance Cache - -.. include:: footer.rst diff --git a/doc/source/man/glancecontrol.rst b/doc/source/man/glancecontrol.rst deleted file mode 100644 index c6dc5b8e4a..0000000000 --- a/doc/source/man/glancecontrol.rst +++ /dev/null @@ -1,58 +0,0 @@ -============== -glance-control -============== - --------------------------------------- -Glance daemon start/stop/reload helper --------------------------------------- - -: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-control [options] [CONFPATH] - -Where is one of: - - all, api, glance-api, registry, glance-registry, scrubber, glance-scrubber - -And command is one of: - - start, status, stop, shutdown, restart, reload, force-reload - -And CONFPATH is the optional configuration file to use. - -OPTIONS -======= - - **General Options** - - .. include:: general_options.rst - - **--pid-file=PATH** - File to use as pid file. Default: - /var/run/glance/$server.pid - - **--await-child DELAY** - Period to wait for service death in order to report - exit code (default is to not wait at all) - - **--capture-output** - Capture stdout/err in syslog instead of discarding - - **--nocapture-output** - The inverse of --capture-output - - **--norespawn** - The inverse of --respawn - - **--respawn** - Restart service on unexpected death - -.. include:: footer.rst diff --git a/doc/source/man/glancemanage.rst b/doc/source/man/glancemanage.rst deleted file mode 100644 index 59ca50a6ce..0000000000 --- a/doc/source/man/glancemanage.rst +++ /dev/null @@ -1,109 +0,0 @@ -============= -glance-manage -============= - -------------------------- -Glance Management Utility -------------------------- - -: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-manage [options] - -DESCRIPTION -=========== - -glance-manage is a utility for managing and configuring a Glance installation. -One important use of glance-manage is to setup the database. To do this run:: - - glance-manage db_sync - -Note: glance-manage commands can be run either like this:: - - glance-manage db sync - -or with the db commands concatenated, like this:: - - glance-manage db_sync - - - -COMMANDS -======== - - **db** - This is the prefix for the commands below when used with a space - rather than a _. For example "db version". - - **db_version** - This will print the current migration level of a glance database. - - **db_upgrade [VERSION]** - This will take an existing database and upgrade it to the - specified VERSION. - - **db_version_control** - Place the database under migration control. - - **db_sync [VERSION]** - Place an existing database under migration control and upgrade it to - the specified VERSION. - - **db_expand** - Run this command to expand the database as the first step of a rolling - upgrade process. - - **db_migrate** - Run this command to migrate the database as the second step of a - rolling upgrade process. - - **db_contract** - Run this command to contract the database as the last step of a rolling - upgrade process. - - **db_export_metadefs [PATH | PREFIX]** - Export the metadata definitions into json format. By default the - definitions are exported to /etc/glance/metadefs directory. - **Note: this command will overwrite existing files in the supplied or - default path.** - - **db_load_metadefs [PATH]** - Load the metadata definitions into glance database. By default the - definitions are imported from /etc/glance/metadefs directory. - - **db_unload_metadefs** - Unload the metadata definitions. Clears the contents of all the glance - db tables including metadef_namespace_resource_types, metadef_tags, - metadef_objects, metadef_resource_types, metadef_namespaces and - metadef_properties. - -OPTIONS -======= - - **General Options** - - .. include:: general_options.rst - -.. include:: footer.rst - -CONFIGURATION -============= - -The following paths are searched for a ``glance-manage.conf`` file in the -following order: - -* ``~/.glance`` -* ``~/`` -* ``/etc/glance`` -* ``/etc`` - -All options set in ``glance-manage.conf`` override those set in -``glance-registry.conf`` and ``glance-api.conf``. diff --git a/doc/source/man/glanceregistry.rst b/doc/source/man/glanceregistry.rst deleted file mode 100644 index 5e7703cabc..0000000000 --- a/doc/source/man/glanceregistry.rst +++ /dev/null @@ -1,40 +0,0 @@ -=============== -glance-registry -=============== - --------------------------------------- -Server for the Glance Registry 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-registry [options] - -DESCRIPTION -=========== - -glance-registry is a server daemon that serves image metadata through a -REST-like API. - -OPTIONS -======= - - **General options** - - .. include:: general_options.rst - -FILES -===== - - **/etc/glance/glance-registry.conf** - Default configuration file for Glance Registry - -.. include:: footer.rst diff --git a/doc/source/man/glancereplicator.rst b/doc/source/man/glancereplicator.rst deleted file mode 100644 index 950baf2cca..0000000000 --- a/doc/source/man/glancereplicator.rst +++ /dev/null @@ -1,90 +0,0 @@ -================= -glance-replicator -================= - ---------------------------------------------- -Replicate images across multiple data centers ---------------------------------------------- - -: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-replicator [options] [args] - -DESCRIPTION -=========== - -glance-replicator is a utility can be used to populate a new glance -server using the images stored in an existing glance server. The images -in the replicated glance server preserve the uuids, metadata, and image -data from the original. - -COMMANDS -======== - - **help ** - Output help for one of the commands below - - **compare** - What is missing from the slave glance? - - **dump** - Dump the contents of a glance instance to local disk. - - **livecopy** - Load the contents of one glance instance into another. - - **load** - Load the contents of a local directory into glance. - - **size** - Determine the size of a glance instance if dumped to disk. - -OPTIONS -======= - - **-h, --help** - Show this help message and exit - - **-c CHUNKSIZE, --chunksize=CHUNKSIZE** - Amount of data to transfer per HTTP write - - **-d, --debug** - Print debugging information - - **-D DONTREPLICATE, --dontreplicate=DONTREPLICATE** - List of fields to not replicate - - **-m, --metaonly** - Only replicate metadata, not images - - **-l LOGFILE, --logfile=LOGFILE** - Path of file to log to - - **-s, --syslog** - Log to syslog instead of a file - - **-t TOKEN, --token=TOKEN** - Pass in your authentication token if you have one. If - you use this option the same token is used for both - the master and the slave. - - **-M MASTERTOKEN, --mastertoken=MASTERTOKEN** - Pass in your authentication token if you have one. - This is the token used for the master. - - **-S SLAVETOKEN, --slavetoken=SLAVETOKEN** - Pass in your authentication token if you have one. - This is the token used for the slave. - - **-v, --verbose** - Print more verbose output - -.. include:: footer.rst diff --git a/doc/source/man/glancescrubber.rst b/doc/source/man/glancescrubber.rst deleted file mode 100644 index 64dc40438b..0000000000 --- a/doc/source/man/glancescrubber.rst +++ /dev/null @@ -1,63 +0,0 @@ -=============== -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 diff --git a/doc/source/man/openstack_options.rst b/doc/source/man/openstack_options.rst deleted file mode 100644 index 4602bb9a89..0000000000 --- a/doc/source/man/openstack_options.rst +++ /dev/null @@ -1,22 +0,0 @@ - **-os-auth-token=OS_AUTH_TOKEN** - Defaults to env[OS_AUTH_TOKEN] - - **--os-username=OS_USERNAME** - Defaults to env[OS_USERNAME] - - **--os-password=OS_PASSWORD** - Defaults to env[OS_PASSWORD] - - **--os-region-name=OS_REGION_NAME** - Defaults to env[OS_REGION_NAME] - - **--os-tenant-id=OS_TENANT_ID** - Defaults to env[OS_TENANT_ID] - - **--os-tenant-name=OS_TENANT_NAME** - Defaults to env[OS_TENANT_NAME] - - **--os-auth-url=OS_AUTH_URL** - Defaults to env[OS_AUTH_URL] - -