doc: Rework man pages
Rework the man pages by: - Wording the synopsis sections similarly for all commands - Not using upper-case section names, as this is unnecessary and results in worse HTML output - Formatting code and file names as literals The 'nova-idmapshift' man page is excluded as this utility will be removed shortly. Change-Id: I67914a757f9436461960a8d6b92d157f59ccad66
This commit is contained in:
Stephen Finucane
parent
9ed0838da3
commit
3a6e1e2396
|
|
@ -2,9 +2,9 @@
|
|||
nova-api-metadata
|
||||
=================
|
||||
|
||||
---------------------------------
|
||||
--------------------------------
|
||||
Server for the Nova Metadata API
|
||||
---------------------------------
|
||||
--------------------------------
|
||||
|
||||
:Author: openstack@lists.openstack.org
|
||||
:Date: 2012-09-27
|
||||
|
|
@ -13,37 +13,37 @@ Server for the Nova Metadata API
|
|||
:Manual section: 1
|
||||
:Manual group: cloud computing
|
||||
|
||||
SYNOPSIS
|
||||
Synopsis
|
||||
========
|
||||
|
||||
nova-api-metadata [options]
|
||||
|
||||
DESCRIPTION
|
||||
Description
|
||||
===========
|
||||
|
||||
nova-api-metadata is a server daemon that serves the Nova Metadata API
|
||||
`nova-api-metadata` is a server daemon that serves the Nova Metadata API
|
||||
|
||||
OPTIONS
|
||||
Options
|
||||
=======
|
||||
|
||||
**General options**
|
||||
|
||||
FILES
|
||||
========
|
||||
Files
|
||||
=====
|
||||
|
||||
* /etc/nova/nova.conf
|
||||
* /etc/nova/api-paste.ini
|
||||
* /etc/nova/policy.json
|
||||
* /etc/nova/rootwrap.conf
|
||||
* /etc/nova/rootwrap.d/
|
||||
* ``/etc/nova/nova.conf``
|
||||
* ``/etc/nova/api-paste.ini``
|
||||
* ``/etc/nova/policy.json``
|
||||
* ``/etc/nova/rootwrap.conf``
|
||||
* ``/etc/nova/rootwrap.d/``
|
||||
|
||||
SEE ALSO
|
||||
See Also
|
||||
========
|
||||
|
||||
* `OpenStack Nova <https://docs.openstack.org/nova/latest/>`__
|
||||
* `Using WSGI with Nova <https://docs.openstack.org/nova/latest/wsgi.html>`__
|
||||
|
||||
BUGS
|
||||
Bugs
|
||||
====
|
||||
|
||||
* Nova bugs are managed at Launchpad `Bugs : Nova <https://bugs.launchpad.net/nova>`__
|
||||
* Nova bugs are managed at `Launchpad <https://bugs.launchpad.net/nova>`__
|
||||
|
|
|
|||
|
|
@ -1,10 +1,10 @@
|
|||
====================
|
||||
===================
|
||||
nova-api-os-compute
|
||||
====================
|
||||
===================
|
||||
|
||||
-------------------------------------------
|
||||
------------------------------------------
|
||||
Server for the Nova OpenStack Compute APIs
|
||||
-------------------------------------------
|
||||
------------------------------------------
|
||||
|
||||
:Author: openstack@lists.openstack.org
|
||||
:Date: 2012-09-27
|
||||
|
|
@ -13,37 +13,38 @@ Server for the Nova OpenStack Compute APIs
|
|||
:Manual section: 1
|
||||
:Manual group: cloud computing
|
||||
|
||||
SYNOPSIS
|
||||
Synopsis
|
||||
========
|
||||
|
||||
nova-api-os-compute [options]
|
||||
|
||||
DESCRIPTION
|
||||
Description
|
||||
===========
|
||||
|
||||
nova-api-os-compute is a server daemon that serves the Nova OpenStack Compute API
|
||||
`nova-api-os-compute` is a server daemon that serves the Nova OpenStack Compute
|
||||
API
|
||||
|
||||
OPTIONS
|
||||
Options
|
||||
=======
|
||||
|
||||
**General options**
|
||||
|
||||
FILES
|
||||
========
|
||||
Files
|
||||
=====
|
||||
|
||||
* /etc/nova/nova.conf
|
||||
* /etc/nova/api-paste.ini
|
||||
* /etc/nova/policy.json
|
||||
* /etc/nova/rootwrap.conf
|
||||
* /etc/nova/rootwrap.d/
|
||||
* ``/etc/nova/nova.conf``
|
||||
* ``/etc/nova/api-paste.ini``
|
||||
* ``/etc/nova/policy.json``
|
||||
* ``/etc/nova/rootwrap.conf``
|
||||
* ``/etc/nova/rootwrap.d/``
|
||||
|
||||
SEE ALSO
|
||||
See Also
|
||||
========
|
||||
|
||||
* `OpenStack Nova <https://docs.openstack.org/nova/latest/>`__
|
||||
* `Using WSGI with Nova <https://docs.openstack.org/nova/latest/user/wsgi.html>`__
|
||||
|
||||
BUGS
|
||||
Bugs
|
||||
====
|
||||
|
||||
* Nova bugs are managed at Launchpad `Bugs : Nova <https://bugs.launchpad.net/nova>`__
|
||||
* Nova bugs are managed at `Launchpad <https://bugs.launchpad.net/nova>`__
|
||||
|
|
|
|||
|
|
@ -13,38 +13,38 @@ Server for the OpenStack Compute APIs
|
|||
:Manual section: 1
|
||||
:Manual group: cloud computing
|
||||
|
||||
SYNOPSIS
|
||||
Synopsis
|
||||
========
|
||||
|
||||
nova-api [options]
|
||||
|
||||
DESCRIPTION
|
||||
Description
|
||||
===========
|
||||
|
||||
nova-api is a server daemon that serves the metadata and compute APIs in
|
||||
`nova-api` is a server daemon that serves the metadata and compute APIs in
|
||||
separate greenthreads
|
||||
|
||||
OPTIONS
|
||||
Options
|
||||
=======
|
||||
|
||||
**General options**
|
||||
|
||||
FILES
|
||||
========
|
||||
Files
|
||||
=====
|
||||
|
||||
* /etc/nova/nova.conf
|
||||
* /etc/nova/api-paste.ini
|
||||
* /etc/nova/policy.json
|
||||
* /etc/nova/rootwrap.conf
|
||||
* /etc/nova/rootwrap.d/
|
||||
* ``/etc/nova/nova.conf``
|
||||
* ``/etc/nova/api-paste.ini``
|
||||
* ``/etc/nova/policy.json``
|
||||
* ``/etc/nova/rootwrap.conf``
|
||||
* ``/etc/nova/rootwrap.d/``
|
||||
|
||||
SEE ALSO
|
||||
See Also
|
||||
========
|
||||
|
||||
* `OpenStack Nova <https://docs.openstack.org/nova/latest/>`__
|
||||
* `Using WSGI with Nova <https://docs.openstack.org/nova/latest/user/wsgi.html>`__
|
||||
|
||||
BUGS
|
||||
Bugs
|
||||
====
|
||||
|
||||
* Nova bugs are managed at Launchpad `Bugs : Nova <https://bugs.launchpad.net/nova>`__
|
||||
* Nova bugs are managed at `Launchpad <https://bugs.launchpad.net/nova>`__
|
||||
|
|
|
|||
|
|
@ -2,9 +2,9 @@
|
|||
nova-cells
|
||||
==========
|
||||
|
||||
--------------------------------
|
||||
-------------------------
|
||||
Server for the Nova Cells
|
||||
--------------------------------
|
||||
-------------------------
|
||||
|
||||
:Author: openstack@lists.openstack.org
|
||||
:Date: 2012-09-27
|
||||
|
|
@ -13,17 +13,17 @@ Server for the Nova Cells
|
|||
:Manual section: 1
|
||||
:Manual group: cloud computing
|
||||
|
||||
SYNOPSIS
|
||||
Synopsis
|
||||
========
|
||||
|
||||
nova-cells [options]
|
||||
|
||||
DESCRIPTION
|
||||
Description
|
||||
===========
|
||||
|
||||
Starts the nova-cells service.
|
||||
Starts the `nova-cells` service.
|
||||
|
||||
The nova-cells service handles communication between cells and selects cells
|
||||
The `nova-cells` service handles communication between cells and selects cells
|
||||
for new instances.
|
||||
|
||||
.. warning:: Everything in this document is referring to Cells v1, which is
|
||||
|
|
@ -31,25 +31,25 @@ for new instances.
|
|||
as of the 16.0.0 Pike release. For information about commands to use
|
||||
with Cells v2, see the man page for :ref:`man-page-cells-v2`.
|
||||
|
||||
OPTIONS
|
||||
Options
|
||||
=======
|
||||
|
||||
**General options**
|
||||
|
||||
FILES
|
||||
========
|
||||
Files
|
||||
=====
|
||||
|
||||
* /etc/nova/nova.conf
|
||||
* /etc/nova/policy.json
|
||||
* /etc/nova/rootwrap.conf
|
||||
* /etc/nova/rootwrap.d/
|
||||
* ``/etc/nova/nova.conf``
|
||||
* ``/etc/nova/policy.json``
|
||||
* ``/etc/nova/rootwrap.conf``
|
||||
* ``/etc/nova/rootwrap.d/``
|
||||
|
||||
SEE ALSO
|
||||
See Also
|
||||
========
|
||||
|
||||
* `OpenStack Nova <https://docs.openstack.org/nova/latest/>`__
|
||||
|
||||
BUGS
|
||||
Bugs
|
||||
====
|
||||
|
||||
* Nova bugs are managed at Launchpad `Bugs : Nova <https://bugs.launchpad.net/nova>`__
|
||||
* Nova bugs are managed at `Launchpad <https://bugs.launchpad.net/nova>`__
|
||||
|
|
|
|||
|
|
@ -2,9 +2,9 @@
|
|||
nova-compute
|
||||
============
|
||||
|
||||
---------------------
|
||||
-------------------
|
||||
Nova Compute Server
|
||||
---------------------
|
||||
-------------------
|
||||
|
||||
:Author: openstack@lists.openstack.org
|
||||
:Date: 2012-09-27
|
||||
|
|
@ -13,38 +13,38 @@ Nova Compute Server
|
|||
:Manual section: 1
|
||||
:Manual group: cloud computing
|
||||
|
||||
SYNOPSIS
|
||||
Synopsis
|
||||
========
|
||||
|
||||
nova-compute [options]
|
||||
|
||||
DESCRIPTION
|
||||
Description
|
||||
===========
|
||||
|
||||
Handles all processes relating to instances (guest vms). nova-compute is
|
||||
responsible for building a disk image, launching it via the
|
||||
underlying virtualization driver, responding to calls to check its state,
|
||||
attaching persistent storage, and terminating it.
|
||||
`nova-compute` is a server daemon that serves the Nova Compute service, which
|
||||
is responsible for building a disk image, launching an instance via the
|
||||
underlying virtualization driver, responding to calls to check the instance's
|
||||
state, attaching persistent storage, and terminating the instance.
|
||||
|
||||
OPTIONS
|
||||
Options
|
||||
=======
|
||||
|
||||
**General options**
|
||||
|
||||
FILES
|
||||
========
|
||||
Files
|
||||
=====
|
||||
|
||||
* /etc/nova/nova.conf
|
||||
* /etc/nova/policy.json
|
||||
* /etc/nova/rootwrap.conf
|
||||
* /etc/nova/rootwrap.d/
|
||||
* ``/etc/nova/nova.conf``
|
||||
* ``/etc/nova/policy.json``
|
||||
* ``/etc/nova/rootwrap.conf``
|
||||
* ``/etc/nova/rootwrap.d/``
|
||||
|
||||
SEE ALSO
|
||||
See Also
|
||||
========
|
||||
|
||||
* `OpenStack Nova <https://docs.openstack.org/nova/latest/>`__
|
||||
|
||||
BUGS
|
||||
Bugs
|
||||
====
|
||||
|
||||
* Nova bugs are managed at Launchpad `Bugs : Nova <https://bugs.launchpad.net/nova>`__
|
||||
* Nova bugs are managed at `Launchpad <https://bugs.launchpad.net/nova>`__
|
||||
|
|
|
|||
|
|
@ -13,32 +13,33 @@ Server for the Nova Conductor
|
|||
:Manual section: 1
|
||||
:Manual group: cloud computing
|
||||
|
||||
SYNOPSIS
|
||||
Synopsis
|
||||
========
|
||||
|
||||
nova-conductor [options]
|
||||
|
||||
DESCRIPTION
|
||||
Description
|
||||
===========
|
||||
|
||||
nova-conductor is a server daemon that serves the Nova Conductor service, which provides coordination and database query support for Nova.
|
||||
`nova-conductor` is a server daemon that serves the Nova Conductor service,
|
||||
which provides coordination and database query support for Nova.
|
||||
|
||||
OPTIONS
|
||||
Options
|
||||
=======
|
||||
|
||||
**General options**
|
||||
|
||||
FILES
|
||||
Files
|
||||
=====
|
||||
|
||||
* /etc/nova/nova.conf
|
||||
* ``/etc/nova/nova.conf``
|
||||
|
||||
SEE ALSO
|
||||
See Also
|
||||
========
|
||||
|
||||
* `OpenStack Nova <https://docs.openstack.org/nova/latest/>`__
|
||||
|
||||
BUGS
|
||||
Bugs
|
||||
====
|
||||
|
||||
* Nova bugs are managed at Launchpad `Bugs : Nova <https://bugs.launchpad.net/nova>`__
|
||||
* Nova bugs are managed at `Launchpad <https://bugs.launchpad.net/nova>`__
|
||||
|
|
|
|||
|
|
@ -2,9 +2,9 @@
|
|||
nova-console
|
||||
============
|
||||
|
||||
----------------------------
|
||||
-------------------
|
||||
Nova Console Server
|
||||
----------------------------
|
||||
-------------------
|
||||
|
||||
:Author: openstack@lists.openstack.org
|
||||
:Date: 2012-09-27
|
||||
|
|
@ -13,35 +13,36 @@ Nova Console Server
|
|||
:Manual section: 1
|
||||
:Manual group: cloud computing
|
||||
|
||||
SYNOPSIS
|
||||
Synopsis
|
||||
========
|
||||
|
||||
nova-console [options]
|
||||
|
||||
DESCRIPTION
|
||||
Description
|
||||
===========
|
||||
|
||||
nova-console is a console Proxy to set up multi-tenant VM console access (i.e. with xvp)
|
||||
`nova-console` is a server daemon that serves the Nova Console service, which
|
||||
is a console proxy to set up multi-tenant VM console access, e.g. with `XVP`.
|
||||
|
||||
OPTIONS
|
||||
Options
|
||||
=======
|
||||
|
||||
**General options**
|
||||
|
||||
FILES
|
||||
========
|
||||
Files
|
||||
=====
|
||||
|
||||
* /etc/nova/nova.conf
|
||||
* /etc/nova/policy.json
|
||||
* /etc/nova/rootwrap.conf
|
||||
* /etc/nova/rootwrap.d/
|
||||
* ``/etc/nova/nova.conf``
|
||||
* ``/etc/nova/policy.json``
|
||||
* ``/etc/nova/rootwrap.conf``
|
||||
* ``/etc/nova/rootwrap.d/``
|
||||
|
||||
SEE ALSO
|
||||
See Also
|
||||
========
|
||||
|
||||
* `OpenStack Nova <https://docs.openstack.org/nova/latest/>`__
|
||||
|
||||
BUGS
|
||||
Bugs
|
||||
====
|
||||
|
||||
* Nova bugs are managed at Launchpad `Bugs : Nova <https://bugs.launchpad.net/nova>`__
|
||||
* Nova bugs are managed at `Launchpad <https://bugs.launchpad.net/nova>`__
|
||||
|
|
|
|||
|
|
@ -2,9 +2,9 @@
|
|||
nova-consoleauth
|
||||
================
|
||||
|
||||
-------------------------------------------
|
||||
----------------------------------
|
||||
Nova Console Authentication Server
|
||||
-------------------------------------------
|
||||
----------------------------------
|
||||
|
||||
:Author: openstack@lists.openstack.org
|
||||
:Date: 2012-09-27
|
||||
|
|
@ -13,35 +13,36 @@ Nova Console Authentication Server
|
|||
:Manual section: 1
|
||||
:Manual group: cloud computing
|
||||
|
||||
SYNOPSIS
|
||||
Synopsis
|
||||
========
|
||||
|
||||
nova-consoleauth [options]
|
||||
|
||||
DESCRIPTION
|
||||
Description
|
||||
===========
|
||||
|
||||
Provides Authentication for nova consoles
|
||||
`nova-consoleauth` is a server daemon that serves the Nova Console Auth
|
||||
service, which provides authentication for Nova consoles.
|
||||
|
||||
OPTIONS
|
||||
Options
|
||||
=======
|
||||
|
||||
**General options**
|
||||
|
||||
FILES
|
||||
========
|
||||
Files
|
||||
=====
|
||||
|
||||
* /etc/nova/nova.conf
|
||||
* /etc/nova/policy.json
|
||||
* /etc/nova/rootwrap.conf
|
||||
* /etc/nova/rootwrap.d/
|
||||
* ``/etc/nova/nova.conf``
|
||||
* ``/etc/nova/policy.json``
|
||||
* ``/etc/nova/rootwrap.conf``
|
||||
* ``/etc/nova/rootwrap.d/``
|
||||
|
||||
SEE ALSO
|
||||
See Also
|
||||
========
|
||||
|
||||
* `OpenStack Nova <https://docs.openstack.org/nova/latest/>`__
|
||||
|
||||
BUGS
|
||||
Bugs
|
||||
====
|
||||
|
||||
* Nova bugs are managed at Launchpad `Bugs : Nova <https://bugs.launchpad.net/nova>`__
|
||||
* Nova bugs are managed at `Launchpad <https://bugs.launchpad.net/nova>`__
|
||||
|
|
|
|||
|
|
@ -2,9 +2,9 @@
|
|||
nova-dhcpbridge
|
||||
===============
|
||||
|
||||
--------------------------------------------------
|
||||
------------------------------------------------
|
||||
Handles Lease Database updates from DHCP servers
|
||||
--------------------------------------------------
|
||||
------------------------------------------------
|
||||
|
||||
:Author: openstack@lists.openstack.org
|
||||
:Date: 2012-09-27
|
||||
|
|
@ -13,37 +13,41 @@ Handles Lease Database updates from DHCP servers
|
|||
:Manual section: 1
|
||||
:Manual group: cloud computing
|
||||
|
||||
SYNOPSIS
|
||||
Synopsis
|
||||
========
|
||||
|
||||
nova-dhcpbridge [options]
|
||||
|
||||
DESCRIPTION
|
||||
Description
|
||||
===========
|
||||
|
||||
Handles lease database updates from DHCP servers. Used whenever nova is
|
||||
managing DHCP (vlan and flatDHCP). nova-dhcpbridge should not be run as a daemon.
|
||||
`nova-dhcpbridge` is an application that handles lease database updates from
|
||||
DHCP servers. `nova-dhcpbridge` is used whenever nova is managing DHCP (vlan
|
||||
and flatDHCP). `nova-dhcpbridge` should not be run as a daemon.
|
||||
|
||||
OPTIONS
|
||||
.. warning:: This application is only for use with nova-network, which is
|
||||
not recommended for new deployments.
|
||||
|
||||
Options
|
||||
=======
|
||||
|
||||
**General options**
|
||||
|
||||
FILES
|
||||
========
|
||||
Files
|
||||
=====
|
||||
|
||||
* /etc/nova/nova.conf
|
||||
* /etc/nova/api-paste.ini
|
||||
* /etc/nova/policy.json
|
||||
* /etc/nova/rootwrap.conf
|
||||
* /etc/nova/rootwrap.d/
|
||||
* ``/etc/nova/nova.conf``
|
||||
* ``/etc/nova/api-paste.ini``
|
||||
* ``/etc/nova/policy.json``
|
||||
* ``/etc/nova/rootwrap.conf``
|
||||
* ``/etc/nova/rootwrap.d/``
|
||||
|
||||
SEE ALSO
|
||||
See Also
|
||||
========
|
||||
|
||||
* `OpenStack Nova <https://docs.openstack.org/nova/latest/>`__
|
||||
|
||||
BUGS
|
||||
Bugs
|
||||
====
|
||||
|
||||
* Nova bugs are managed at Launchpad `Bugs : Nova <https://bugs.launchpad.net/nova>`__
|
||||
* Nova bugs are managed at `Launchpad <https://bugs.launchpad.net/nova>`__
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ nova-manage
|
|||
===========
|
||||
|
||||
-------------------------------------------
|
||||
control and manage cloud computer instances
|
||||
Control and manage cloud computer instances
|
||||
-------------------------------------------
|
||||
|
||||
:Author: openstack@lists.openstack.org
|
||||
|
|
@ -13,27 +13,32 @@ control and manage cloud computer instances
|
|||
:Manual section: 1
|
||||
:Manual group: cloud computing
|
||||
|
||||
SYNOPSIS
|
||||
Synopsis
|
||||
========
|
||||
|
||||
nova-manage <category> <action> [<args>]
|
||||
|
||||
DESCRIPTION
|
||||
Description
|
||||
===========
|
||||
|
||||
nova-manage controls cloud computing instances by managing shell selection, vpn connections, and floating IP address configuration. More information about OpenStack Nova is at https://docs.openstack.org/developer/nova.
|
||||
`nova-manage` controls cloud computing instances by managing various admin-only
|
||||
aspects of Nova.
|
||||
|
||||
OPTIONS
|
||||
Options
|
||||
=======
|
||||
|
||||
The standard pattern for executing a nova-manage command is:
|
||||
``nova-manage <category> <command> [<args>]``
|
||||
The standard pattern for executing a nova-manage command is::
|
||||
|
||||
Run without arguments to see a list of available command categories:
|
||||
``nova-manage``
|
||||
nova-manage <category> <command> [<args>]
|
||||
|
||||
You can also run with a category argument such as user to see a list of all commands in that category:
|
||||
``nova-manage db``
|
||||
Run without arguments to see a list of available command categories::
|
||||
|
||||
nova-manage
|
||||
|
||||
You can also run with a category argument such as user to see a list of all
|
||||
commands in that category::
|
||||
|
||||
nova-manage db
|
||||
|
||||
These sections describe the available categories and arguments for nova-manage.
|
||||
|
||||
|
|
@ -172,56 +177,56 @@ Nova Cells v2
|
|||
``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
|
||||
transport url. If a database_connection is not specified, it will use
|
||||
the one defined by ``[database]/connection`` in the configuration file
|
||||
passed to nova-manage. If a transport_url is not specified, it will use
|
||||
the one defined by ``[DEFAULT]/transport_url`` in the configuration file.
|
||||
The verbose option will print out the resulting cell mapping uuid.
|
||||
Returns 0 if the cell mapping was successfully created, 1 if the
|
||||
transport url or database connection was missing, and 2 if a cell is
|
||||
already using that transport url and database connection combination.
|
||||
transport url. If a database_connection is not specified, it will use the
|
||||
one defined by ``[database]/connection`` in the configuration file passed
|
||||
to nova-manage. If a transport_url is not specified, it will use the one
|
||||
defined by ``[DEFAULT]/transport_url`` in the configuration file. The
|
||||
verbose option will print out the resulting cell mapping uuid. Returns 0
|
||||
if the cell mapping was successfully created, 1 if the transport url or
|
||||
database connection was missing, and 2 if a cell is already using that
|
||||
transport url and database connection combination.
|
||||
|
||||
``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
|
||||
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 will be done. You need to re-run this command each time you add
|
||||
more compute hosts to a cell (otherwise the scheduler will never place
|
||||
instances there and the API will not list the new hosts). If the strict
|
||||
option is provided the command will only be considered successful if an
|
||||
unmapped host is discovered (exit code 0). Any other case is considered a
|
||||
failure (exit code 1).
|
||||
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
|
||||
will be done. You need to re-run this command each time you add more
|
||||
compute hosts to a cell (otherwise the scheduler will never place instances
|
||||
there and the API will not list the new hosts). If the strict option is
|
||||
provided the command will only be considered successful if an unmapped host
|
||||
is discovered (exit code 0). Any other case is considered a failure (exit
|
||||
code 1).
|
||||
|
||||
``nova-manage cell_v2 list_cells [--verbose]``
|
||||
|
||||
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 connection details.
|
||||
uuid are shown. Use the --verbose option to see transport url and database
|
||||
connection details.
|
||||
|
||||
``nova-manage cell_v2 delete_cell --cell_uuid <cell_uuid>``
|
||||
|
||||
Delete an empty cell by the given uuid. Returns 0 if the empty cell is
|
||||
found and deleted successfully, 1 if a cell with that uuid could not be
|
||||
found, 2 if host mappings were found for the cell (cell not empty), and
|
||||
3 if there are instances mapped to the cell (cell not empty).
|
||||
found, 2 if host mappings were found for the cell (cell not empty), and 3
|
||||
if there are instances mapped to the cell (cell not empty).
|
||||
|
||||
``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
|
||||
database_connection is not specified, it will attempt to use the one
|
||||
defined by ``[database]/connection`` in the configuration file. If a
|
||||
transport_url is not specified, it will attempt to use the one defined
|
||||
by ``[DEFAULT]/transport_url`` in the configuration file. If the cell
|
||||
is not found by uuid, this command will return an exit code of 1. If
|
||||
the properties cannot be set, this will return 2. Otherwise, the exit
|
||||
code will be 0.
|
||||
transport_url is not specified, it will attempt to use the one defined by
|
||||
``[DEFAULT]/transport_url`` in the configuration file. If the cell is not
|
||||
found by uuid, this command will return an exit code of 1. If the
|
||||
properties cannot be set, this will return 2. Otherwise, the exit code will
|
||||
be 0.
|
||||
|
||||
.. note::
|
||||
|
||||
Updating the transport_url or database_connection fields on
|
||||
a running system will NOT result in all nodes immediately using the
|
||||
new values. Use caution when changing these values.
|
||||
Updating the ``transport_url`` or ``database_connection`` fields on a
|
||||
running system will NOT result in all nodes immediately using the new
|
||||
values. Use caution when changing these values.
|
||||
|
||||
Nova Logs
|
||||
~~~~~~~~~
|
||||
|
|
@ -305,15 +310,12 @@ Nova Project
|
|||
This command has been deprecated and is now a no-op since quota usage is
|
||||
counted from resources instead of being tracked separately.
|
||||
|
||||
SEE ALSO
|
||||
See Also
|
||||
========
|
||||
|
||||
* `OpenStack Nova <https://docs.openstack.org/nova/latest/>`__
|
||||
|
||||
BUGS
|
||||
Bugs
|
||||
====
|
||||
|
||||
* Nova bugs are managed at Launchpad `Bugs : Nova <https://bugs.launchpad.net/nova>`__
|
||||
|
||||
|
||||
|
||||
* Nova bugs are managed at `Launchpad <https://bugs.launchpad.net/nova>`__
|
||||
|
|
|
|||
|
|
@ -1,10 +1,10 @@
|
|||
=============
|
||||
============
|
||||
nova-network
|
||||
=============
|
||||
============
|
||||
|
||||
---------------------
|
||||
-------------------
|
||||
Nova Network Server
|
||||
---------------------
|
||||
-------------------
|
||||
|
||||
:Author: openstack@lists.openstack.org
|
||||
:Date: 2012-09-27
|
||||
|
|
@ -13,35 +13,41 @@ Nova Network Server
|
|||
:Manual section: 1
|
||||
:Manual group: cloud computing
|
||||
|
||||
SYNOPSIS
|
||||
Synopsis
|
||||
========
|
||||
|
||||
nova-network [options]
|
||||
|
||||
DESCRIPTION
|
||||
Description
|
||||
===========
|
||||
|
||||
Nova Network is responsible for allocating IPs and setting up the network
|
||||
`nova-network` is a server daemon that serves the Nova Network service, which
|
||||
is responsible for allocating IPs and setting up the network
|
||||
|
||||
OPTIONS
|
||||
.. warning::
|
||||
|
||||
`nova-network` is deprecated and will be removed in an upcoming release. Use
|
||||
`neutron` or another networking solution instead.
|
||||
|
||||
Options
|
||||
=======
|
||||
|
||||
**General options**
|
||||
|
||||
FILES
|
||||
========
|
||||
Files
|
||||
=====
|
||||
|
||||
* /etc/nova/nova.conf
|
||||
* /etc/nova/policy.json
|
||||
* /etc/nova/rootwrap.conf
|
||||
* /etc/nova/rootwrap.d/
|
||||
* ``/etc/nova/nova.conf``
|
||||
* ``/etc/nova/policy.json``
|
||||
* ``/etc/nova/rootwrap.conf``
|
||||
* ``/etc/nova/rootwrap.d/``
|
||||
|
||||
SEE ALSO
|
||||
See Also
|
||||
========
|
||||
|
||||
* `OpenStack Nova <https://docs.openstack.org/nova/latest/>`__
|
||||
|
||||
BUGS
|
||||
Bugs
|
||||
====
|
||||
|
||||
* Nova bugs are managed at Launchpad `Bugs : Nova <https://bugs.launchpad.net/nova>`__
|
||||
* Nova bugs are managed at `Launchpad <https://bugs.launchpad.net/nova>`__
|
||||
|
|
|
|||
|
|
@ -2,9 +2,9 @@
|
|||
nova-novncproxy
|
||||
===============
|
||||
|
||||
--------------------------------------------------------
|
||||
Websocket novnc Proxy for OpenStack Nova noVNC consoles.
|
||||
--------------------------------------------------------
|
||||
-------------------------------------------------------
|
||||
Websocket novnc Proxy for OpenStack Nova noVNC consoles
|
||||
-------------------------------------------------------
|
||||
|
||||
:Author: openstack@lists.openstack.org
|
||||
:Date: 2012-09-27
|
||||
|
|
@ -13,36 +13,37 @@ Websocket novnc Proxy for OpenStack Nova noVNC consoles.
|
|||
:Manual section: 1
|
||||
:Manual group: cloud computing
|
||||
|
||||
SYNOPSIS
|
||||
Synopsis
|
||||
========
|
||||
|
||||
nova-novncproxy [options]
|
||||
|
||||
DESCRIPTION
|
||||
Description
|
||||
===========
|
||||
|
||||
Websocket proxy that is compatible with OpenStack Nova
|
||||
noVNC consoles.
|
||||
`nova-novncproxy` is a server daemon that serves the Nova noVNC Websocket Proxy
|
||||
service, which provides a websocket proxy that is compatible with OpenStack
|
||||
Nova noVNC consoles.
|
||||
|
||||
OPTIONS
|
||||
Options
|
||||
=======
|
||||
|
||||
**General options**
|
||||
|
||||
FILES
|
||||
========
|
||||
Files
|
||||
=====
|
||||
|
||||
* /etc/nova/nova.conf
|
||||
* /etc/nova/policy.json
|
||||
* /etc/nova/rootwrap.conf
|
||||
* /etc/nova/rootwrap.d/
|
||||
* ``/etc/nova/nova.conf``
|
||||
* ``/etc/nova/policy.json``
|
||||
* ``/etc/nova/rootwrap.conf``
|
||||
* ``/etc/nova/rootwrap.d/``
|
||||
|
||||
SEE ALSO
|
||||
See Also
|
||||
========
|
||||
|
||||
* `OpenStack Nova <https://docs.openstack.org/nova/latest/>`__
|
||||
|
||||
BUGS
|
||||
Bugs
|
||||
====
|
||||
|
||||
* Nova bugs are managed at Launchpad `Bugs : Nova <https://bugs.launchpad.net/nova>`__
|
||||
* Nova bugs are managed at `Launchpad <https://bugs.launchpad.net/nova>`__
|
||||
|
|
|
|||
|
|
@ -2,9 +2,9 @@
|
|||
nova-rootwrap
|
||||
=============
|
||||
|
||||
-----------------------
|
||||
---------------------
|
||||
Root wrapper for Nova
|
||||
-----------------------
|
||||
---------------------
|
||||
|
||||
:Author: openstack@lists.openstack.org
|
||||
:Date: 2012-09-27
|
||||
|
|
@ -13,46 +13,52 @@ Root wrapper for Nova
|
|||
:Manual section: 1
|
||||
:Manual group: cloud computing
|
||||
|
||||
SYNOPSIS
|
||||
Synopsis
|
||||
========
|
||||
|
||||
nova-rootwrap [options]
|
||||
|
||||
DESCRIPTION
|
||||
Description
|
||||
===========
|
||||
|
||||
Filters which commands nova is allowed to run as another user.
|
||||
`nova-rootwrap` is an application that filters which commands nova is allowed
|
||||
to run as another user.
|
||||
|
||||
To use this, you should set the following in nova.conf:
|
||||
rootwrap_config=/etc/nova/rootwrap.conf
|
||||
To use this, you should set the following in nova.conf::
|
||||
|
||||
You also need to let the nova user run nova-rootwrap as root in sudoers:
|
||||
nova ALL = (root) NOPASSWD: /usr/bin/nova-rootwrap /etc/nova/rootwrap.conf *
|
||||
rootwrap_config=/etc/nova/rootwrap.conf
|
||||
|
||||
To make allowed commands node-specific, your packaging should only
|
||||
install {compute,network}.filters respectively on compute and network
|
||||
nodes (i.e. nova-api nodes should not have any of those files
|
||||
installed).
|
||||
You also need to let the nova user run nova-rootwrap as root in sudoers::
|
||||
|
||||
nova ALL = (root) NOPASSWD: /usr/bin/nova-rootwrap /etc/nova/rootwrap.conf *
|
||||
|
||||
OPTIONS
|
||||
To make allowed commands node-specific, your packaging should only install
|
||||
{compute,network}.filters respectively on compute and network nodes, i.e.
|
||||
`nova-api` nodes should not have any of those files installed.
|
||||
|
||||
.. note::
|
||||
|
||||
`nova-rootwrap` is being slowly deprecated and replaced by `oslo.privsep`,
|
||||
and will eventually be removed.
|
||||
|
||||
Options
|
||||
=======
|
||||
|
||||
**General options**
|
||||
|
||||
FILES
|
||||
========
|
||||
Files
|
||||
=====
|
||||
|
||||
* /etc/nova/nova.conf
|
||||
* /etc/nova/rootwrap.conf
|
||||
* /etc/nova/rootwrap.d/
|
||||
* ``/etc/nova/nova.conf``
|
||||
* ``/etc/nova/rootwrap.conf``
|
||||
* ``/etc/nova/rootwrap.d/``
|
||||
|
||||
SEE ALSO
|
||||
See Also
|
||||
========
|
||||
|
||||
* `OpenStack Nova <https://docs.openstack.org/nova/latest/>`__
|
||||
|
||||
BUGS
|
||||
Bugs
|
||||
====
|
||||
|
||||
* Nova bugs are managed at Launchpad `Bugs : Nova <https://bugs.launchpad.net/nova>`__
|
||||
* Nova bugs are managed at `Launchpad <https://bugs.launchpad.net/nova>`__
|
||||
|
|
|
|||
|
|
@ -13,35 +13,36 @@ Nova Scheduler
|
|||
:Manual section: 1
|
||||
:Manual group: cloud computing
|
||||
|
||||
SYNOPSIS
|
||||
Synopsis
|
||||
========
|
||||
|
||||
nova-scheduler [options]
|
||||
|
||||
DESCRIPTION
|
||||
Description
|
||||
===========
|
||||
|
||||
Nova Scheduler picks a compute node to run a VM instance.
|
||||
`nova-scheduler` is a server daemon that serves the Nova Scheduler service,
|
||||
which is responsible for picking a compute node to run a given instance on.
|
||||
|
||||
OPTIONS
|
||||
Options
|
||||
=======
|
||||
|
||||
**General options**
|
||||
|
||||
FILES
|
||||
========
|
||||
Files
|
||||
=====
|
||||
|
||||
* /etc/nova/nova.conf
|
||||
* /etc/nova/policy.json
|
||||
* /etc/nova/rootwrap.conf
|
||||
* /etc/nova/rootwrap.d/
|
||||
* ``/etc/nova/nova.conf``
|
||||
* ``/etc/nova/policy.json``
|
||||
* ``/etc/nova/rootwrap.conf``
|
||||
* ``/etc/nova/rootwrap.d/``
|
||||
|
||||
SEE ALSO
|
||||
See Also
|
||||
========
|
||||
|
||||
* `OpenStack Nova <https://docs.openstack.org/nova/latest/>`__
|
||||
|
||||
BUGS
|
||||
Bugs
|
||||
====
|
||||
|
||||
* Nova bugs are managed at Launchpad `Bugs : Nova <https://bugs.launchpad.net/nova>`__
|
||||
* Nova bugs are managed at `Launchpad <https://bugs.launchpad.net/nova>`__
|
||||
|
|
|
|||
|
|
@ -2,9 +2,9 @@
|
|||
nova-serialproxy
|
||||
================
|
||||
|
||||
--------------------------------------------------------
|
||||
Websocket serial Proxy for OpenStack Nova serial ports.
|
||||
--------------------------------------------------------
|
||||
------------------------------------------------------
|
||||
Websocket serial Proxy for OpenStack Nova serial ports
|
||||
------------------------------------------------------
|
||||
|
||||
:Author: openstack@lists.launchpad.net
|
||||
:Date: 2014-03-15
|
||||
|
|
@ -13,36 +13,37 @@ Websocket serial Proxy for OpenStack Nova serial ports.
|
|||
:Manual section: 1
|
||||
:Manual group: cloud computing
|
||||
|
||||
SYNOPSIS
|
||||
Synopsis
|
||||
========
|
||||
|
||||
nova-serialproxy [options]
|
||||
|
||||
DESCRIPTION
|
||||
Description
|
||||
===========
|
||||
|
||||
Websocket proxy that is compatible with OpenStack Nova
|
||||
serial ports.
|
||||
`nova-serialproxy` is a server daemon that serves the Nova Serial Websocket
|
||||
Proxy service, which provides a websocket proxy that is compatible with
|
||||
OpenStack Nova serial ports.
|
||||
|
||||
OPTIONS
|
||||
Options
|
||||
=======
|
||||
|
||||
**General options**
|
||||
|
||||
FILES
|
||||
========
|
||||
Files
|
||||
=====
|
||||
|
||||
* /etc/nova/nova.conf
|
||||
* /etc/nova/policy.json
|
||||
* /etc/nova/rootwrap.conf
|
||||
* /etc/nova/rootwrap.d/
|
||||
* ``/etc/nova/nova.conf``
|
||||
* ``/etc/nova/policy.json``
|
||||
* ``/etc/nova/rootwrap.conf``
|
||||
* ``/etc/nova/rootwrap.d/``
|
||||
|
||||
SEE ALSO
|
||||
See Also
|
||||
========
|
||||
|
||||
* `OpenStack Nova <https://docs.openstack.org/nova/latest/>`__
|
||||
|
||||
BUGS
|
||||
Bugs
|
||||
====
|
||||
|
||||
* Nova bugs are managed at Launchpad `Bugs : Nova <https://bugs.launchpad.net/nova>`__
|
||||
* Nova bugs are managed at `Launchpad <https://bugs.launchpad.net/nova>`__
|
||||
|
|
|
|||
|
|
@ -2,9 +2,9 @@
|
|||
nova-spicehtml5proxy
|
||||
====================
|
||||
|
||||
--------------------------------------------------------
|
||||
Websocket Proxy for OpenStack Nova SPICE HTML5 consoles.
|
||||
--------------------------------------------------------
|
||||
-------------------------------------------------------
|
||||
Websocket Proxy for OpenStack Nova SPICE HTML5 consoles
|
||||
-------------------------------------------------------
|
||||
|
||||
:Author: openstack@lists.openstack.org
|
||||
:Date: 2012-09-27
|
||||
|
|
@ -13,36 +13,37 @@ Websocket Proxy for OpenStack Nova SPICE HTML5 consoles.
|
|||
:Manual section: 1
|
||||
:Manual group: cloud computing
|
||||
|
||||
SYNOPSIS
|
||||
Synopsis
|
||||
========
|
||||
|
||||
nova-spicehtml5proxy [options]
|
||||
|
||||
DESCRIPTION
|
||||
Description
|
||||
===========
|
||||
|
||||
Websocket proxy that is compatible with OpenStack Nova
|
||||
SPICE HTML5 consoles.
|
||||
`nova-spicehtml5proxy` is a server daemon that serves the Nova SPICE HTML5
|
||||
Websocket Proxy service, which provides a websocket proxy that is compatible
|
||||
with OpenStack Nova SPICE HTML5 consoles.
|
||||
|
||||
OPTIONS
|
||||
Options
|
||||
=======
|
||||
|
||||
**General options**
|
||||
|
||||
FILES
|
||||
========
|
||||
Files
|
||||
=====
|
||||
|
||||
* /etc/nova/nova.conf
|
||||
* /etc/nova/policy.json
|
||||
* /etc/nova/rootwrap.conf
|
||||
* /etc/nova/rootwrap.d/
|
||||
* ``/etc/nova/nova.conf``
|
||||
* ``/etc/nova/policy.json``
|
||||
* ``/etc/nova/rootwrap.conf``
|
||||
* ``/etc/nova/rootwrap.d/``
|
||||
|
||||
SEE ALSO
|
||||
See Also
|
||||
========
|
||||
|
||||
* `OpenStack Nova <https://docs.openstack.org/nova/latest/>`__
|
||||
|
||||
BUGS
|
||||
Bugs
|
||||
====
|
||||
|
||||
* Nova bugs are managed at Launchpad `Bugs : Nova <https://bugs.launchpad.net/nova>`__
|
||||
* Nova bugs are managed at `Launchpad <https://bugs.launchpad.net/nova>`__
|
||||
|
|
|
|||
|
|
@ -13,21 +13,21 @@ CLI interface for nova status commands
|
|||
:Manual section: 1
|
||||
:Manual group: cloud computing
|
||||
|
||||
SYNOPSIS
|
||||
Synopsis
|
||||
========
|
||||
|
||||
nova-status <category> <action> [<args>]
|
||||
|
||||
DESCRIPTION
|
||||
Description
|
||||
===========
|
||||
|
||||
The nova-status command provides routines for checking the status of a Nova
|
||||
deployment.
|
||||
`nova-status` is a tool that provides routines for checking the status of a
|
||||
Nova deployment.
|
||||
|
||||
OPTIONS
|
||||
Options
|
||||
=======
|
||||
|
||||
The standard pattern for executing a nova-status command is::
|
||||
The standard pattern for executing a `nova-status` command is::
|
||||
|
||||
nova-status <category> <command> [<args>]
|
||||
|
||||
|
|
@ -37,16 +37,17 @@ Run without arguments to see a list of available command categories::
|
|||
|
||||
Categories are:
|
||||
|
||||
* upgrade
|
||||
* ``upgrade``
|
||||
|
||||
Detailed descriptions are below.
|
||||
|
||||
You can also run with a category argument such as "upgrade" to see a list of
|
||||
You can also run with a category argument such as ``upgrade`` to see a list of
|
||||
all commands in that category::
|
||||
|
||||
nova-status upgrade
|
||||
|
||||
These sections describe the available categories and arguments for nova-status.
|
||||
These sections describe the available categories and arguments for
|
||||
`nova-status`.
|
||||
|
||||
Upgrade
|
||||
~~~~~~~
|
||||
|
|
@ -100,13 +101,12 @@ Upgrade
|
|||
* Checks for the Placement API are modified to require version 1.4, that
|
||||
is needed in Pike and further for nova-scheduler to work correctly.
|
||||
|
||||
|
||||
SEE ALSO
|
||||
See Also
|
||||
========
|
||||
|
||||
* OpenStack Nova Docs: `<https://docs.openstack.org/nova/latest/>`_
|
||||
|
||||
BUGS
|
||||
Bugs
|
||||
====
|
||||
|
||||
* Nova bugs are managed at Launchpad: `<https://bugs.launchpad.net/nova>`_
|
||||
* Nova bugs are managed at `Launchpad <https://bugs.launchpad.net/nova>`_
|
||||
|
|
|
|||
|
|
@ -2,9 +2,9 @@
|
|||
nova-xvpvncproxy
|
||||
================
|
||||
|
||||
-----------------------------
|
||||
----------------------------
|
||||
XVP VNC Console Proxy Server
|
||||
-----------------------------
|
||||
----------------------------
|
||||
|
||||
:Author: openstack@lists.openstack.org
|
||||
:Date: 2012-09-27
|
||||
|
|
@ -13,35 +13,37 @@ XVP VNC Console Proxy Server
|
|||
:Manual section: 1
|
||||
:Manual group: cloud computing
|
||||
|
||||
SYNOPSIS
|
||||
Synopsis
|
||||
========
|
||||
|
||||
nova-xvpvncproxy [options]
|
||||
|
||||
DESCRIPTION
|
||||
Description
|
||||
===========
|
||||
|
||||
XVP VNC Console Proxy Server
|
||||
`nova-xvpvncproxy` is a server daemon that serves the Nova XVP VNC Console
|
||||
Proxy service, which provides an XVP-based VNC Console Proxy for use with the
|
||||
Xen hypervisor.
|
||||
|
||||
OPTIONS
|
||||
Options
|
||||
=======
|
||||
|
||||
**General options**
|
||||
|
||||
FILES
|
||||
========
|
||||
Files
|
||||
=====
|
||||
|
||||
* /etc/nova/nova.conf
|
||||
* /etc/nova/policy.json
|
||||
* /etc/nova/rootwrap.conf
|
||||
* /etc/nova/rootwrap.d/
|
||||
* ``/etc/nova/nova.conf``
|
||||
* ``/etc/nova/policy.json``
|
||||
* ``/etc/nova/rootwrap.conf``
|
||||
* ``/etc/nova/rootwrap.d/``
|
||||
|
||||
SEE ALSO
|
||||
See Also
|
||||
========
|
||||
|
||||
* `OpenStack Nova <https://docs.openstack.org/nova/latest/>`__
|
||||
|
||||
BUGS
|
||||
Bugs
|
||||
====
|
||||
|
||||
* Nova bugs are managed at Launchpad `Bugs : Nova <https://bugs.launchpad.net/nova>`__
|
||||
* Nova bugs are managed at `Launchpad <https://bugs.launchpad.net/nova>`__
|
||||
|
|
|
|||
Loading…
Reference in New Issue