openstack
/
python-novaclient
Code Issues Proposed changes
OpenStack Compute (Nova) Client
1,989 Commits 9 Branches 33 Tags 35 MiB
Python 100%
Go to file
Chris Yeoh 0343dff973 Removes reference to v3 nova api from novaclient docs 
The Nova V3 API no longer exists. Although a version of the framework
exists in Nova as part of the new V2.1 API which is equivalent to
the V2 API there is no need to make mention of V3 in the novaclient
documentation.

In future we will be distinguish between legacy Nova API support (one
implementation of V2) and microversions Nova API support (the
new one) to reduce confusion around version numbers which will change quite
a bit without the framework changing.

Co-Authored-By: Andrey Kurilin <akurilin@mirantis.com>

Change-Id: Id0ff51e1165cb267045d7a63aff13c0e41336738
 		2015-03-25 12:15:40 +10:30
doc Removes reference to v3 nova api from novaclient docs 2015-03-25 12:15:40 +10:30
novaclient Revert 'Remove image to local block device mapping' 2015-03-19 22:58:17 +08:00
tools add pretty_tox to nova functional tests 2015-02-23 17:22:10 -05:00
.coveragerc Update .coveragerc 2013-02-06 16:47:06 +02:00
.gitignore Updates .gitignore 2013-11-28 22:36:20 +08:00
.gitreview Add .gitreview config file for gerrit. 2011-11-16 09:23:10 -08:00
.mailmap Add mailmap entry 2014-05-07 12:16:41 -07:00
.testr.conf Add OS_TEST_PATH to testr 2015-01-27 13:09:42 -08:00
CONTRIBUTING.rst Workflow documentation is now in infra-manual 2014-12-05 03:30:40 +00:00
HACKING.rst Clean up a little cruft 2013-09-20 16:02:48 -07:00
LICENSE whitespace cleanups 2011-08-08 13:25:29 -07:00
MANIFEST.in Update to latest openstack.common.setup. 2013-03-28 06:40:13 +01:00
README.rst Rename v1_1 to v2 2015-02-04 17:40:46 +02:00
openstack-common.conf Port to use oslo.i18n 2014-10-16 01:19:48 +03:00
requirements.txt Updated from global requirements 2015-03-21 00:17:56 +00:00
run_tests.sh Migrate to flake8. 2013-05-25 08:22:39 +02:00
setup.cfg Merge "Support building wheels (PEP-427)" 2014-03-28 18:56:47 +00:00
setup.py Updated from global requirements 2014-04-30 02:46:46 +00:00
test-requirements.txt Updated from global requirements 2015-03-21 00:17:56 +00:00
tox.ini Enable check for E124 rule 2015-02-27 16:30:03 +03:00

README.rst

Python bindings to the OpenStack Nova API

This is a client for the OpenStack Nova API. There's a Python API (the novaclient module), and a command-line script (nova). Each implements 100% of the OpenStack Nova API.

See the OpenStack CLI guide for information on how to use the nova command-line tool. You may also want to look at the OpenStack API documentation.

The project is hosted on Launchpad, where bugs can be filed. The code is hosted on Github. Patches must be submitted using Gerrit, not Github pull requests.

python-novaclient is licensed under the Apache License like the rest of OpenStack.

Contents:

Command-line API

Installing this package gets you a shell command, nova, that you can use to interact with any OpenStack cloud.

You'll need to provide your OpenStack username and password. You can do this with the --os-username, --os-password and --os-tenant-name params, but it's easier to just set them as environment variables:

export OS_USERNAME=openstack
export OS_PASSWORD=yadayada
export OS_TENANT_NAME=myproject

You will also need to define the authentication url with --os-auth-url and the version of the API with --os-compute-api-version. Or set them as an environment variables as well:

export OS_AUTH_URL=http://example.com:8774/v1.1/
export OS_COMPUTE_API_VERSION=2

If you are using Keystone, you need to set the OS_AUTH_URL to the keystone endpoint:

export OS_AUTH_URL=http://example.com:5000/v2.0/

Since Keystone can return multiple regions in the Service Catalog, you can specify the one you want with --os-region-name (or export OS_REGION_NAME). It defaults to the first in the list returned.

You'll find complete documentation on the shell by running nova help

Python API

There's also a complete Python API, but it has not yet been documented.

To use with nova, with keystone as the authentication system:

# use v2.0 auth with http://example.com:5000/v2.0/")
>>> from novaclient.v2 import client
>>> nt = client.Client(USER, PASS, TENANT, AUTH_URL, service_type="compute")
>>> nt.flavors.list()
[...]
>>> nt.servers.list()
[...]
>>> nt.keypairs.list()
[...]