openstack
/
python-manilaclient
Code Issues Proposed changes
Python bindings for Manila
524 Commits 9 Branches 50 Tags 25 MiB
Python 99.8%
Shell 0.2%
Go to file
Jenkins 58933a6848 Merge "Update help message for share-instance-reset-state command" 2017-01-26 03:29:02 +00:00
contrib/ci Add mountable snapshots support to manila client 2017-01-24 20:30:57 -02:00
doc Removes unnecessary utf-8 encoding 2017-01-05 15:07:57 +08:00
etc Implement functionality for functional tests using tempest-lib 2014-11-12 13:05:24 +02:00
manilaclient Merge "Update help message for share-instance-reset-state command" 2017-01-26 03:29:02 +00:00
releasenotes Merge "Update help message for share-instance-reset-state command" 2017-01-26 03:29:02 +00:00
tools Add Constraints support 2016-12-21 22:51:37 +01:00
.gitignore Add support for releasenotes 2016-05-25 17:45:16 +00:00
.gitreview Update .gitreview file for move to openstack 2014-09-19 21:10:25 +00:00
.testr.conf Fix usage of setUpClass method in functional tests 2015-10-26 15:02:07 +02:00
CONTRIBUTING.rst Added CONTRIBUTING.rst file to the project 2016-05-17 00:06:50 +00: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
README.rst Show team and repo badges on README 2016-11-25 12:38:31 +01:00
requirements.txt Updated from global requirements 2016-12-05 18:48:15 +00:00
run_tests.sh Remove nonexistent directory "tests" from pep8 scanning 2015-01-06 14:47:01 +02:00
setup.cfg Merge "Add Python 3.5 classifier and venv" 2016-12-21 11:29:57 +00:00
setup.py Updated from global requirements 2015-09-18 16:42:20 +00:00
test-requirements.txt Updated from global requirements 2016-11-06 02:06:56 +00:00
tox.ini Enable coverage report in console output 2017-01-13 10:56:52 +08:00

README.rst

Team and repository tags

image

Python bindings to the OpenStack Manila API

Latest Version

Downloads

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()
[...]