Provide nova CLI man page.
Resolves: bug 1130815 Blueprint: clients-man-pages Provide basic but hopefully useful man page. Change-Id: I6c520fa3acdb82dd564b758b9cdc448eecc6d6ce
This commit is contained in:
parent
c6b913cbc7
commit
37da28cff4
@ -40,16 +40,16 @@ master_doc = 'index'
|
|||||||
|
|
||||||
# General information about the project.
|
# General information about the project.
|
||||||
project = u'python-novaclient'
|
project = u'python-novaclient'
|
||||||
copyright = u'Rackspace, based on work by Jacob Kaplan-Moss'
|
copyright = u'OpenStack Contributors'
|
||||||
|
|
||||||
# The version info for the project you're documenting, acts as replacement for
|
# The version info for the project you're documenting, acts as replacement for
|
||||||
# |version| and |release|, also used in various other places throughout the
|
# |version| and |release|, also used in various other places throughout the
|
||||||
# built documents.
|
# built documents.
|
||||||
#
|
#
|
||||||
# The short X.Y version.
|
# The short X.Y version.
|
||||||
version = '2.6'
|
version = '2.13'
|
||||||
# The full version, including alpha/beta/rc tags.
|
# The full version, including alpha/beta/rc tags.
|
||||||
release = '2.6.10'
|
release = '2.13.0'
|
||||||
|
|
||||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||||
# for a list of supported languages.
|
# for a list of supported languages.
|
||||||
@ -89,6 +89,13 @@ pygments_style = 'sphinx'
|
|||||||
# A list of ignored prefixes for module index sorting.
|
# A list of ignored prefixes for module index sorting.
|
||||||
#modindex_common_prefix = []
|
#modindex_common_prefix = []
|
||||||
|
|
||||||
|
# Grouping the document tree for man pages.
|
||||||
|
# List of tuples 'sourcefile', 'target', u'title', u'Authors name', 'manual'
|
||||||
|
|
||||||
|
man_pages = [
|
||||||
|
('man/nova', 'nova', u'OpenStack Nova command line client',
|
||||||
|
[u'OpenStack Contributors'], 1),
|
||||||
|
]
|
||||||
|
|
||||||
# -- Options for HTML output --------------------------------------------------
|
# -- Options for HTML output --------------------------------------------------
|
||||||
|
|
||||||
|
85
doc/source/man/nova.rst
Normal file
85
doc/source/man/nova.rst
Normal file
@ -0,0 +1,85 @@
|
|||||||
|
====
|
||||||
|
nova
|
||||||
|
====
|
||||||
|
|
||||||
|
|
||||||
|
SYNOPSIS
|
||||||
|
========
|
||||||
|
|
||||||
|
`nova` [options] <command> [command-options]
|
||||||
|
|
||||||
|
`nova help`
|
||||||
|
|
||||||
|
`nova help` <command>
|
||||||
|
|
||||||
|
|
||||||
|
DESCRIPTION
|
||||||
|
===========
|
||||||
|
|
||||||
|
`nova` is a command line client for controlling OpenStack Nova, the cloud
|
||||||
|
computing fabric controller. It implements 100% of the Nova API, allowing
|
||||||
|
management of instances, images, quotas and much more.
|
||||||
|
|
||||||
|
Before you can issue commands with `nova`, you must ensure that your
|
||||||
|
environment contains the necessary variables so that you can prove to the CLI
|
||||||
|
who you are and what credentials you have to issue the commands. See
|
||||||
|
`Getting Credentials for a CLI` section of `OpenStack CLI Guide` for more
|
||||||
|
info.
|
||||||
|
|
||||||
|
See `OpenStack Nova CLI Guide` for a full-fledged guide.
|
||||||
|
|
||||||
|
|
||||||
|
OPTIONS
|
||||||
|
=======
|
||||||
|
|
||||||
|
To get a list of available commands and options run::
|
||||||
|
|
||||||
|
nova help
|
||||||
|
|
||||||
|
To get usage and options of a command run::
|
||||||
|
|
||||||
|
nova help <command>
|
||||||
|
|
||||||
|
|
||||||
|
EXAMPLES
|
||||||
|
========
|
||||||
|
|
||||||
|
Get information about boot command::
|
||||||
|
|
||||||
|
nova help boot
|
||||||
|
|
||||||
|
List available images::
|
||||||
|
|
||||||
|
nova image-list
|
||||||
|
|
||||||
|
List available flavors::
|
||||||
|
|
||||||
|
nova flavor-list
|
||||||
|
|
||||||
|
Launch an instance::
|
||||||
|
|
||||||
|
nova boot myserver --image some-image --flavor 2
|
||||||
|
|
||||||
|
View instance information::
|
||||||
|
|
||||||
|
nova show myserver
|
||||||
|
|
||||||
|
List instances::
|
||||||
|
|
||||||
|
nova list
|
||||||
|
|
||||||
|
Terminate an instance::
|
||||||
|
|
||||||
|
nova delete myserver
|
||||||
|
|
||||||
|
|
||||||
|
SEE ALSO
|
||||||
|
========
|
||||||
|
|
||||||
|
OpenStack Nova CLI Guide: http://docs.openstack.org/cli/quick-start/content/nova-cli-reference.html
|
||||||
|
|
||||||
|
|
||||||
|
BUGS
|
||||||
|
====
|
||||||
|
|
||||||
|
Nova client is hosted in Launchpad so you can view current bugs at https://bugs.launchpad.net/python-novaclient/.
|
Loading…
x
Reference in New Issue
Block a user