openstack
/
python-novaclient
Code Issues Proposed changes
OpenStack Compute (Nova) Client
1,988 Commits 9 Branches 35 Tags 35 MiB
Python 100%
Go to file
Andrey Kurilin 13463268db Fix unit and functional tests 
stable/kilo branch is broken due to next reasons:
1) unittests requires capped oslo libraries and mock
2) functional tests cannot access to credentials via environment variables

Both issues block each other, so we need to squach several commits.

Fix for functional tests is done via backporting patches:
* refactor functional test base class to no inherit from tempest_lib
  Conflicts: None
  Change-Id: I716be51d7d1825a757934298f06b2f04d64cf0dd
  (cherry picked from commit 420dc2884a)

* pass credentials via config file instead of magic
  Conflicts: README.rst
  Change-Id: Ifdab38a03c94f51d30449149c0dbd9c6265460a5
  (cherry picked from commit 6379287480)

Unittest doesn't require full sync with global-requrements, so only
oslo.i18n, oslo.serialization and mock are updated.

Change-Id: I5ecd52abcaf0da1b067e70d7b19297305af19174
 		2015-07-16 15:37:51 +00:00
doc Merge "Add Client object to documentation" 2015-03-12 18:32:48 +00:00
novaclient Fix unit and functional tests 2015-07-16 15:37:51 +00: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 update defaultbranch 2015-04-15 13:29:16 +00: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 Fix unit and functional tests 2015-07-16 15:37:51 +00:00
functional_creds.conf.sample Fix unit and functional tests 2015-07-16 15:37:51 +00:00
openstack-common.conf Port to use oslo.i18n 2014-10-16 01:19:48 +03:00
requirements.txt Fix unit and functional tests 2015-07-16 15:37:51 +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 Fix unit and functional tests 2015-07-16 15:37:51 +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()
[...]

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 existance of a functional_creds.conf in the root directory. See the .sample for example format.