diff --git a/doc/source/admin/controllingservers.rst b/doc/source/admin/controllingservers.rst index a397103abd..63eaa1adde 100644 --- a/doc/source/admin/controllingservers.rst +++ b/doc/source/admin/controllingservers.rst @@ -182,7 +182,7 @@ a configuration file when starting the server. In order for your launched glance service to be monitored for unexpected death -and respawned if necessary, use the following option: +and respawned if necessary, use the following option:: $ sudo glance-control [service] start --respawn ... @@ -194,7 +194,7 @@ services (where process death occurred within one second of the last launch). By default, output from glance services is discarded when launched with ``glance-control``. -In order to capture such output via syslog, use the following option: +In order to capture such output via syslog, use the following option:: $ sudo glance-control --capture-output ... diff --git a/doc/source/admin/db-sqlalchemy-migrate.rst b/doc/source/admin/db-sqlalchemy-migrate.rst index 6f5dea665c..27e2101397 100644 --- a/doc/source/admin/db-sqlalchemy-migrate.rst +++ b/doc/source/admin/db-sqlalchemy-migrate.rst @@ -27,13 +27,14 @@ 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': +The commands should be executed as a subcommand of 'db':: glance-manage db Sync the Database ----------------- +:: glance-manage db sync @@ -42,6 +43,7 @@ Place a database under migration control and upgrade, creating it first if neces Determining the Database Version -------------------------------- +:: glance-manage db version @@ -50,6 +52,7 @@ This will print the current migration level of a Glance database. Upgrading an Existing Database ------------------------------ +:: glance-manage db upgrade diff --git a/doc/source/admin/db.rst b/doc/source/admin/db.rst index 10b5b5d182..59dcfeef4a 100644 --- a/doc/source/admin/db.rst +++ b/doc/source/admin/db.rst @@ -20,7 +20,7 @@ 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': +The commands should be executed as a subcommand of 'db':: glance-manage db @@ -77,6 +77,7 @@ migrations: Sync the Database ----------------- +:: glance-manage db sync [VERSION] @@ -100,6 +101,7 @@ specified VERSION or to the latest migration level if VERSION is not specified. Determining the Database Version -------------------------------- +:: glance-manage db version @@ -108,6 +110,7 @@ This will print the current migration level of a Glance database. Upgrading an Existing Database ------------------------------ +:: glance-manage db upgrade [VERSION] diff --git a/doc/source/admin/index.rst b/doc/source/admin/index.rst index 33fa5c9c2d..24656e0499 100644 --- a/doc/source/admin/index.rst +++ b/doc/source/admin/index.rst @@ -9,7 +9,6 @@ cache policies property-protections - requirements apache-httpd notifications tasks diff --git a/doc/source/admin/rollingupgrades.rst b/doc/source/admin/rollingupgrades.rst index 92008d7396..5d023e2178 100644 --- a/doc/source/admin/rollingupgrades.rst +++ b/doc/source/admin/rollingupgrades.rst @@ -79,13 +79,13 @@ Following is the process to upgrade Glance with zero downtime: accordingly. **DO NOT** start the Glance services on the NEW NODE at this time. -4. Using the NEW NODE, expand the database using the command +4. Using the NEW NODE, expand the database using the command:: - ``glance-manage db expand``. + glance-manage db expand -5. Then, also on the NEW NODE, perform the data migrations using the command +5. Then, also on the NEW NODE, perform the data migrations using the command:: - ``glance-manage db migrate``. + glance-manage db migrate *The data migrations must be completed before you proceed to the next step.* @@ -104,9 +104,7 @@ Following is the process to upgrade Glance with zero downtime: 8. After **ALL** of the nodes have been upgraded to run the new Glance services, and there are **NO** nodes running any old Glance services, - contract the database by running the command - - ``glance manage db contract`` - - from any one of the upgraded nodes. + contract the database by running the command from any one of the upgraded + nodes:: + glance manage db contract diff --git a/doc/source/admin/zero-downtime-db-upgrade.rst b/doc/source/admin/zero-downtime-db-upgrade.rst index 0c55c3782e..3bae8e85cc 100644 --- a/doc/source/admin/zero-downtime-db-upgrade.rst +++ b/doc/source/admin/zero-downtime-db-upgrade.rst @@ -106,6 +106,7 @@ following operations. Expanding the Database ---------------------- +:: glance-manage db expand @@ -116,6 +117,7 @@ any new services are started. Migrating the Data ------------------ +:: glance-manage db migrate @@ -126,6 +128,7 @@ are started. Contracting the Database ------------------------ +:: glance-manage db contract diff --git a/doc/source/cli/footer.txt b/doc/source/cli/footer.txt index 3f236d09ea..fff45a4e6b 100644 --- a/doc/source/cli/footer.txt +++ b/doc/source/cli/footer.txt @@ -1,4 +1,3 @@ -.. -*- mode: rst -*- SEE ALSO ======== diff --git a/doc/source/cli/general_options.txt b/doc/source/cli/general_options.txt index 0a0f55f263..293ed3d213 100644 --- a/doc/source/cli/general_options.txt +++ b/doc/source/cli/general_options.txt @@ -1,4 +1,3 @@ -.. -*- mode: rst -*- **-h, --help** Show the help message and exit diff --git a/doc/source/cli/header.txt b/doc/source/cli/header.txt index 7c53f12adc..ef302f4298 100644 --- a/doc/source/cli/header.txt +++ b/doc/source/cli/header.txt @@ -1,4 +1,3 @@ -.. -*- mode: rst -*- :Author: glance@lists.launchpad.net :Date: 2017-09-15 diff --git a/doc/source/cli/openstack_options.txt b/doc/source/cli/openstack_options.txt index ad2a858f86..1af6af2fb0 100644 --- a/doc/source/cli/openstack_options.txt +++ b/doc/source/cli/openstack_options.txt @@ -1,4 +1,3 @@ -.. -*- mode: rst -*- **-os-auth-token=OS_AUTH_TOKEN** Defaults to env[OS_AUTH_TOKEN] diff --git a/doc/source/configuration/configuring.rst b/doc/source/configuration/configuring.rst index 81e61e1c2a..937c1b1171 100644 --- a/doc/source/configuration/configuring.rst +++ b/doc/source/configuration/configuring.rst @@ -1,4 +1,4 @@ - +.. Copyright 2011 OpenStack Foundation All Rights Reserved. @@ -113,7 +113,7 @@ Glance has a few command-line options that are common to all Glance programs: If --config-dir is set, then --config-file is ignored. - An example usage would be: + An example usage would be:: $ glance-api --config-dir=/etc/glance/glance-api.d