openstack/nova
Code Issues Proposed changes
d4af91f349
nova/doc/source/cli/nova-api-os-compute.rst

51 lines
875 B
ReStructuredText
Raw Normal View History

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
2017-09-08 16:44:14 +01:00
===================
Add man pages Add partially written manpages for: * nova-all * nova-api-ec2 * nova-api-metadata * nova-api-os-compute * nova-api-os-volume * nova-api * nova-cert * nova-compute * nova-console * nova-consoleauth * nova-dhcpbridge * nova-network * nova-novncproxy * nova-objectstore * nova-rootwrap * nova-rpc-zmq-receiver * nova-scheduler * nova-volume-usage-audit * nova-volume * nova-xvpvncproxy Change-Id: I3734831ce2f6b5d765e98b3f50fe8c1ad7965685
2012-09-13 18:42:26 -07:00
nova-api-os-compute
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
2017-09-08 16:44:14 +01:00
===================
Add man pages Add partially written manpages for: * nova-all * nova-api-ec2 * nova-api-metadata * nova-api-os-compute * nova-api-os-volume * nova-api * nova-cert * nova-compute * nova-console * nova-consoleauth * nova-dhcpbridge * nova-network * nova-novncproxy * nova-objectstore * nova-rootwrap * nova-rpc-zmq-receiver * nova-scheduler * nova-volume-usage-audit * nova-volume * nova-xvpvncproxy Change-Id: I3734831ce2f6b5d765e98b3f50fe8c1ad7965685
2012-09-13 18:42:26 -07:00
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
2017-09-08 16:44:14 +01:00
------------------------------------------
Add man pages Add partially written manpages for: * nova-all * nova-api-ec2 * nova-api-metadata * nova-api-os-compute * nova-api-os-volume * nova-api * nova-cert * nova-compute * nova-console * nova-consoleauth * nova-dhcpbridge * nova-network * nova-novncproxy * nova-objectstore * nova-rootwrap * nova-rpc-zmq-receiver * nova-scheduler * nova-volume-usage-audit * nova-volume * nova-xvpvncproxy Change-Id: I3734831ce2f6b5d765e98b3f50fe8c1ad7965685
2012-09-13 18:42:26 -07:00
Server for the Nova OpenStack Compute APIs
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
2017-09-08 16:44:14 +01:00
------------------------------------------
Add man pages Add partially written manpages for: * nova-all * nova-api-ec2 * nova-api-metadata * nova-api-os-compute * nova-api-os-volume * nova-api * nova-cert * nova-compute * nova-console * nova-consoleauth * nova-dhcpbridge * nova-network * nova-novncproxy * nova-objectstore * nova-rootwrap * nova-rpc-zmq-receiver * nova-scheduler * nova-volume-usage-audit * nova-volume * nova-xvpvncproxy Change-Id: I3734831ce2f6b5d765e98b3f50fe8c1ad7965685
2012-09-13 18:42:26 -07:00
Update references with new Mailing List location Yesterday, openstack@lists.launchpad.org was migrated with all users to openstack@list.openstack.org. This patch updates references to the old mailing list with the new, to ensure that people encountering them don't accidentally try and join the old list! Change-Id: I76242f4f4f0c8c2418068ea709ab2f7aa4502fd5
2013-07-28 11:28:46 -07:00
:Author: openstack@lists.openstack.org
Update OpenStack LLC to Foundation Update all references of "LLC" to "Foundation". Change-Id: I009e86784ef4dcf38882d64b0eff484576e04efe
2013-02-22 09:13:07 -05:00
:Copyright: OpenStack Foundation
Add man pages Add partially written manpages for: * nova-all * nova-api-ec2 * nova-api-metadata * nova-api-os-compute * nova-api-os-volume * nova-api * nova-cert * nova-compute * nova-console * nova-consoleauth * nova-dhcpbridge * nova-network * nova-novncproxy * nova-objectstore * nova-rootwrap * nova-rpc-zmq-receiver * nova-scheduler * nova-volume-usage-audit * nova-volume * nova-xvpvncproxy Change-Id: I3734831ce2f6b5d765e98b3f50fe8c1ad7965685
2012-09-13 18:42:26 -07:00
:Manual section: 1
:Manual group: cloud computing
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
2017-09-08 16:44:14 +01:00
Synopsis
Add man pages Add partially written manpages for: * nova-all * nova-api-ec2 * nova-api-metadata * nova-api-os-compute * nova-api-os-volume * nova-api * nova-cert * nova-compute * nova-console * nova-consoleauth * nova-dhcpbridge * nova-network * nova-novncproxy * nova-objectstore * nova-rootwrap * nova-rpc-zmq-receiver * nova-scheduler * nova-volume-usage-audit * nova-volume * nova-xvpvncproxy Change-Id: I3734831ce2f6b5d765e98b3f50fe8c1ad7965685
2012-09-13 18:42:26 -07:00
========
Fix indentation in doc/source/cli/* Current indentation was wrongly interpreted as quotes. Change-Id: I731d8833e69e6bed12f5637d6bb3248b890c18ab
2018-03-02 11:32:59 +01:00
::
Add man pages Add partially written manpages for: * nova-all * nova-api-ec2 * nova-api-metadata * nova-api-os-compute * nova-api-os-volume * nova-api * nova-cert * nova-compute * nova-console * nova-consoleauth * nova-dhcpbridge * nova-network * nova-novncproxy * nova-objectstore * nova-rootwrap * nova-rpc-zmq-receiver * nova-scheduler * nova-volume-usage-audit * nova-volume * nova-xvpvncproxy Change-Id: I3734831ce2f6b5d765e98b3f50fe8c1ad7965685
2012-09-13 18:42:26 -07:00
nova-api-os-compute [options]
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
2017-09-08 16:44:14 +01:00
Description
Add man pages Add partially written manpages for: * nova-all * nova-api-ec2 * nova-api-metadata * nova-api-os-compute * nova-api-os-volume * nova-api * nova-cert * nova-compute * nova-console * nova-consoleauth * nova-dhcpbridge * nova-network * nova-novncproxy * nova-objectstore * nova-rootwrap * nova-rpc-zmq-receiver * nova-scheduler * nova-volume-usage-audit * nova-volume * nova-xvpvncproxy Change-Id: I3734831ce2f6b5d765e98b3f50fe8c1ad7965685
2012-09-13 18:42:26 -07:00
===========
doc: Don't use single backticks in man pages This is done in a couple of places in the documentation and is broken rST. 'prog' is semantic markup that fits right in here, so use that. Change-Id: Ic654e33daaf68b01f561ac8d792934d5a57a07e5
2018-02-05 15:17:00 +00:00
:program:`nova-api-os-compute` is a server daemon that serves the Nova
OpenStack Compute API.
Add man pages Add partially written manpages for: * nova-all * nova-api-ec2 * nova-api-metadata * nova-api-os-compute * nova-api-os-volume * nova-api * nova-cert * nova-compute * nova-console * nova-consoleauth * nova-dhcpbridge * nova-network * nova-novncproxy * nova-objectstore * nova-rootwrap * nova-rpc-zmq-receiver * nova-scheduler * nova-volume-usage-audit * nova-volume * nova-xvpvncproxy Change-Id: I3734831ce2f6b5d765e98b3f50fe8c1ad7965685
2012-09-13 18:42:26 -07:00
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
2017-09-08 16:44:14 +01:00
Options
Add man pages Add partially written manpages for: * nova-all * nova-api-ec2 * nova-api-metadata * nova-api-os-compute * nova-api-os-volume * nova-api * nova-cert * nova-compute * nova-console * nova-consoleauth * nova-dhcpbridge * nova-network * nova-novncproxy * nova-objectstore * nova-rootwrap * nova-rpc-zmq-receiver * nova-scheduler * nova-volume-usage-audit * nova-volume * nova-xvpvncproxy Change-Id: I3734831ce2f6b5d765e98b3f50fe8c1ad7965685
2012-09-13 18:42:26 -07:00
=======
Fix indentation in doc/source/cli/* Current indentation was wrongly interpreted as quotes. Change-Id: I731d8833e69e6bed12f5637d6bb3248b890c18ab
2018-03-02 11:32:59 +01:00
**General options**
Add man pages Add partially written manpages for: * nova-all * nova-api-ec2 * nova-api-metadata * nova-api-os-compute * nova-api-os-volume * nova-api * nova-cert * nova-compute * nova-console * nova-consoleauth * nova-dhcpbridge * nova-network * nova-novncproxy * nova-objectstore * nova-rootwrap * nova-rpc-zmq-receiver * nova-scheduler * nova-volume-usage-audit * nova-volume * nova-xvpvncproxy Change-Id: I3734831ce2f6b5d765e98b3f50fe8c1ad7965685
2012-09-13 18:42:26 -07:00
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
2017-09-08 16:44:14 +01:00
Files
=====
Add man pages Add partially written manpages for: * nova-all * nova-api-ec2 * nova-api-metadata * nova-api-os-compute * nova-api-os-volume * nova-api * nova-cert * nova-compute * nova-console * nova-consoleauth * nova-dhcpbridge * nova-network * nova-novncproxy * nova-objectstore * nova-rootwrap * nova-rpc-zmq-receiver * nova-scheduler * nova-volume-usage-audit * nova-volume * nova-xvpvncproxy Change-Id: I3734831ce2f6b5d765e98b3f50fe8c1ad7965685
2012-09-13 18:42:26 -07:00
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
2017-09-08 16:44:14 +01:00
* ``/etc/nova/nova.conf``
* ``/etc/nova/api-paste.ini``
* ``/etc/nova/policy.json``
* ``/etc/nova/rootwrap.conf``
* ``/etc/nova/rootwrap.d/``
Add man pages Add partially written manpages for: * nova-all * nova-api-ec2 * nova-api-metadata * nova-api-os-compute * nova-api-os-volume * nova-api * nova-cert * nova-compute * nova-console * nova-consoleauth * nova-dhcpbridge * nova-network * nova-novncproxy * nova-objectstore * nova-rootwrap * nova-rpc-zmq-receiver * nova-scheduler * nova-volume-usage-audit * nova-volume * nova-xvpvncproxy Change-Id: I3734831ce2f6b5d765e98b3f50fe8c1ad7965685
2012-09-13 18:42:26 -07:00
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
2017-09-08 16:44:14 +01:00
See Also
Add man pages Add partially written manpages for: * nova-all * nova-api-ec2 * nova-api-metadata * nova-api-os-compute * nova-api-os-volume * nova-api * nova-cert * nova-compute * nova-console * nova-consoleauth * nova-dhcpbridge * nova-network * nova-novncproxy * nova-objectstore * nova-rootwrap * nova-rpc-zmq-receiver * nova-scheduler * nova-volume-usage-audit * nova-volume * nova-xvpvncproxy Change-Id: I3734831ce2f6b5d765e98b3f50fe8c1ad7965685
2012-09-13 18:42:26 -07:00
========
doc: Start using openstackdoctheme's extlink extension This ensures we have version-specific references to other projects [1]. Note that this doesn't mean the URLs are actually valid - we need to do more work (linkcheck?) here, but it's an improvement nonetheless. [1] https://docs.openstack.org/openstackdocstheme/latest/#external-link-helper Change-Id: Ifb99e727110c4904a85bc4a13366c2cae300b8df
2018-02-05 15:15:34 +00:00
* :nova-doc:`OpenStack Nova <>`
* :nova-doc:`Using WSGI with Nova <user/wsgi.html>`
Add man pages Add partially written manpages for: * nova-all * nova-api-ec2 * nova-api-metadata * nova-api-os-compute * nova-api-os-volume * nova-api * nova-cert * nova-compute * nova-console * nova-consoleauth * nova-dhcpbridge * nova-network * nova-novncproxy * nova-objectstore * nova-rootwrap * nova-rpc-zmq-receiver * nova-scheduler * nova-volume-usage-audit * nova-volume * nova-xvpvncproxy Change-Id: I3734831ce2f6b5d765e98b3f50fe8c1ad7965685
2012-09-13 18:42:26 -07:00
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
2017-09-08 16:44:14 +01:00
Bugs
Add man pages Add partially written manpages for: * nova-all * nova-api-ec2 * nova-api-metadata * nova-api-os-compute * nova-api-os-volume * nova-api * nova-cert * nova-compute * nova-console * nova-consoleauth * nova-dhcpbridge * nova-network * nova-novncproxy * nova-objectstore * nova-rootwrap * nova-rpc-zmq-receiver * nova-scheduler * nova-volume-usage-audit * nova-volume * nova-xvpvncproxy Change-Id: I3734831ce2f6b5d765e98b3f50fe8c1ad7965685
2012-09-13 18:42:26 -07:00
====
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
2017-09-08 16:44:14 +01:00
* Nova bugs are managed at `Launchpad <https://bugs.launchpad.net/nova>`__
Copy Permalink