e0f5072907
Currently, several of the volumes apis depend on callers to pass service_type='volume' as a parameter when creating a client object, to route correctly. The problem is, it makes it impossible for callers to work with both the compute and volume endpoints at the same time. They can either work with compute and have volumes.* calls return 404, or they can work with volume and have servers.* images.* flavors.* calls return 404. The CLI sets service_type='volume' for client objects for the following commands via a decorator: volume-list volume-show volume-create volume-delete volume-snapshot-list volume-snapshot-show volume-snapshot-create volume-snapshot-delete volume-type-list volume-type-create volume-type-delete With this change, the service_type 'volume' is set in the api, so the decorators on the shell commands are no longer needed. Closes-Bug: #1431154 Change-Id: I11b48ac14fa4c64d8aae528552ec5b363be384c5 |
||
---|---|---|
doc | ||
novaclient | ||
tools | ||
.coveragerc | ||
.gitignore | ||
.gitreview | ||
.mailmap | ||
.testr.conf | ||
CONTRIBUTING.rst | ||
HACKING.rst | ||
LICENSE | ||
MANIFEST.in | ||
README.rst | ||
openstack-common.conf | ||
requirements.txt | ||
run_tests.sh | ||
setup.cfg | ||
setup.py | ||
test-requirements.txt | ||
tox.ini |
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()
[...]