Client library for OpenStack Cinder API.
Project description
This is a client for the OpenStack Volume API. There’s a Python API (the cinderclient module), and a command-line script (cinder). Each implements 100% of the OpenStack Volume API.
[PENDING] Full documentation is available.
You’ll also probably want to read OpenStack Compute Developer Guide API – the first bit, at least – to get an idea of the concepts. Rackspace is doing the cloud hosting thing a bit differently from Amazon, and if you get the concepts this library should make more sense.
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.
This code a fork of Jacobian’s python-cloudservers If you need API support for the Rackspace API solely or the BSD license, you should use that repository. python-client is licensed under the Apache License like the rest of OpenStack.
Command-line API
Installing this package gets you a shell command, cinder, that you can use to interact with any Rackspace compatible API (including OpenStack).
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 --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=1.1
If you are using Keystone, you need to set the CINDER_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 cinder help:
usage: cinder [--debug] [--os-username <auth-user-name>]
[--os-password <auth-password>]
[--os-tenant-name <auth-tenant-name>] [--os-auth-url <auth-url>]
[--os-region-name <region-name>] [--service-type <service-type>]
[--service-name <service-name>]
[--volume-service-name <volume-service-name>]
[--endpoint-type <endpoint-type>]
[--os-volume-api-version <compute-api-ver>]
<subcommand> ...
Command-line interface to the OpenStack Nova API.
Positional arguments:
<subcommand>
absolute-limits Print a list of absolute limits for a user
create Add a new volume.
credentials Show user credentials returned from auth
delete Remove a volume.
endpoints Discover endpoints that get returned from the
authenticate services
list List all the volumes.
rate-limits Print a list of rate limits for a user
show Show details about a volume.
snapshot-create Add a new snapshot.
snapshot-delete Remove a snapshot.
snapshot-list List all the snapshots.
snapshot-show Show details about a snapshot.
type-create Create a new volume type.
type-delete Delete a specific flavor
type-list Print a list of available 'volume types'.
bash-completion Prints all of the commands and options to stdout so
that the
help Display help about this program or one of its
subcommands.
Optional arguments:
--debug Print debugging output
--os-username <auth-user-name>
Defaults to env[OS_USERNAME].
--os-password <auth-password>
Defaults to env[OS_PASSWORD].
--os-tenant-name <auth-tenant-name>
Defaults to env[OS_TENANT_NAME].
--os-auth-url <auth-url>
Defaults to env[OS_AUTH_URL].
--os-region-name <region-name>
Defaults to env[OS_REGION_NAME].
--service-type <service-type>
Defaults to compute for most actions
--service-name <service-name>
Defaults to env[CINDER_SERVICE_NAME]
--volume-service-name <volume-service-name>
Defaults to env[CINDER_VOLUME_SERVICE_NAME]
--endpoint-type <endpoint-type>
Defaults to env[CINDER_ENDPOINT_TYPE] or publicURL.
--os-volume-api-version <compute-api-ver>
Accepts 1, defaults to env[OS_VOLUME_API_VERSION].
See "cinder help COMMAND" for help on a specific command.
Python API
[PENDING] There’s also a complete Python API.
Quick-start using keystone:
# use v2.0 auth with http://example.com:5000/v2.0/") >>> from cinderclient.v1 import client >>> nt = client.Client(USER, PASS, TENANT, AUTH_URL, service_type="compute") >>> nt.flavors.list() [...] >>> nt.servers.list() [...] >>> nt.keypairs.list() [...]
What’s new?
[PENDING] See the release notes.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for python-cinderclient-1.0.0.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ae0da692a6297b0bef7410599c124e4541c34f633c3d3a329adffcf881b3cffd |
|
| MD5 | c7d7014c6c293a2849ac0d5a0b51dc22 |
|
| BLAKE2b-256 | c767c6143a1f46678bc44dbaa7d5de872705789a351ceb1b16c33ddb50080d63 |
