openstack/python-novaclient
Code Issues Proposed changes
6beef56634
python-novaclient/doc/source/index.rst

28 lines
881 B
ReStructuredText
Raw Normal View History

doc: Create directory structure for docs migration The spec [1] recommends the following sections: - install - contributor - configuration - cli - admin - user - reference Only a few of these are useful here: - contributor - cli - user - reference Add these and populate them. [1] specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration Change-Id: I8a9ddcc915f25ebfaa1e994dba6c15883bd2715d
2017-07-04 11:06:56 +01:00
===========================================
Python bindings to the OpenStack Nova API
===========================================
Initial commit from fork
2011-01-25 14:01:22 -06:00
Renamed all CloudServers to OpenStack and python-cloudservers to python-novatools
2011-02-08 09:27:22 -04:00
This is a client for OpenStack Nova API. There's :doc:`a Python API
doc: Create directory structure for docs migration The spec [1] recommends the following sections: - install - contributor - configuration - cli - admin - user - reference Only a few of these are useful here: - contributor - cli - user - reference Add these and populate them. [1] specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration Change-Id: I8a9ddcc915f25ebfaa1e994dba6c15883bd2715d
2017-07-04 11:06:56 +01:00
<reference/api/index>` (the :mod:`novaclient` module), and a :doc:`command-line
script </user/shell>` (installed as :program:`nova`). Each implements the
entire OpenStack Nova API.
Initial commit from fork
2011-01-25 14:01:22 -06:00
doc: Create directory structure for docs migration The spec [1] recommends the following sections: - install - contributor - configuration - cli - admin - user - reference Only a few of these are useful here: - contributor - cli - user - reference Add these and populate them. [1] specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration Change-Id: I8a9ddcc915f25ebfaa1e994dba6c15883bd2715d
2017-07-04 11:06:56 +01:00
You'll need credentials for an OpenStack cloud that implements the Compute API,
such as TryStack, HP, or Rackspace, in order to use the nova client.
Initial commit from fork
2011-01-25 14:01:22 -06:00
.. seealso::
Update Compute API Guide pointer Since the description of the individual API calls have been moved to the API Reference, the API Guide is more or less what the "overview" in the original guide was. Therefore I just pointed to the guide, and removed the phrase "-- the overview, at least --". Change-Id: I8b1cb6a7ea4469a91f0dfe69d26f4ffec178ed43 Closes-Bug: 1678591 Signed-off-by: Simon Leinen <simon.leinen@gmail.com>
2017-04-02 12:55:20 +02:00
You may want to read the `OpenStack Compute API Guide`__
to get an idea of the concepts. By understanding the concepts
Initial commit from fork
2011-01-25 14:01:22 -06:00
this library should make more sense.
Update Compute API Guide pointer Since the description of the individual API calls have been moved to the API Reference, the API Guide is more or less what the "overview" in the original guide was. Therefore I just pointed to the guide, and removed the phrase "-- the overview, at least --". Change-Id: I8b1cb6a7ea4469a91f0dfe69d26f4ffec178ed43 Closes-Bug: 1678591 Signed-off-by: Simon Leinen <simon.leinen@gmail.com>
2017-04-02 12:55:20 +02:00
__ https://developer.openstack.org/api-guide/compute/index.html
Initial commit from fork
2011-01-25 14:01:22 -06:00
.. toctree::
:maxdepth: 2
whitespace cleanups
2011-08-08 13:20:44 -07:00
doc: Create directory structure for docs migration The spec [1] recommends the following sections: - install - contributor - configuration - cli - admin - user - reference Only a few of these are useful here: - contributor - cli - user - reference Add these and populate them. [1] specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration Change-Id: I8a9ddcc915f25ebfaa1e994dba6c15883bd2715d
2017-07-04 11:06:56 +01:00
user/index
reference/index
cli/index
contributor/index
Copy Permalink