Merge "doc: Don't use single backticks in man pages"
This commit is contained in:
Zuul
Gerrit Code Review
commit
465051809c
|
|
@ -16,12 +16,13 @@ Synopsis
|
||||||
|
|
||||||
::
|
::
|
||||||
|
|
||||||
nova-api-metadata [options]
|
nova-api-metadata [options]
|
||||||
|
|
||||||
Description
|
Description
|
||||||
===========
|
===========
|
||||||
|
|
||||||
`nova-api-metadata` is a server daemon that serves the Nova Metadata API
|
:program:`nova-api-metadata` is a server daemon that serves the Nova Metadata
|
||||||
|
API.
|
||||||
|
|
||||||
Options
|
Options
|
||||||
=======
|
=======
|
||||||
|
|
|
||||||
|
|
@ -21,8 +21,8 @@ Synopsis
|
||||||
Description
|
Description
|
||||||
===========
|
===========
|
||||||
|
|
||||||
`nova-api-os-compute` is a server daemon that serves the Nova OpenStack Compute
|
:program:`nova-api-os-compute` is a server daemon that serves the Nova
|
||||||
API
|
OpenStack Compute API.
|
||||||
|
|
||||||
Options
|
Options
|
||||||
=======
|
=======
|
||||||
|
|
|
||||||
|
|
@ -21,8 +21,8 @@ Synopsis
|
||||||
Description
|
Description
|
||||||
===========
|
===========
|
||||||
|
|
||||||
`nova-api` is a server daemon that serves the metadata and compute APIs in
|
:program:`nova-api` is a server daemon that serves the metadata and compute
|
||||||
separate greenthreads
|
APIs in separate greenthreads.
|
||||||
|
|
||||||
Options
|
Options
|
||||||
=======
|
=======
|
||||||
|
|
|
||||||
|
|
@ -21,10 +21,8 @@ Synopsis
|
||||||
Description
|
Description
|
||||||
===========
|
===========
|
||||||
|
|
||||||
Starts the `nova-cells` service.
|
:program:`nova-cells` is a server daemon that serves the Nova Cells service,
|
||||||
|
which handles communication between cells and selects cells for new instances.
|
||||||
The `nova-cells` service handles communication between cells and selects cells
|
|
||||||
for new instances.
|
|
||||||
|
|
||||||
.. deprecated:: 16.0.0
|
.. deprecated:: 16.0.0
|
||||||
Everything in this document is referring to Cells v1, which is
|
Everything in this document is referring to Cells v1, which is
|
||||||
|
|
|
||||||
|
|
@ -21,10 +21,10 @@ Synopsis
|
||||||
Description
|
Description
|
||||||
===========
|
===========
|
||||||
|
|
||||||
`nova-compute` is a server daemon that serves the Nova Compute service, which
|
:program:`nova-compute` is a server daemon that serves the Nova Compute
|
||||||
is responsible for building a disk image, launching an instance via the
|
service, which is responsible for building a disk image, launching an instance
|
||||||
underlying virtualization driver, responding to calls to check the instance's
|
via the underlying virtualization driver, responding to calls to check the
|
||||||
state, attaching persistent storage, and terminating the instance.
|
instance's state, attaching persistent storage, and terminating the instance.
|
||||||
|
|
||||||
Options
|
Options
|
||||||
=======
|
=======
|
||||||
|
|
|
||||||
|
|
@ -21,8 +21,8 @@ Synopsis
|
||||||
Description
|
Description
|
||||||
===========
|
===========
|
||||||
|
|
||||||
`nova-conductor` is a server daemon that serves the Nova Conductor service,
|
:program:`nova-conductor` is a server daemon that serves the Nova Conductor
|
||||||
which provides coordination and database query support for Nova.
|
service, which provides coordination and database query support for nova.
|
||||||
|
|
||||||
Options
|
Options
|
||||||
=======
|
=======
|
||||||
|
|
|
||||||
|
|
@ -21,8 +21,9 @@ Synopsis
|
||||||
Description
|
Description
|
||||||
===========
|
===========
|
||||||
|
|
||||||
`nova-console` is a server daemon that serves the Nova Console service, which
|
:program:`nova-console` is a server daemon that serves the Nova Console
|
||||||
is a console proxy to set up multi-tenant VM console access, e.g. with `XVP`.
|
service, which is a console proxy to set up multi-tenant VM console access,
|
||||||
|
e.g. with *XVP*.
|
||||||
|
|
||||||
Options
|
Options
|
||||||
=======
|
=======
|
||||||
|
|
|
||||||
|
|
@ -21,8 +21,8 @@ Synopsis
|
||||||
Description
|
Description
|
||||||
===========
|
===========
|
||||||
|
|
||||||
`nova-consoleauth` is a server daemon that serves the Nova Console Auth
|
:program:`nova-consoleauth` is a server daemon that serves the Nova Console
|
||||||
service, which provides authentication for Nova consoles.
|
Auth service, which provides authentication for Nova consoles.
|
||||||
|
|
||||||
.. deprecated:: 18.0.0
|
.. deprecated:: 18.0.0
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -21,12 +21,15 @@ Synopsis
|
||||||
Description
|
Description
|
||||||
===========
|
===========
|
||||||
|
|
||||||
`nova-dhcpbridge` is an application that handles lease database updates from
|
:program:`nova-dhcpbridge` is an application that handles lease database
|
||||||
DHCP servers. `nova-dhcpbridge` is used whenever nova is managing DHCP (vlan
|
updates from DHCP servers. :program:`nova-dhcpbridge` is used whenever nova is
|
||||||
and flatDHCP). `nova-dhcpbridge` should not be run as a daemon.
|
managing DHCP (vlan and flatDHCP). :program:`nova-dhcpbridge` should not be run
|
||||||
|
as a daemon.
|
||||||
|
|
||||||
.. warning:: This application is only for use with nova-network, which is
|
.. warning::
|
||||||
not recommended for new deployments.
|
|
||||||
|
This application is only for use with ``nova-network``, which is not
|
||||||
|
recommended for new deployments.
|
||||||
|
|
||||||
Options
|
Options
|
||||||
=======
|
=======
|
||||||
|
|
|
||||||
|
|
@ -21,8 +21,8 @@ Synopsis
|
||||||
Description
|
Description
|
||||||
===========
|
===========
|
||||||
|
|
||||||
`nova-manage` controls cloud computing instances by managing various admin-only
|
:program:`nova-manage` controls cloud computing instances by managing various
|
||||||
aspects of Nova.
|
admin-only aspects of Nova.
|
||||||
|
|
||||||
Options
|
Options
|
||||||
=======
|
=======
|
||||||
|
|
|
||||||
|
|
@ -21,13 +21,13 @@ Synopsis
|
||||||
Description
|
Description
|
||||||
===========
|
===========
|
||||||
|
|
||||||
`nova-network` is a server daemon that serves the Nova Network service, which
|
:program:`nova-network` is a server daemon that serves the Nova Network
|
||||||
is responsible for allocating IPs and setting up the network
|
service, which is responsible for allocating IPs and setting up the network
|
||||||
|
|
||||||
.. deprecated:: 14.0.0
|
.. deprecated:: 14.0.0
|
||||||
|
|
||||||
`nova-network` is deprecated and will be removed in an upcoming release. Use
|
:program:`nova-network` is deprecated and will be removed in an upcoming
|
||||||
`neutron` or another networking solution instead.
|
release. Use *neutron* or another networking solution instead.
|
||||||
|
|
||||||
Options
|
Options
|
||||||
=======
|
=======
|
||||||
|
|
|
||||||
|
|
@ -21,9 +21,9 @@ Synopsis
|
||||||
Description
|
Description
|
||||||
===========
|
===========
|
||||||
|
|
||||||
`nova-novncproxy` is a server daemon that serves the Nova noVNC Websocket Proxy
|
:program:`nova-novncproxy` is a server daemon that serves the Nova noVNC
|
||||||
service, which provides a websocket proxy that is compatible with OpenStack
|
Websocket Proxy service, which provides a websocket proxy that is compatible
|
||||||
Nova noVNC consoles.
|
with OpenStack Nova noVNC consoles.
|
||||||
|
|
||||||
Options
|
Options
|
||||||
=======
|
=======
|
||||||
|
|
|
||||||
|
|
@ -21,25 +21,26 @@ Synopsis
|
||||||
Description
|
Description
|
||||||
===========
|
===========
|
||||||
|
|
||||||
`nova-rootwrap` is an application that filters which commands nova is allowed
|
:program:`nova-rootwrap` is an application that filters which commands nova is
|
||||||
to run as another user.
|
allowed to run as another user.
|
||||||
|
|
||||||
To use this, you should set the following in nova.conf::
|
To use this, you should set the following in ``nova.conf``::
|
||||||
|
|
||||||
rootwrap_config=/etc/nova/rootwrap.conf
|
rootwrap_config=/etc/nova/rootwrap.conf
|
||||||
|
|
||||||
You also need to let the nova user run nova-rootwrap as root in sudoers::
|
You also need to let the nova user run :program:`nova-rootwrap` as root in
|
||||||
|
``sudoers``::
|
||||||
|
|
||||||
nova ALL = (root) NOPASSWD: /usr/bin/nova-rootwrap /etc/nova/rootwrap.conf *
|
nova ALL = (root) NOPASSWD: /usr/bin/nova-rootwrap /etc/nova/rootwrap.conf *
|
||||||
|
|
||||||
To make allowed commands node-specific, your packaging should only install
|
To make allowed commands node-specific, your packaging should only install
|
||||||
{compute,network}.filters respectively on compute and network nodes, i.e.
|
``{compute,network}.filters`` respectively on compute and network nodes, i.e.
|
||||||
`nova-api` nodes should not have any of those files installed.
|
:program:`nova-api` nodes should not have any of those files installed.
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
|
|
||||||
`nova-rootwrap` is being slowly deprecated and replaced by `oslo.privsep`,
|
:program:`nova-rootwrap` is being slowly deprecated and replaced by
|
||||||
and will eventually be removed.
|
``oslo.privsep``, and will eventually be removed.
|
||||||
|
|
||||||
Options
|
Options
|
||||||
=======
|
=======
|
||||||
|
|
|
||||||
|
|
@ -21,8 +21,9 @@ Synopsis
|
||||||
Description
|
Description
|
||||||
===========
|
===========
|
||||||
|
|
||||||
`nova-scheduler` is a server daemon that serves the Nova Scheduler service,
|
:program:`nova-scheduler` is a server daemon that serves the Nova Scheduler
|
||||||
which is responsible for picking a compute node to run a given instance on.
|
service, which is responsible for picking a compute node to run a given
|
||||||
|
instance on.
|
||||||
|
|
||||||
Options
|
Options
|
||||||
=======
|
=======
|
||||||
|
|
|
||||||
|
|
@ -21,9 +21,9 @@ Synopsis
|
||||||
Description
|
Description
|
||||||
===========
|
===========
|
||||||
|
|
||||||
`nova-serialproxy` is a server daemon that serves the Nova Serial Websocket
|
:program:`nova-serialproxy` is a server daemon that serves the Nova Serial
|
||||||
Proxy service, which provides a websocket proxy that is compatible with
|
Websocket Proxy service, which provides a websocket proxy that is compatible
|
||||||
OpenStack Nova serial ports.
|
with OpenStack Nova serial ports.
|
||||||
|
|
||||||
Options
|
Options
|
||||||
=======
|
=======
|
||||||
|
|
|
||||||
|
|
@ -21,9 +21,9 @@ Synopsis
|
||||||
Description
|
Description
|
||||||
===========
|
===========
|
||||||
|
|
||||||
`nova-spicehtml5proxy` is a server daemon that serves the Nova SPICE HTML5
|
:program:`nova-spicehtml5proxy` is a server daemon that serves the Nova SPICE
|
||||||
Websocket Proxy service, which provides a websocket proxy that is compatible
|
HTML5 Websocket Proxy service, which provides a websocket proxy that is
|
||||||
with OpenStack Nova SPICE HTML5 consoles.
|
compatible with OpenStack Nova SPICE HTML5 consoles.
|
||||||
|
|
||||||
Options
|
Options
|
||||||
=======
|
=======
|
||||||
|
|
|
||||||
|
|
@ -21,13 +21,13 @@ Synopsis
|
||||||
Description
|
Description
|
||||||
===========
|
===========
|
||||||
|
|
||||||
`nova-status` is a tool that provides routines for checking the status of a
|
:program:`nova-status` is a tool that provides routines for checking the status
|
||||||
Nova deployment.
|
of a Nova deployment.
|
||||||
|
|
||||||
Options
|
Options
|
||||||
=======
|
=======
|
||||||
|
|
||||||
The standard pattern for executing a `nova-status` command is::
|
The standard pattern for executing a :program:`nova-status` command is::
|
||||||
|
|
||||||
nova-status <category> <command> [<args>]
|
nova-status <category> <command> [<args>]
|
||||||
|
|
||||||
|
|
@ -47,7 +47,7 @@ all commands in that category::
|
||||||
nova-status upgrade
|
nova-status upgrade
|
||||||
|
|
||||||
These sections describe the available categories and arguments for
|
These sections describe the available categories and arguments for
|
||||||
`nova-status`.
|
:program:`nova-status`.
|
||||||
|
|
||||||
Upgrade
|
Upgrade
|
||||||
~~~~~~~
|
~~~~~~~
|
||||||
|
|
|
||||||
|
|
@ -21,9 +21,9 @@ Synopsis
|
||||||
Description
|
Description
|
||||||
===========
|
===========
|
||||||
|
|
||||||
`nova-xvpvncproxy` is a server daemon that serves the Nova XVP VNC Console
|
:program:`nova-xvpvncproxy` is a server daemon that serves the Nova XVP VNC
|
||||||
Proxy service, which provides an XVP-based VNC Console Proxy for use with the
|
Console Proxy service, which provides an XVP-based VNC Console Proxy for use
|
||||||
Xen hypervisor.
|
with the Xen hypervisor.
|
||||||
|
|
||||||
Options
|
Options
|
||||||
=======
|
=======
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue