openstack/nova
Code Issues Proposed changes

Fix indentation in doc/source/cli/*

Browse Source 
Current indentation was wrongly interpreted as quotes.

Change-Id: I731d8833e69e6bed12f5637d6bb3248b890c18ab
This commit is contained in:
David Rabel
2018-03-02 11:32:59 +01:00
committed by Stephen Finucane
parent b1173396ed
commit fcda5c2d1a
18 changed files with 55 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
doc/source/cli/nova-api-metadata.rst
View File

@@ -16,6 +16,8 @@ Server for the Nova Metadata API
Synopsis Synopsis
======== ========
::
nova-api-metadata [options] nova-api-metadata [options]
Description Description
@@ -26,7 +28,7 @@ Description
Options Options
======= =======
**General options** **General options**
Files Files
===== =====

4
doc/source/cli/nova-api-os-compute.rst
View File

@@ -16,6 +16,8 @@ Server for the Nova OpenStack Compute APIs
Synopsis Synopsis
======== ========
::
nova-api-os-compute [options] nova-api-os-compute [options]
Description Description
@@ -27,7 +29,7 @@ API
Options Options
======= =======
**General options** **General options**
Files Files
===== =====

4
doc/source/cli/nova-api.rst
View File

@@ -16,6 +16,8 @@ Server for the OpenStack Compute APIs
Synopsis Synopsis
======== ========
::
nova-api [options] nova-api [options]
Description Description
@@ -27,7 +29,7 @@ separate greenthreads
Options Options
======= =======
**General options** **General options**
Files Files
===== =====

4
doc/source/cli/nova-cells.rst
View File

@@ -16,6 +16,8 @@ Server for the Nova Cells
Synopsis Synopsis
======== ========
::
nova-cells [options] nova-cells [options]
Description Description
@@ -34,7 +36,7 @@ for new instances.
Options Options
======= =======
**General options** **General options**
Files Files
===== =====

4
doc/source/cli/nova-compute.rst
View File

@@ -16,6 +16,8 @@ Nova Compute Server
Synopsis Synopsis
======== ========
::
nova-compute [options] nova-compute [options]
Description Description
@@ -29,7 +31,7 @@ state, attaching persistent storage, and terminating the instance.
Options Options
======= =======
**General options** **General options**
Files Files
===== =====

4
doc/source/cli/nova-conductor.rst
View File

@@ -16,6 +16,8 @@ Server for the Nova Conductor
Synopsis Synopsis
======== ========
::
nova-conductor [options] nova-conductor [options]
Description Description
@@ -27,7 +29,7 @@ which provides coordination and database query support for Nova.
Options Options
======= =======
**General options** **General options**
Files Files
===== =====

4
doc/source/cli/nova-console.rst
View File

@@ -16,6 +16,8 @@ Nova Console Server
Synopsis Synopsis
======== ========
::
nova-console [options] nova-console [options]
Description Description
@@ -27,7 +29,7 @@ is a console proxy to set up multi-tenant VM console access, e.g. with `XVP`.
Options Options
======= =======
**General options** **General options**
Files Files
===== =====

4
doc/source/cli/nova-consoleauth.rst
View File

@@ -16,6 +16,8 @@ Nova Console Authentication Server
Synopsis Synopsis
======== ========
::
nova-consoleauth [options] nova-consoleauth [options]
Description Description
@@ -27,7 +29,7 @@ service, which provides authentication for Nova consoles.
Options Options
======= =======
**General options** **General options**
Files Files
===== =====

4
doc/source/cli/nova-dhcpbridge.rst
View File

@@ -16,6 +16,8 @@ Handles Lease Database updates from DHCP servers
Synopsis Synopsis
======== ========
::
nova-dhcpbridge [options] nova-dhcpbridge [options]
Description Description
@@ -31,7 +33,7 @@ and flatDHCP). `nova-dhcpbridge` should not be run as a daemon.
Options Options
======= =======
**General options** **General options**
Files Files
===== =====

26
doc/source/cli/nova-manage.rst
View File

@@ -16,6 +16,8 @@ Control and manage cloud computer instances
Synopsis Synopsis
======== ========
::
nova-manage <category> <action> [<args>] nova-manage <category> <action> [<args>]
Description Description
@@ -46,11 +48,9 @@ Nova Database
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
``nova-manage db version`` ``nova-manage db version``
Print the current main database version. Print the current main database version.
``nova-manage db sync [--version <version>] [--local_cell]`` ``nova-manage db sync [--version <version>] [--local_cell]``
Upgrade the main database schema up to the most recent version or Upgrade the main database schema up to the most recent version or
``--version`` if specified. By default, this command will also attempt to ``--version`` if specified. By default, this command will also attempt to
upgrade the schema for the cell0 database if it is mapped (see the upgrade the schema for the cell0 database if it is mapped (see the
@@ -61,7 +61,6 @@ Nova Database
nova-manage. nova-manage.
``nova-manage db archive_deleted_rows [--max_rows <number>] [--verbose] [--until-complete] [--purge]`` ``nova-manage db archive_deleted_rows [--max_rows <number>] [--verbose] [--until-complete] [--purge]``
Move deleted rows from production tables to shadow tables. Note that the Move deleted rows from production tables to shadow tables. Note that the
corresponding rows in the instance_mappings and request_specs tables of the corresponding rows in the instance_mappings and request_specs tables of the
API database are purged when instance records are archived. Specifying API database are purged when instance records are archived. Specifying
@@ -74,7 +73,6 @@ Nova Database
<date>`` manually after archiving is complete. <date>`` manually after archiving is complete.
``nova-manage db purge [--all] [--before <date>] [--verbose] [--all-cells]`` ``nova-manage db purge [--all] [--before <date>] [--verbose] [--all-cells]``
Delete rows from shadow tables. Specifying --all will delete all data from Delete rows from shadow tables. Specifying --all will delete all data from
all shadow tables. Specifying --before will delete data from all shadow tables all shadow tables. Specifying --before will delete data from all shadow tables
that is older than the date provided. Date strings may be fuzzy, such as that is older than the date provided. Date strings may be fuzzy, such as
@@ -86,11 +84,9 @@ Nova Database
data was deleted, 4 if the list of cells cannot be obtained. data was deleted, 4 if the list of cells cannot be obtained.
``nova-manage db null_instance_uuid_scan [--delete]`` ``nova-manage db null_instance_uuid_scan [--delete]``
Lists and optionally deletes database records where instance_uuid is NULL. Lists and optionally deletes database records where instance_uuid is NULL.
``nova-manage db online_data_migrations [--max-count]`` ``nova-manage db online_data_migrations [--max-count]``
Perform data migration to update all live data. Return exit code 0 if Perform data migration to update all live data. Return exit code 0 if
migrations were successful or exit code 1 for partial updates. This command migrations were successful or exit code 1 for partial updates. This command
should be called after upgrading database schema and nova services on all should be called after upgrading database schema and nova services on all
@@ -102,7 +98,6 @@ Nova Database
complete. complete.
``nova-manage db ironic_flavor_migration [--all] [--host] [--node] [--resource_class]`` ``nova-manage db ironic_flavor_migration [--all] [--host] [--node] [--resource_class]``
Perform the ironic flavor migration process against the database Perform the ironic flavor migration process against the database
while services are offline. This is `not recommended` for most while services are offline. This is `not recommended` for most
people. The ironic compute driver will do this online and as people. The ironic compute driver will do this online and as
@@ -131,12 +126,11 @@ Nova API Database
~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~
``nova-manage api_db version`` ``nova-manage api_db version``
Print the current cells api database version. Print the current cells api database version.
``nova-manage api_db sync`` ``nova-manage api_db sync``
Sync the api cells database up to the most recent version. This is the
Sync the api cells database up to the most recent version. This is the standard way to create the db as well. standard way to create the db as well.
.. _man-page-cells-v2: .. _man-page-cells-v2:
@@ -144,7 +138,6 @@ Nova Cells v2
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
``nova-manage cell_v2 simple_cell_setup [--transport-url <transport_url>]`` ``nova-manage cell_v2 simple_cell_setup [--transport-url <transport_url>]``
Setup a fresh cells v2 environment; this should not be used if you Setup a fresh cells v2 environment; this should not be used if you
currently have a cells v1 environment. Returns 0 if setup is completed currently have a cells v1 environment. Returns 0 if setup is completed
(or has already been done), 1 if no hosts are reporting (and cannot be (or has already been done), 1 if no hosts are reporting (and cannot be
@@ -152,7 +145,6 @@ Nova Cells v2
and 2 if run in a cells v1 environment. and 2 if run in a cells v1 environment.
``nova-manage cell_v2 map_cell0 [--database_connection <database_connection>]`` ``nova-manage cell_v2 map_cell0 [--database_connection <database_connection>]``
Create a cell mapping to the database connection for the cell0 database. Create a cell mapping to the database connection for the cell0 database.
If a database_connection is not specified, it will use the one defined by If a database_connection is not specified, it will use the one defined by
``[database]/connection`` in the configuration file passed to nova-manage. ``[database]/connection`` in the configuration file passed to nova-manage.
@@ -162,7 +154,6 @@ Nova Cells v2
successfully or already setup. successfully or already setup.
``nova-manage cell_v2 map_instances --cell_uuid <cell_uuid> [--max-count <max_count>]`` ``nova-manage cell_v2 map_instances --cell_uuid <cell_uuid> [--max-count <max_count>]``
Map instances to the provided cell. Instances in the nova database will Map instances to the provided cell. Instances in the nova database will
be queried from oldest to newest and mapped to the provided cell. A be queried from oldest to newest and mapped to the provided cell. A
max_count can be set on the number of instance to map in a single run. max_count can be set on the number of instance to map in a single run.
@@ -176,7 +167,6 @@ Nova Cells v2
specifying a custom value and run the command until it exits with 0. specifying a custom value and run the command until it exits with 0.
``nova-manage cell_v2 map_cell_and_hosts [--name <cell_name>] [--transport-url <transport_url>] [--verbose]`` ``nova-manage cell_v2 map_cell_and_hosts [--name <cell_name>] [--transport-url <transport_url>] [--verbose]``
Create a cell mapping to the database connection and message queue Create a cell mapping to the database connection and message queue
transport url, and map hosts to that cell. The database connection transport url, and map hosts to that cell. The database connection
comes from the ``[database]/connection`` defined in the configuration comes from the ``[database]/connection`` defined in the configuration
@@ -187,7 +177,6 @@ Nova Cells v2
on successful completion, and 1 if the transport url is missing. on successful completion, and 1 if the transport url is missing.
``nova-manage cell_v2 verify_instance --uuid <instance_uuid> [--quiet]`` ``nova-manage cell_v2 verify_instance --uuid <instance_uuid> [--quiet]``
Verify instance mapping to a cell. This command is useful to determine if Verify instance mapping to a cell. This command is useful to determine if
the cells v2 environment is properly setup, specifically in terms of the the cells v2 environment is properly setup, specifically in terms of the
cell, host, and instance mapping records required. Returns 0 when the cell, host, and instance mapping records required. Returns 0 when the
@@ -200,7 +189,6 @@ Nova Cells v2
which still has an instance mapping. which still has an instance mapping.
``nova-manage cell_v2 create_cell [--name <cell_name>] [--transport-url <transport_url>] [--database_connection <database_connection>] [--verbose]`` ``nova-manage cell_v2 create_cell [--name <cell_name>] [--transport-url <transport_url>] [--database_connection <database_connection>] [--verbose]``
Create a cell mapping to the database connection and message queue Create a cell mapping to the database connection and message queue
transport url. If a database_connection is not specified, it will use the transport url. If a database_connection is not specified, it will use the
one defined by ``[database]/connection`` in the configuration file passed one defined by ``[database]/connection`` in the configuration file passed
@@ -212,7 +200,6 @@ Nova Cells v2
transport url and database connection combination. transport url and database connection combination.
``nova-manage cell_v2 discover_hosts [--cell_uuid <cell_uuid>] [--verbose] [--strict]`` ``nova-manage cell_v2 discover_hosts [--cell_uuid <cell_uuid>] [--verbose] [--strict]``
Searches cells, or a single cell, and maps found hosts. This command will Searches cells, or a single cell, and maps found hosts. This command will
check the database for each cell (or a single one if passed in) and map any check the database for each cell (or a single one if passed in) and map any
hosts which are not currently mapped. If a host is already mapped nothing hosts which are not currently mapped. If a host is already mapped nothing
@@ -224,13 +211,11 @@ Nova Cells v2
code 1). code 1).
``nova-manage cell_v2 list_cells [--verbose]`` ``nova-manage cell_v2 list_cells [--verbose]``
Lists the v2 cells in the deployment. By default only the cell name and Lists the v2 cells in the deployment. By default only the cell name and
uuid are shown. Use the --verbose option to see transport url and database uuid are shown. Use the --verbose option to see transport url and database
connection details. connection details.
``nova-manage cell_v2 delete_cell [--force] --cell_uuid <cell_uuid>`` ``nova-manage cell_v2 delete_cell [--force] --cell_uuid <cell_uuid>``
Delete a cell by the given uuid. Returns 0 if the empty cell is found and Delete a cell by the given uuid. Returns 0 if the empty cell is found and
deleted successfully or the cell that has hosts is found and the cell, hosts deleted successfully or the cell that has hosts is found and the cell, hosts
and the instance_mappings are deleted successfully with ``--force`` option and the instance_mappings are deleted successfully with ``--force`` option
@@ -242,14 +227,12 @@ Nova Cells v2
again without the ``--force`` option. again without the ``--force`` option.
``nova-manage cell_v2 list_hosts [--cell_uuid <cell_uuid>]`` ``nova-manage cell_v2 list_hosts [--cell_uuid <cell_uuid>]``
Lists the hosts in one or all v2 cells. By default hosts in all v2 cells Lists the hosts in one or all v2 cells. By default hosts in all v2 cells
are listed. Use the --cell_uuid option to list hosts in a specific cell. are listed. Use the --cell_uuid option to list hosts in a specific cell.
If the cell is not found by uuid, this command will return an exit code If the cell is not found by uuid, this command will return an exit code
of 1. Otherwise, the exit code will be 0. of 1. Otherwise, the exit code will be 0.
``nova-manage cell_v2 update_cell --cell_uuid <cell_uuid> [--name <cell_name>] [--transport-url <transport_url>] [--database_connection <database_connection>]`` ``nova-manage cell_v2 update_cell --cell_uuid <cell_uuid> [--name <cell_name>] [--transport-url <transport_url>] [--database_connection <database_connection>]``
Updates the properties of a cell by the given uuid. If a Updates the properties of a cell by the given uuid. If a
database_connection is not specified, it will attempt to use the one database_connection is not specified, it will attempt to use the one
defined by ``[database]/connection`` in the configuration file. If a defined by ``[database]/connection`` in the configuration file. If a
@@ -267,7 +250,6 @@ Nova Cells v2
values. Use caution when changing these values. values. Use caution when changing these values.
``nova-manage cell_v2 delete_host --cell_uuid <cell_uuid> --host <host>`` ``nova-manage cell_v2 delete_host --cell_uuid <cell_uuid> --host <host>``
Delete a host by the given host name and the given cell uuid. Returns 0 Delete a host by the given host name and the given cell uuid. Returns 0
if the empty host is found and deleted successfully, 1 if a cell with if the empty host is found and deleted successfully, 1 if a cell with
that uuid could not be found, 2 if a host with that name could not be that uuid could not be found, 2 if a host with that name could not be

4
doc/source/cli/nova-network.rst
View File

@@ -16,6 +16,8 @@ Nova Network Server
Synopsis Synopsis
======== ========
::
nova-network [options] nova-network [options]
Description Description
@@ -32,7 +34,7 @@ is responsible for allocating IPs and setting up the network
Options Options
======= =======
**General options** **General options**
Files Files
===== =====

4
doc/source/cli/nova-novncproxy.rst
View File

@@ -16,6 +16,8 @@ Websocket novnc Proxy for OpenStack Nova noVNC consoles
Synopsis Synopsis
======== ========
::
nova-novncproxy [options] nova-novncproxy [options]
Description Description
@@ -28,7 +30,7 @@ Nova noVNC consoles.
Options Options
======= =======
**General options** **General options**
Files Files
===== =====

4
doc/source/cli/nova-rootwrap.rst
View File

@@ -16,6 +16,8 @@ Root wrapper for Nova
Synopsis Synopsis
======== ========
::
nova-rootwrap [options] nova-rootwrap [options]
Description Description
@@ -44,7 +46,7 @@ To make allowed commands node-specific, your packaging should only install
Options Options
======= =======
**General options** **General options**
Files Files
===== =====

4
doc/source/cli/nova-scheduler.rst
View File

@@ -16,6 +16,8 @@ Nova Scheduler
Synopsis Synopsis
======== ========
::
nova-scheduler [options] nova-scheduler [options]
Description Description
@@ -27,7 +29,7 @@ which is responsible for picking a compute node to run a given instance on.
Options Options
======= =======
**General options** **General options**
Files Files
===== =====

4
doc/source/cli/nova-serialproxy.rst
View File

@@ -16,6 +16,8 @@ Websocket serial Proxy for OpenStack Nova serial ports
Synopsis Synopsis
======== ========
::
nova-serialproxy [options] nova-serialproxy [options]
Description Description
@@ -28,7 +30,7 @@ OpenStack Nova serial ports.
Options Options
======= =======
**General options** **General options**
Files Files
===== =====

4
doc/source/cli/nova-spicehtml5proxy.rst
View File

@@ -16,6 +16,8 @@ Websocket Proxy for OpenStack Nova SPICE HTML5 consoles
Synopsis Synopsis
======== ========
::
nova-spicehtml5proxy [options] nova-spicehtml5proxy [options]
Description Description
@@ -28,7 +30,7 @@ with OpenStack Nova SPICE HTML5 consoles.
Options Options
======= =======
**General options** **General options**
Files Files
===== =====

3
doc/source/cli/nova-status.rst
View File

@@ -16,6 +16,8 @@ CLI interface for nova status commands
Synopsis Synopsis
======== ========
::
nova-status <category> <action> [<args>] nova-status <category> <action> [<args>]
Description Description
@@ -53,7 +55,6 @@ Upgrade
~~~~~~~ ~~~~~~~
``nova-status upgrade check`` ``nova-status upgrade check``
Performs a release-specific readiness check before restarting services with Performs a release-specific readiness check before restarting services with
new code. This command expects to have complete configuration and access new code. This command expects to have complete configuration and access
to databases and services within a cell. For example, this check may query to databases and services within a cell. For example, this check may query

4
doc/source/cli/nova-xvpvncproxy.rst
View File

@@ -16,6 +16,8 @@ XVP VNC Console Proxy Server
Synopsis Synopsis
======== ========
::
nova-xvpvncproxy [options] nova-xvpvncproxy [options]
Description Description
@@ -28,7 +30,7 @@ Xen hypervisor.
Options Options
======= =======
**General options** **General options**
Files Files
===== =====