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
This commit is contained in:
Joe Gordon 2012-09-13 18:42:26 -07:00
parent ebb22e3acd
commit 26c952c5db
23 changed files with 1051 additions and 2 deletions

View File

@ -18,7 +18,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.
"""Starter script for All nova services.
"""Starter script for all nova services.
This script attempts to start all the nova services in one process. Each
service is started in its own greenthread. Please note that exceptions and

View File

@ -119,7 +119,47 @@ modindex_common_prefix = ['nova.']
# List of tuples 'sourcefile', 'target', u'title', u'Authors name', 'manual'
man_pages = [
('man/nova-all', 'nova-all', u'Cloud controller fabric',
[u'OpenStack'], 1),
('man/nova-api-ec2', 'nova-api-ec2', u'Cloud controller fabric',
[u'OpenStack'], 1),
('man/nova-api-metadata', 'nova-api-metadata', u'Cloud controller fabric',
[u'OpenStack'], 1),
('man/nova-api-os-compute', 'nova-api-os-compute',
u'Cloud controller fabric', [u'OpenStack'], 1),
('man/nova-api-os-volume', 'nova-api-os-volume',
u'Cloud controller fabric', [u'OpenStack'], 1),
('man/nova-api', 'nova-api', u'Cloud controller fabric',
[u'OpenStack'], 1),
('man/nova-cert', 'nova-cert', u'Cloud controller fabric',
[u'OpenStack'], 1),
('man/nova-compute', 'nova-compute', u'Cloud controller fabric',
[u'OpenStack'], 1),
('man/nova-console', 'nova-console', u'Cloud controller fabric',
[u'OpenStack'], 1),
('man/nova-consoleauth', 'nova-consoleauth', u'Cloud controller fabric',
[u'OpenStack'], 1),
('man/nova-dhcpbridge', 'nova-dhcpbridge', u'Cloud controller fabric',
[u'OpenStack'], 1),
('man/nova-manage', 'nova-manage', u'Cloud controller fabric',
[u'OpenStack'], 1),
('man/nova-network', 'nova-network', u'Cloud controller fabric',
[u'OpenStack'], 1),
('man/nova-novncproxy', 'nova-novncproxy', u'Cloud controller fabric',
[u'OpenStack'], 1),
('man/nova-objectstore', 'nova-objectstore', u'Cloud controller fabric',
[u'OpenStack'], 1),
('man/nova-rootwrap', 'nova-rootwrap', u'Cloud controller fabric',
[u'OpenStack'], 1),
('man/nova-rpc-zmq-receiver', 'nova-rpc-zmq-receiver', u'Cloud controller fabric',
[u'OpenStack'], 1),
('man/nova-scheduler', 'nova-scheduler', u'Cloud controller fabric',
[u'OpenStack'], 1),
('man/nova-volume-usage-audit', 'nova-volume-usage-audit', u'Cloud controller fabric',
[u'OpenStack'], 1),
('man/nova-volume', 'nova-volume', u'Cloud controller fabric',
[u'OpenStack'], 1),
('man/nova-xvpvncproxy', 'nova-xvpvncproxy', u'Cloud controller fabric',
[u'OpenStack'], 1)
]

View File

@ -0,0 +1,49 @@
=========
nova-all
=========
-----------------------------
Server for all Nova services
-----------------------------
:Author: openstack@lists.launchpad.net
:Date: 2012-09-27
:Copyright: OpenStack LLC
:Version: 2012.1
:Manual section: 1
:Manual group: cloud computing
SYNOPSIS
========
nova-all [options]
DESCRIPTION
===========
nova-all is a server daemon that serves all Nova services, each in a separate greenthread
OPTIONS
=======
**General options**
FILES
========
* /etc/nova/nova.conf
* /etc/nova/api-paste.ini
* /etc/nova/policy.json
* /etc/nova/rootwrap.conf
* /etc/nova/rootwrap.d/
SEE ALSO
========
* `OpenStack Nova <http://nova.openstack.org>`__
* `OpenStack Nova <http://nova.openstack.org>`__
BUGS
====
* Nova is sourced in Launchpad so you can view current bugs at `OpenStack Nova <http://nova.openstack.org>`__

View File

@ -0,0 +1,49 @@
============
nova-api-ec2
============
----------------------------
Server for the Nova EC2 API
----------------------------
:Author: openstack@lists.launchpad.net
:Date: 2012-09-27
:Copyright: OpenStack LLC
:Version: 2012.1
:Manual section: 1
:Manual group: cloud computing
SYNOPSIS
========
nova-api-ec2 [options]
DESCRIPTION
===========
nova-api-ec2 is a server daemon that serves the Nova EC2 API
OPTIONS
=======
**General options**
FILES
========
* /etc/nova/nova.conf
* /etc/nova/api-paste.ini
* /etc/nova/policy.json
* /etc/nova/rootwrap.conf
* /etc/nova/rootwrap.d/
SEE ALSO
========
* `OpenStack Nova <http://nova.openstack.org>`__
* `OpenStack Nova <http://nova.openstack.org>`__
BUGS
====
* Nova is sourced in Launchpad so you can view current bugs at `OpenStack Nova <http://nova.openstack.org>`__

View File

@ -0,0 +1,49 @@
=================
nova-api-metadata
=================
---------------------------------
Server for the Nova Metadata API
---------------------------------
:Author: openstack@lists.launchpad.net
:Date: 2012-09-27
:Copyright: OpenStack LLC
:Version: 2012.1
:Manual section: 1
:Manual group: cloud computing
SYNOPSIS
========
nova-api-metadata [options]
DESCRIPTION
===========
nova-api-metadata is a server daemon that serves the Nova Metadata API
OPTIONS
=======
**General options**
FILES
========
* /etc/nova/nova.conf
* /etc/nova/api-paste.ini
* /etc/nova/policy.json
* /etc/nova/rootwrap.conf
* /etc/nova/rootwrap.d/
SEE ALSO
========
* `OpenStack Nova <http://nova.openstack.org>`__
* `OpenStack Nova <http://nova.openstack.org>`__
BUGS
====
* Nova is sourced in Launchpad so you can view current bugs at `OpenStack Nova <http://nova.openstack.org>`__

View File

@ -0,0 +1,49 @@
====================
nova-api-os-compute
====================
-------------------------------------------
Server for the Nova OpenStack Compute APIs
-------------------------------------------
:Author: openstack@lists.launchpad.net
:Date: 2012-09-27
:Copyright: OpenStack LLC
:Version: 2012.1
:Manual section: 1
:Manual group: cloud computing
SYNOPSIS
========
nova-api-os-compute [options]
DESCRIPTION
===========
nova-api-os-compute is a server daemon that serves the Nova OpenStack Compute API
OPTIONS
=======
**General options**
FILES
========
* /etc/nova/nova.conf
* /etc/nova/api-paste.ini
* /etc/nova/policy.json
* /etc/nova/rootwrap.conf
* /etc/nova/rootwrap.d/
SEE ALSO
========
* `OpenStack Nova <http://nova.openstack.org>`__
* `OpenStack Nova <http://nova.openstack.org>`__
BUGS
====
* Nova is sourced in Launchpad so you can view current bugs at `OpenStack Nova <http://nova.openstack.org>`__

View File

@ -0,0 +1,49 @@
===================
nova-api-os-volume
===================
-------------------------------------------
Server for the Nova OpenStack Volume APIs
-------------------------------------------
:Author: openstack@lists.launchpad.net
:Date: 2012-09-27
:Copyright: OpenStack LLC
:Version: 2012.1
:Manual section: 1
:Manual group: cloud computing
SYNOPSIS
========
nova-api-os-volume [options]
DESCRIPTION
===========
nova-api-os-volume is a server daemon that serves the Nova OpenStack API
OPTIONS
=======
**General options**
FILES
========
* /etc/nova/nova.conf
* /etc/nova/api-paste.ini
* /etc/nova/policy.json
* /etc/nova/rootwrap.conf
* /etc/nova/rootwrap.d/
SEE ALSO
========
* `OpenStack Nova <http://nova.openstack.org>`__
* `OpenStack Nova <http://nova.openstack.org>`__
BUGS
====
* Nova is sourced in Launchpad so you can view current bugs at `OpenStack Nova <http://nova.openstack.org>`__

View File

@ -0,0 +1,49 @@
========
nova-api
========
-------------------------------------------
Server for the Nova EC2 and OpenStack APIs
-------------------------------------------
:Author: openstack@lists.launchpad.net
:Date: 2012-09-27
:Copyright: OpenStack LLC
:Version: 2012.1
:Manual section: 1
:Manual group: cloud computing
SYNOPSIS
========
nova-api [options]
DESCRIPTION
===========
nova-api is a server daemon that serves the nova EC2 and OpenStack APIs in separate greenthreads
OPTIONS
=======
**General options**
FILES
========
* /etc/nova/nova.conf
* /etc/nova/api-paste.ini
* /etc/nova/policy.json
* /etc/nova/rootwrap.conf
* /etc/nova/rootwrap.d/
SEE ALSO
========
* `OpenStack Nova <http://nova.openstack.org>`__
* `OpenStack Nova <http://nova.openstack.org>`__
BUGS
====
* Nova is sourced in Launchpad so you can view current bugs at `OpenStack Nova <http://nova.openstack.org>`__

View File

@ -0,0 +1,48 @@
==========
nova-cert
==========
--------------------------------
Server for the Nova Cert
--------------------------------
:Author: openstack@lists.launchpad.net
:Date: 2012-09-27
:Copyright: OpenStack LLC
:Version: 2012.1
:Manual section: 1
:Manual group: cloud computing
SYNOPSIS
========
nova-cert [options]
DESCRIPTION
===========
nova-cert is a server daemon that serves the Nova Cert service for X509 certificates.
OPTIONS
=======
**General options**
FILES
========
* /etc/nova/nova.conf
* /etc/nova/policy.json
* /etc/nova/rootwrap.conf
* /etc/nova/rootwrap.d/
SEE ALSO
========
* `OpenStack Nova <http://nova.openstack.org>`__
* `OpenStack Nova <http://nova.openstack.org>`__
BUGS
====
* Nova is sourced in Launchpad so you can view current bugs at `OpenStack Nova <http://nova.openstack.org>`__

View File

@ -0,0 +1,51 @@
============
nova-compute
============
---------------------
Nova Compute Server
---------------------
:Author: openstack@lists.launchpad.net
:Date: 2012-09-27
:Copyright: OpenStack LLC
:Version: 2012.1
:Manual section: 1
:Manual group: cloud computing
SYNOPSIS
========
nova-compute [options]
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.
OPTIONS
=======
**General options**
FILES
========
* /etc/nova/nova.conf
* /etc/nova/policy.json
* /etc/nova/rootwrap.conf
* /etc/nova/rootwrap.d/
SEE ALSO
========
* `OpenStack Nova <http://nova.openstack.org>`__
* `OpenStack Nova <http://nova.openstack.org>`__
BUGS
====
* Nova is sourced in Launchpad so you can view current bugs at `OpenStack Nova <http://nova.openstack.org>`__

View File

@ -0,0 +1,48 @@
============
nova-console
============
----------------------------
Nova Console Server
----------------------------
:Author: openstack@lists.launchpad.net
:Date: 2012-09-27
:Copyright: OpenStack LLC
:Version: 2012.1
:Manual section: 1
:Manual group: cloud computing
SYNOPSIS
========
nova-console [options]
DESCRIPTION
===========
nova-console is a console Proxy to set up multi-tenant VM console access (i.e. with xvp)
OPTIONS
=======
**General options**
FILES
========
* /etc/nova/nova.conf
* /etc/nova/policy.json
* /etc/nova/rootwrap.conf
* /etc/nova/rootwrap.d/
SEE ALSO
========
* `OpenStack Nova <http://nova.openstack.org>`__
* `OpenStack Nova <http://nova.openstack.org>`__
BUGS
====
* Nova is sourced in Launchpad so you can view current bugs at `OpenStack Nova <http://nova.openstack.org>`__

View File

@ -0,0 +1,48 @@
================
nova-consoleauth
================
-------------------------------------------
Nova Console Authentication Server
-------------------------------------------
:Author: openstack@lists.launchpad.net
:Date: 2012-09-27
:Copyright: OpenStack LLC
:Version: 2012.1
:Manual section: 1
:Manual group: cloud computing
SYNOPSIS
========
nova-consoleauth [options]
DESCRIPTION
===========
Provides Authentication for nova consoles
OPTIONS
=======
**General options**
FILES
========
* /etc/nova/nova.conf
* /etc/nova/policy.json
* /etc/nova/rootwrap.conf
* /etc/nova/rootwrap.d/
SEE ALSO
========
* `OpenStack Nova <http://nova.openstack.org>`__
* `OpenStack Nova <http://nova.openstack.org>`__
BUGS
====
* Nova is sourced in Launchpad so you can view current bugs at `OpenStack Nova <http://nova.openstack.org>`__

View File

@ -0,0 +1,50 @@
===============
nova-dhcpbridge
===============
--------------------------------------------------
Handles Lease Database updates from DHCP servers
--------------------------------------------------
:Author: openstack@lists.launchpad.net
:Date: 2012-09-27
:Copyright: OpenStack LLC
:Version: 2012.1
:Manual section: 1
:Manual group: cloud computing
SYNOPSIS
========
nova-dhcpbridge [options]
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.
OPTIONS
=======
**General options**
FILES
========
* /etc/nova/nova.conf
* /etc/nova/api-paste.ini
* /etc/nova/policy.json
* /etc/nova/rootwrap.conf
* /etc/nova/rootwrap.d/
SEE ALSO
========
* `OpenStack Nova <http://nova.openstack.org>`__
* `OpenStack Nova <http://nova.openstack.org>`__
BUGS
====
* Nova is sourced in Launchpad so you can view current bugs at `OpenStack Nova <http://nova.openstack.org>`__

View File

@ -89,7 +89,7 @@ Nova VPN
``nova-manage vpn list``
Displays a list of projects, their IP prot numbers, and what state they're in.
Displays a list of projects, their IP port numbers, and what state they're in.
``nova-manage vpn run <projectname>``

View File

@ -0,0 +1,48 @@
=============
nova-network
=============
---------------------
Nova Network Server
---------------------
:Author: openstack@lists.launchpad.net
:Date: 2012-09-27
:Copyright: OpenStack LLC
:Version: 2012.1
:Manual section: 1
:Manual group: cloud computing
SYNOPSIS
========
nova-network [options]
DESCRIPTION
===========
Nova Network is responsible for allocating IPs and setting up the network
OPTIONS
=======
**General options**
FILES
========
* /etc/nova/nova.conf
* /etc/nova/policy.json
* /etc/nova/rootwrap.conf
* /etc/nova/rootwrap.d/
SEE ALSO
========
* `OpenStack Nova <http://nova.openstack.org>`__
* `OpenStack Nova <http://nova.openstack.org>`__
BUGS
====
* Nova is sourced in Launchpad so you can view current bugs at `OpenStack Nova <http://nova.openstack.org>`__

View File

@ -0,0 +1,48 @@
===============
nova-novncproxy
===============
-------------------------------------------
Websocket novnc Proxy for OpenStack Nova.
-------------------------------------------
:Author: openstack@lists.launchpad.net
:Date: 2012-09-27
:Copyright: OpenStack LLC
:Version: 2012.1
:Manual section: 1
:Manual group: cloud computing
SYNOPSIS
========
nova-novncproxy [options]
DESCRIPTION
===========
Websocket proxy that is compatible with OpenStack Nova.
OPTIONS
=======
**General options**
FILES
========
* /etc/nova/nova.conf
* /etc/nova/policy.json
* /etc/nova/rootwrap.conf
* /etc/nova/rootwrap.d/
SEE ALSO
========
* `OpenStack Nova <http://nova.openstack.org>`__
* `OpenStack Nova <http://nova.openstack.org>`__
BUGS
====
* Nova is sourced in Launchpad so you can view current bugs at `OpenStack Nova <http://nova.openstack.org>`__

View File

@ -0,0 +1,56 @@
================
nova-objectstore
================
-----------------------------
Nova Objectstore Server
-----------------------------
:Author: openstack@lists.launchpad.net
:Date: 2012-09-27
:Copyright: OpenStack LLC
:Version: 2012.1
:Manual section: 1
:Manual group: cloud computing
SYNOPSIS
========
nova-objectstore [options]
DESCRIPTION
===========
Implementation of an S3-like storage server based on local files.
Useful to test features that will eventually run on S3, or if you want to
run something locally that was once running on S3.
We don't support all the features of S3, but it does work with the
standard S3 client for the most basic semantics.
Used for testing when do not have OpenStack Swift installed.
OPTIONS
=======
**General options**
FILES
========
* /etc/nova/nova.conf
* /etc/nova/policy.json
* /etc/nova/rootwrap.conf
* /etc/nova/rootwrap.d/
SEE ALSO
========
* `OpenStack Nova <http://nova.openstack.org>`__
* `OpenStack Nova <http://nova.openstack.org>`__
BUGS
====
* Nova is sourced in Launchpad so you can view current bugs at `OpenStack Nova <http://nova.openstack.org>`__

View File

@ -0,0 +1,59 @@
=============
nova-rootwrap
=============
-----------------------
Root wrapper for Nova
-----------------------
:Author: openstack@lists.launchpad.net
:Date: 2012-09-27
:Copyright: OpenStack LLC
:Version: 2012.1
:Manual section: 1
:Manual group: cloud computing
SYNOPSIS
========
nova-rootwrap [options]
DESCRIPTION
===========
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
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 *
To make allowed commands node-specific, your packaging should only
install {compute,network,volume}.filters respectively on compute, network
and volume nodes (i.e. nova-api nodes should not have any of those files
installed).
OPTIONS
=======
**General options**
FILES
========
* /etc/nova/nova.conf
* /etc/nova/rootwrap.conf
* /etc/nova/rootwrap.d/
SEE ALSO
========
* `OpenStack Nova <http://nova.openstack.org>`__
* `OpenStack Nova <http://nova.openstack.org>`__
BUGS
====
* Nova is sourced in Launchpad so you can view current bugs at `OpenStack Nova <http://nova.openstack.org>`__

View File

@ -0,0 +1,48 @@
=======================
nova-rpc-zmq-receiver
=======================
-----------------------------------
Receiver for 0MQ based nova RPC
-----------------------------------
:Author: openstack@lists.launchpad.net
:Date: 2012-09-27
:Copyright: OpenStack LLC
:Version: 2012.1
:Manual section: 1
:Manual group: cloud computing
SYNOPSIS
========
nova-rpc-zmq-receiver [options]
DESCRIPTION
===========
The nova-rpc-zmq-receiver is a daemon which receives messages from remote
systems on behalf of the ZeroMQ-based rpc backend (nova.rpc.impl_zmq).
Messages are pulled by individual services from the message receiver daemon
in round-robin or fanout mode, depending on the queue type.
OPTIONS
=======
**General options**
FILES
========
* /etc/nova/nova.conf
SEE ALSO
========
* `OpenStack Nova <http://nova.openstack.org>`__
* `OpenStack Nova <http://nova.openstack.org>`__
BUGS
====
* Nova is sourced in Launchpad so you can view current bugs at `OpenStack Nova <http://nova.openstack.org>`__

View File

@ -0,0 +1,48 @@
==============
nova-scheduler
==============
--------------
Nova Scheduler
--------------
:Author: openstack@lists.launchpad.net
:Date: 2012-09-27
:Copyright: OpenStack LLC
:Version: 2012.1
:Manual section: 1
:Manual group: cloud computing
SYNOPSIS
========
nova-scheduler [options]
DESCRIPTION
===========
Nova Scheduler picks a compute node to run a VM instance.
OPTIONS
=======
**General options**
FILES
========
* /etc/nova/nova.conf
* /etc/nova/policy.json
* /etc/nova/rootwrap.conf
* /etc/nova/rootwrap.d/
SEE ALSO
========
* `OpenStack Nova <http://nova.openstack.org>`__
* `OpenStack Nova <http://nova.openstack.org>`__
BUGS
====
* Nova is sourced in Launchpad so you can view current bugs at `OpenStack Nova <http://nova.openstack.org>`__

View File

@ -0,0 +1,61 @@
=======================
nova-volume-usage-audit
=======================
-------------------------------------------
Generate Usage Notifications for Volumes
-------------------------------------------
:Author: openstack@lists.launchpad.net
:Date: 2012-09-27
:Copyright: OpenStack LLC
:Version: 2012.1
:Manual section: 1
:Manual group: cloud computing
SYNOPSIS
========
nova-volume-usage-audit [options]
DESCRIPTION
===========
Cron script to generate usage notifications for volumes existing during
the audit period.
Together with the notifications generated by volumes
create/delete/resize, over that time period, this allows an external
system consuming usage notification feeds to calculate volume usage
for each tenant.
Time periods are specified as 'hour', 'month', 'day' or 'year'
hour = previous hour. If run at 9:07am, will generate usage for 8-9am.
month = previous month. If the script is run April 1, it will generate
usages for March 1 through March 31.
day = previous day. if run on July 4th, it generates usages for July 3rd.
year = previous year. If run on Jan 1, it generates usages for
Jan 1 through Dec 31 of the previous year.
OPTIONS
=======
**General options**
FILES
========
* /etc/nova/nova.conf
SEE ALSO
========
* `OpenStack Nova <http://nova.openstack.org>`__
* `OpenStack Nova <http://nova.openstack.org>`__
BUGS
====
* Nova is sourced in Launchpad so you can view current bugs at `OpenStack Nova <http://nova.openstack.org>`__

View File

@ -0,0 +1,54 @@
===========
nova-volume
===========
-------------------
Nova Volume Server
-------------------
:Author: openstack@lists.launchpad.net
:Date: 2012-09-27
:Copyright: OpenStack LLC
:Version: 2012.1
:Manual section: 1
:Manual group: cloud computing
SYNOPSIS
========
nova-volume [options]
DESCRIPTION
===========
nova-volume manages creating, attaching, detaching, and persistent storage.
Persistent storage volumes keep their state independent of instances. You can
attach to an instance, terminate the instance, spawn a new instance (even
one from a different image) and re-attach the volume with the same data
intact.
OPTIONS
=======
**General options**
FILES
========
* /etc/nova/nova.conf
* /etc/nova/policy.json
* /etc/nova/rootwrap.conf
* /etc/nova/rootwrap.d/
SEE ALSO
========
* `OpenStack Nova <http://nova.openstack.org>`__
* `OpenStack Nova <http://nova.openstack.org>`__
BUGS
====
* Nova is sourced in Launchpad so you can view current bugs at `OpenStack Nova <http://nova.openstack.org>`__

View File

@ -0,0 +1,48 @@
================
nova-xvpvncproxy
================
-----------------------------
XVP VNC Console Proxy Server
-----------------------------
:Author: openstack@lists.launchpad.net
:Date: 2012-09-27
:Copyright: OpenStack LLC
:Version: 2012.1
:Manual section: 1
:Manual group: cloud computing
SYNOPSIS
========
nova-xvpvncproxy [options]
DESCRIPTION
===========
XVP VNC Console Proxy Server
OPTIONS
=======
**General options**
FILES
========
* /etc/nova/nova.conf
* /etc/nova/policy.json
* /etc/nova/rootwrap.conf
* /etc/nova/rootwrap.d/
SEE ALSO
========
* `OpenStack Nova <http://nova.openstack.org>`__
* `OpenStack Nova <http://nova.openstack.org>`__
BUGS
====
* Nova is sourced in Launchpad so you can view current bugs at `OpenStack Nova <http://nova.openstack.org>`__