diff --git a/doc/source/cli/nova-api-metadata.rst b/doc/source/cli/nova-api-metadata.rst index 85dbe0899b..5686d50473 100644 --- a/doc/source/cli/nova-api-metadata.rst +++ b/doc/source/cli/nova-api-metadata.rst @@ -16,12 +16,13 @@ Synopsis :: - nova-api-metadata [options] + nova-api-metadata [options] 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 ======= diff --git a/doc/source/cli/nova-api-os-compute.rst b/doc/source/cli/nova-api-os-compute.rst index e42d104e1d..ac3c56b2a5 100644 --- a/doc/source/cli/nova-api-os-compute.rst +++ b/doc/source/cli/nova-api-os-compute.rst @@ -21,8 +21,8 @@ Synopsis Description =========== -`nova-api-os-compute` is a server daemon that serves the Nova OpenStack Compute -API +:program:`nova-api-os-compute` is a server daemon that serves the Nova +OpenStack Compute API. Options ======= diff --git a/doc/source/cli/nova-api.rst b/doc/source/cli/nova-api.rst index 5a3f52f7c6..bbc36c865b 100644 --- a/doc/source/cli/nova-api.rst +++ b/doc/source/cli/nova-api.rst @@ -21,8 +21,8 @@ Synopsis Description =========== -`nova-api` is a server daemon that serves the metadata and compute APIs in -separate greenthreads +:program:`nova-api` is a server daemon that serves the metadata and compute +APIs in separate greenthreads. Options ======= diff --git a/doc/source/cli/nova-cells.rst b/doc/source/cli/nova-cells.rst index a2f69ce544..8edf326bc3 100644 --- a/doc/source/cli/nova-cells.rst +++ b/doc/source/cli/nova-cells.rst @@ -21,10 +21,8 @@ Synopsis Description =========== -Starts the `nova-cells` service. - -The `nova-cells` service handles communication between cells and selects cells -for new instances. +:program:`nova-cells` is a server daemon that serves the Nova Cells service, +which handles communication between cells and selects cells for new instances. .. warning:: Everything in this document is referring to Cells v1, which is not recommended for new deployments and is deprecated in favor of Cells v2 diff --git a/doc/source/cli/nova-compute.rst b/doc/source/cli/nova-compute.rst index 0f179106f1..1ecc0fe536 100644 --- a/doc/source/cli/nova-compute.rst +++ b/doc/source/cli/nova-compute.rst @@ -21,10 +21,10 @@ Synopsis Description =========== -`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. +:program:`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 ======= diff --git a/doc/source/cli/nova-conductor.rst b/doc/source/cli/nova-conductor.rst index 88a60043c0..8028379d1e 100644 --- a/doc/source/cli/nova-conductor.rst +++ b/doc/source/cli/nova-conductor.rst @@ -21,8 +21,8 @@ Synopsis Description =========== -`nova-conductor` is a server daemon that serves the Nova Conductor service, -which provides coordination and database query support for Nova. +:program:`nova-conductor` is a server daemon that serves the Nova Conductor +service, which provides coordination and database query support for nova. Options ======= diff --git a/doc/source/cli/nova-console.rst b/doc/source/cli/nova-console.rst index fefcaad3c8..ebe2758ad5 100644 --- a/doc/source/cli/nova-console.rst +++ b/doc/source/cli/nova-console.rst @@ -21,8 +21,9 @@ Synopsis Description =========== -`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`. +:program:`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 ======= diff --git a/doc/source/cli/nova-consoleauth.rst b/doc/source/cli/nova-consoleauth.rst index fffe8723ce..8b23611dde 100644 --- a/doc/source/cli/nova-consoleauth.rst +++ b/doc/source/cli/nova-consoleauth.rst @@ -21,8 +21,8 @@ Synopsis Description =========== -`nova-consoleauth` is a server daemon that serves the Nova Console Auth -service, which provides authentication for Nova consoles. +:program:`nova-consoleauth` is a server daemon that serves the Nova Console +Auth service, which provides authentication for Nova consoles. Options ======= diff --git a/doc/source/cli/nova-dhcpbridge.rst b/doc/source/cli/nova-dhcpbridge.rst index 21b3b37b70..c3b77ca248 100644 --- a/doc/source/cli/nova-dhcpbridge.rst +++ b/doc/source/cli/nova-dhcpbridge.rst @@ -21,12 +21,15 @@ Synopsis Description =========== -`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. +:program:`nova-dhcpbridge` is an application that handles lease database +updates from DHCP servers. :program:`nova-dhcpbridge` is used whenever nova is +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 - not recommended for new deployments. +.. warning:: + + This application is only for use with ``nova-network``, which is not + recommended for new deployments. Options ======= diff --git a/doc/source/cli/nova-manage.rst b/doc/source/cli/nova-manage.rst index 9d493e6d9f..520a51ef63 100644 --- a/doc/source/cli/nova-manage.rst +++ b/doc/source/cli/nova-manage.rst @@ -21,8 +21,8 @@ Synopsis Description =========== -`nova-manage` controls cloud computing instances by managing various admin-only -aspects of Nova. +:program:`nova-manage` controls cloud computing instances by managing various +admin-only aspects of Nova. Options ======= diff --git a/doc/source/cli/nova-network.rst b/doc/source/cli/nova-network.rst index 1acb0f5a6f..3498a36875 100644 --- a/doc/source/cli/nova-network.rst +++ b/doc/source/cli/nova-network.rst @@ -21,13 +21,13 @@ Synopsis Description =========== -`nova-network` is a server daemon that serves the Nova Network service, which -is responsible for allocating IPs and setting up the network +:program:`nova-network` is a server daemon that serves the Nova Network +service, which is responsible for allocating IPs and setting up the network .. warning:: - `nova-network` is deprecated and will be removed in an upcoming release. Use - `neutron` or another networking solution instead. + :program:`nova-network` is deprecated and will be removed in an upcoming + release. Use *neutron* or another networking solution instead. Options ======= diff --git a/doc/source/cli/nova-novncproxy.rst b/doc/source/cli/nova-novncproxy.rst index 78a5870f40..16810dd6af 100644 --- a/doc/source/cli/nova-novncproxy.rst +++ b/doc/source/cli/nova-novncproxy.rst @@ -21,9 +21,9 @@ Synopsis Description =========== -`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. +:program:`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 ======= diff --git a/doc/source/cli/nova-rootwrap.rst b/doc/source/cli/nova-rootwrap.rst index 9fa9e5f963..3f1410bff7 100644 --- a/doc/source/cli/nova-rootwrap.rst +++ b/doc/source/cli/nova-rootwrap.rst @@ -21,25 +21,26 @@ Synopsis Description =========== -`nova-rootwrap` is an application that filters which commands nova is allowed -to run as another user. +:program:`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:: +To use this, you should set the following in ``nova.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 * 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. +``{compute,network}.filters`` respectively on compute and network nodes, i.e. +:program:`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. + :program:`nova-rootwrap` is being slowly deprecated and replaced by + ``oslo.privsep``, and will eventually be removed. Options ======= diff --git a/doc/source/cli/nova-scheduler.rst b/doc/source/cli/nova-scheduler.rst index cedb314358..99b29207ea 100644 --- a/doc/source/cli/nova-scheduler.rst +++ b/doc/source/cli/nova-scheduler.rst @@ -21,8 +21,9 @@ Synopsis Description =========== -`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. +:program:`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 ======= diff --git a/doc/source/cli/nova-serialproxy.rst b/doc/source/cli/nova-serialproxy.rst index e6f1633e9e..d05fa6e68f 100644 --- a/doc/source/cli/nova-serialproxy.rst +++ b/doc/source/cli/nova-serialproxy.rst @@ -21,9 +21,9 @@ Synopsis Description =========== -`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. +:program:`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 ======= diff --git a/doc/source/cli/nova-spicehtml5proxy.rst b/doc/source/cli/nova-spicehtml5proxy.rst index b08966f467..892ae3c463 100644 --- a/doc/source/cli/nova-spicehtml5proxy.rst +++ b/doc/source/cli/nova-spicehtml5proxy.rst @@ -21,9 +21,9 @@ Synopsis Description =========== -`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. +:program:`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 ======= diff --git a/doc/source/cli/nova-status.rst b/doc/source/cli/nova-status.rst index 37330fbfb3..81eaefda19 100644 --- a/doc/source/cli/nova-status.rst +++ b/doc/source/cli/nova-status.rst @@ -21,13 +21,13 @@ Synopsis Description =========== -`nova-status` is a tool that provides routines for checking the status of a -Nova deployment. +:program:`nova-status` is a tool that provides routines for checking the status +of a Nova deployment. Options ======= -The standard pattern for executing a `nova-status` command is:: +The standard pattern for executing a :program:`nova-status` command is:: nova-status [] @@ -47,7 +47,7 @@ all commands in that category:: nova-status upgrade These sections describe the available categories and arguments for -`nova-status`. +:program:`nova-status`. Upgrade ~~~~~~~ diff --git a/doc/source/cli/nova-xvpvncproxy.rst b/doc/source/cli/nova-xvpvncproxy.rst index f172396460..0afdd5bc16 100644 --- a/doc/source/cli/nova-xvpvncproxy.rst +++ b/doc/source/cli/nova-xvpvncproxy.rst @@ -21,9 +21,9 @@ Synopsis Description =========== -`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. +:program:`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 =======