OpenStack Compute (Nova) Client
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Go to file
Monty Taylor c3a1cbdcd2
Change ignore-errors to ignore_errors
7 years ago
doc [docs] Fix length of underline 8 years ago
novaclient Merge "Encode unicode filter arguments for server list" 7 years ago
python-novaclient/locale Enable i18n with Babel. 8 years ago
tools add pretty_tox to nova functional tests 8 years ago
.coveragerc Change ignore-errors to ignore_errors 7 years ago
.gitignore Updates .gitignore 9 years ago
.gitreview Add .gitreview config file for gerrit. 11 years ago
.mailmap Add mailmap entry 9 years ago
.testr.conf Add OS_TEST_PATH to testr 8 years ago
CONTRIBUTING.rst Workflow documentation is now in infra-manual 8 years ago
HACKING.rst Clean up a little cruft 10 years ago
LICENSE whitespace cleanups 12 years ago
MANIFEST.in Update to latest openstack.common.setup. 10 years ago
README.rst Restrict direct usage of novaclient.v2.client 8 years ago
babel.cfg Enable i18n with Babel. 8 years ago
openstack-common.conf cleanup openstack-common.conf and sync updated files 8 years ago
requirements.txt Updated from global requirements 8 years ago
run_tests.sh Migrate to flake8. 10 years ago
setup.cfg Fix the homepage url in setup.cfg 8 years ago
setup.py Updated from global requirements 8 years ago
test-requirements.txt Updated from global requirements 7 years ago
tox.ini Launch functional tests serially 8 years ago

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

To use with keystone as the authentication system:

>>> from novaclient import client
>>> nt = client.Client(VERSION, USER, PASSWORD, TENANT, AUTH_URL)
>>> 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 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.