OpenStack Compute (Nova) Client
Go to file
Dan Smith 41aeb89cae Fix aggregate_update name and availability_zone clash
The name and availability_zone arguments to aggregate update were
replaced by optional parameters in change
I778ab7ec54a376c60f19dcc89fe62fcab6e59e42. However, the '--name' and
'name' arguments in the parser would conflict, resulting in only the
deprecated argument working. Thus, attempting to update the name
on an aggregate using --name would end up doing a PUT with no new
name provided.

Note that there were unit tests for this, but they were not catching
this problem. So, this removes those tests and adds functional tests
to poke it.

Change-Id: Ifef6fdc1a737dd219712a4525d4e34afd3fbd80c
Closes-Bug: #1673789
(cherry picked from commit 20f00553d0)
(cherry picked from commit 983f7211a8)
2017-10-03 20:43:47 +00:00
doc The novaclient Python API doc keystoneauth example fixed 2016-03-02 14:25:29 +02:00
novaclient Fix aggregate_update name and availability_zone clash 2017-10-03 20:43:47 +00:00
releasenotes fix formatting of release note 2017-06-05 14:33:14 -04:00
tools Use upper-constraints when running tox 2016-11-29 14:44:08 -05:00
.coveragerc Change ignore-errors to ignore_errors 2015-09-21 14:54:09 +00:00
.gitignore Add eggs to gitignore list 2016-08-18 15:02:14 +03:00
.gitreview Update .gitreview for stable/newton 2016-09-02 09:43:43 -04: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
README.rst Update README to comply with Identity v3 2016-06-16 16:30:23 -03:00
babel.cfg Enable i18n with Babel. 2015-09-08 10:10:25 -07:00
bindep.txt Move other-requirements.txt to bindep.txt 2016-08-12 21:14:16 +02:00
requirements.txt Updated from global requirements 2016-08-01 18:47:30 +00:00
run_tests.sh Deprecate run_test.sh 2016-02-21 06:19:17 +08:00
setup.cfg Update the home-page with developer documentation 2016-05-17 10:13:18 +05:30
setup.py Updated from global requirements 2015-09-17 12:16:56 +00:00
test-requirements.txt Updated from global requirements 2016-09-20 13:16:21 +00:00
tox.ini Update UPPER_CONSTRAINTS_FILE for stable/newton 2017-04-21 16:11:08 +03:00

README.rst

Python bindings to the OpenStack Nova API

Latest Version

Downloads

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.

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-project-name params, but it's easier to just set them as environment variables:

export OS_USERNAME=<username>
export OS_PASSWORD=<password>
export OS_PROJECT_NAME=<project-name>

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 environment variables as well and set the OS_AUTH_URL to the keystone endpoint:

export OS_AUTH_URL=http://<url-to-openstack-keystone>:5000/v3/
export OS_COMPUTE_API_VERSION=2.1

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, with documentation linked below.

To use with keystone as the authentication system:

>>> from keystoneauth1.identity import v3
>>> from keystoneauth1 import session
>>> from novaclient import client
>>> auth = v3.Password(auth_url='http://example.com:5000/v3',
...                    username='username',
...                    password='password',
...                    project_name='project-name',
...                    user_domain_id='default',
...                    project_domain_id='default')
>>> sess = session.Session(auth=auth)
>>> nova = client.Client("2.1", session=sess)
>>> nova.flavors.list()
[...]
>>> nova.servers.list()
[...]
>>> nova.keypairs.list()
[...]

Testing

There are multiple test targets that can be run to validate the code.

  • tox -e pep8 - style guidelines enforcement
  • tox -e py27 - traditional unit testing
  • tox -e functional - live functional testing against an existing openstack

Functional testing assumes the existence of a clouds.yaml file as supported by os-client-config (http://docs.openstack.org/developer/os-client-config) It assumes the existence of a cloud named devstack that behaves like a normal devstack installation with a demo and an admin user/tenant - or clouds named functional_admin and functional_nonadmin.