Python bindings for Manila

Go to file

Sun Jun faaa07a722 Add hint for HDFS protocol while creating shares Add hint for creating shares with HDFS protocol, Since HDFS native protocol driver has been merged. Change-Id: Ic8724b585d1bf0ee1f2b7f8eaa0ed79927b1a292		2015-02-14 10:53:13 +08:00
contrib/ci	Make functional tests ci job save testr logs	2014-11-23 00:29:46 +02:00
doc	Add info about functional tests run to docs	2015-01-14 15:41:28 +00:00
etc	Implement functionality for functional tests using tempest-lib	2014-11-12 13:05:24 +02:00
manilaclient	Add hint for HDFS protocol while creating shares	2015-02-14 10:53:13 +08:00
tools	Fix run_tests.sh	2014-07-16 09:08:23 +03:00
.gitignore	Add manila cli help output to doc	2014-12-11 23:58:54 +01:00
.gitreview	Update .gitreview file for move to openstack	2014-09-19 21:10:25 +00:00
.testr.conf	Implement functionality for functional tests using tempest-lib	2014-11-12 13:05:24 +02:00
HACKING	mass replace cinder to manila	2013-09-05 13:32:38 +03:00
LICENSE	setup.py fixed	2013-09-03 14:37:34 +03:00
MANIFEST.in	Initial checkin	2013-09-02 23:42:41 -04:00
README.rst	Workflow documentation is now in infra-manual	2014-12-05 03:30:40 +00:00
openstack-common.conf	Sync with oslo-incubator	2014-10-23 08:13:25 +02:00
requirements.txt	Updated from global requirements	2015-01-23 04:38:14 +00:00
run_tests.sh	Remove nonexistent directory "tests" from pep8 scanning	2015-01-06 14:47:01 +02:00
setup.cfg	Remove explicit version definition	2014-11-24 19:34:26 +02:00
setup.py	Switch to using PBR	2014-05-27 23:00:55 +02:00
test-requirements.txt	Updated from global requirements	2015-01-24 20:24:05 +00:00
tox.ini	Add 'docs' tox job for generation of docs	2014-11-26 15:12:09 +02:00

README.rst

Python bindings to the OpenStack Manila API

This is a client for the OpenStack Manila API. There's a Python API (the manilaclient module), and a command-line script (manila). Each implements 100% of the OpenStack Manila API.

See the OpenStack CLI guide for information on how to use the manila 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.

This code is a fork of Cinderclient of Grizzly release and then it was developed separately. Cinderclient code is 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-manilaclient is licensed under the Apache License like the rest of OpenStack.

Contents:

Command-line API

Installing this package gets you a shell command, manila, 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=foouser
export OS_PASSWORD=barpass
export OS_TENANT_NAME=fooproject

You will also need to define the authentication url either with param --os-auth-url or as an environment variable:

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 manila help, see manila help COMMAND for help on a specific command.

Python API

There's also a complete Python API, but it has not yet been documented.

Quick-start using keystone:

# use v2.0 auth with http://example.com:5000/v2.0/")
>>> from manilaclient.v1 import client
>>> nt = client.Client(USER, PASS, TENANT, AUTH_URL, service_type="share")
>>> nt.shares.list()
[...]